commit 704420a8c422bcd671ab5d1c6705eb4bd8c824ce Author: iorebuild Date: Mon Dec 15 21:21:12 2025 +0800 first commit diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json new file mode 100644 index 0000000..8909706 --- /dev/null +++ b/.vscode/c_cpp_properties.json @@ -0,0 +1,18 @@ +{ + "configurations": [ + { + "name": "windows-gcc-x64", + "includePath": [ + "${workspaceFolder}/**" + ], + "compilerPath": "C:/Applications/Program Custom/msys2/mingw64/bin/gcc.exe", + "cStandard": "${default}", + "cppStandard": "${default}", + "intelliSenseMode": "windows-gcc-x64", + "compilerArgs": [ + "" + ] + } + ], + "version": 4 +} \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..cd09898 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,24 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "name": "C/C++ Runner: Debug Session", + "type": "cppdbg", + "request": "launch", + "args": [], + "stopAtEntry": false, + "externalConsole": true, + "cwd": "c:/Users/anonymous/Desktop/NewProject/Other/UniversalCanCore/Src", + "program": "c:/Users/anonymous/Desktop/NewProject/Other/UniversalCanCore/Src/build/Debug/outDebug", + "MIMode": "gdb", + "miDebuggerPath": "gdb", + "setupCommands": [ + { + "description": "Enable pretty-printing for gdb", + "text": "-enable-pretty-printing", + "ignoreFailures": true + } + ] + } + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..3e5eb95 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,59 @@ +{ + "C_Cpp_Runner.cCompilerPath": "gcc", + "C_Cpp_Runner.cppCompilerPath": "g++", + "C_Cpp_Runner.debuggerPath": "gdb", + "C_Cpp_Runner.cStandard": "", + "C_Cpp_Runner.cppStandard": "", + "C_Cpp_Runner.msvcBatchPath": "", + "C_Cpp_Runner.useMsvc": false, + "C_Cpp_Runner.warnings": [ + "-Wall", + "-Wextra", + "-Wpedantic", + "-Wshadow", + "-Wformat=2", + "-Wcast-align", + "-Wconversion", + "-Wsign-conversion", + "-Wnull-dereference" + ], + "C_Cpp_Runner.msvcWarnings": [ + "/W4", + "/permissive-", + "/w14242", + "/w14287", + "/w14296", + "/w14311", + "/w14826", + "/w44062", + "/w44242", + "/w14905", + "/w14906", + "/w14263", + "/w44265", + "/w14928" + ], + "C_Cpp_Runner.enableWarnings": true, + "C_Cpp_Runner.warningsAsError": false, + "C_Cpp_Runner.compilerArgs": [], + "C_Cpp_Runner.linkerArgs": [], + "C_Cpp_Runner.includePaths": [], + "C_Cpp_Runner.includeSearch": [ + "*", + "**/*" + ], + "C_Cpp_Runner.excludeSearch": [ + "**/build", + "**/build/**", + "**/.*", + "**/.*/**", + "**/.vscode", + "**/.vscode/**" + ], + "C_Cpp_Runner.useAddressSanitizer": false, + "C_Cpp_Runner.useUndefinedSanitizer": false, + "C_Cpp_Runner.useLeakSanitizer": false, + "C_Cpp_Runner.showCompilationTime": false, + "C_Cpp_Runner.useLinkTimeOptimization": false, + "C_Cpp_Runner.msvcSecureNoWarnings": false +} \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..bfbc826 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,29 @@ +{ + "tasks": [ + { + "type": "cppbuild", + "label": "C/C++: gcc.exe 生成活动文件", + "command": "C:/Applications/Program Custom/msys2/mingw64/bin/gcc.exe", + "args": [ + "-fdiagnostics-color=always", + "-g", + "${file}", + "-o", + "${fileDirname}\\${fileBasenameNoExtension}.exe", + "" + ], + "options": { + "cwd": "C:/Applications/Program Custom/msys2/mingw64/bin" + }, + "problemMatcher": [ + "$gcc" + ], + "group": { + "kind": "build", + "isDefault": true + }, + "detail": "调试器生成的任务。" + } + ], + "version": "2.0.0" +} \ No newline at end of file diff --git a/.xmake/windows/x64/cache/config b/.xmake/windows/x64/cache/config new file mode 100644 index 0000000..c47eda4 --- /dev/null +++ b/.xmake/windows/x64/cache/config @@ -0,0 +1,9 @@ +{ + mtimes = { + ["xmake.lua"] = 1765270728 + }, + options = { + toolchain = "mingw64" + }, + recheck = false +} \ No newline at end of file diff --git a/.xmake/windows/x64/cache/detect b/.xmake/windows/x64/cache/detect new file mode 100644 index 0000000..3d541db --- /dev/null +++ b/.xmake/windows/x64/cache/detect @@ -0,0 +1,55 @@ +{ + find_program = { + ["c:/applications/program custom/msys2/mingw64/bin/g++.exe"] = "c:/applications/program custom/msys2/mingw64/bin/g++.exe" + }, + find_program_mingw64_arch_x64_plat_windows_checktoolcxx = { + ["C:/Applications/Program Custom/msys2/mingw64/bin/g++.exe"] = "c:/applications/program custom/msys2/mingw64/bin/g++.exe" + }, + find_program_mingw64_arch_x64_plat_windows_checktoolcc = { + ["C:/Applications/Program Custom/msys2/mingw64/bin/gcc.exe"] = "c:/applications/program custom/msys2/mingw64/bin/gcc.exe" + }, + ["core.tools.gcc.has_cflags"] = { + ["c:/applications/program custom/msys2/mingw64/bin/g++.exe_"] = { + ["-save-temps"] = true, + ["-print-multiarch"] = true, + ["--param"] = true, + ["--target-help"] = true, + ["-print-sysroot"] = true, + ["-Xassembler"] = true, + ["-dumpspecs"] = true, + ["-print-libgcc-file-name"] = true, + ["-print-multi-directory"] = true, + ["--version"] = true, + ["-Xpreprocessor"] = true, + ["-Xlinker"] = true, + ["--help"] = true, + ["-pipe"] = true, + ["-pass-exit-codes"] = true, + ["-print-search-dirs"] = true, + ["-time"] = true, + ["-B"] = true, + ["-dumpversion"] = true, + ["-o"] = true, + ["-E"] = true, + ["-print-multi-os-directory"] = true, + ["-S"] = true, + ["-no-canonical-prefixes"] = true, + ["-x"] = true, + ["-v"] = true, + ["-c"] = true, + ["-dumpmachine"] = true, + ["-shared"] = true, + ["-pie"] = true, + ["-print-sysroot-headers-suffix"] = true, + ["-print-multi-lib"] = true + } + }, + find_program_mingw64_arch_x64_plat_windows_checktoolld = { + ["C:/Applications/Program Custom/msys2/mingw64/bin/g++.exe"] = "c:/applications/program custom/msys2/mingw64/bin/g++.exe" + }, + ["lib.detect.has_flags"] = { + ["windows_x64_c:/applications/program custom/msys2/mingw64/bin/g++.exe__cxx_cxflags__-fdiagnostics-color=always"] = true, + ["windows_x64_c:/applications/program custom/msys2/mingw64/bin/g++.exe__cxx_cxflags__-Wno-gnu-line-marker -Werror"] = true, + ["windows_x64_c:/applications/program custom/msys2/mingw64/bin/g++.exe__cxx_cxflags__-MMD -MF"] = true + } +} \ No newline at end of file diff --git a/.xmake/windows/x64/cache/history b/.xmake/windows/x64/cache/history new file mode 100644 index 0000000..5894625 --- /dev/null +++ b/.xmake/windows/x64/cache/history @@ -0,0 +1,69 @@ +{ + cmdlines = { + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + [[xmake lua "C:\\Program Files\\xmake\\modules\\private\\utils\\statistics.lua"]], + [[xmake lua "C:\\Program Files\\xmake\\actions\\build\\cleaner.lua"]], + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + [[xmake l c:\Users\anonymous\.vscode\extensions\tboox.xmake-vscode-2.4.1\assets\explorer.lua]], + [[xmake l c:\Users\anonymous\.vscode\extensions\tboox.xmake-vscode-2.4.1\assets\config.lua]], + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake ", + "xmake " + } +} \ No newline at end of file diff --git a/.xmake/windows/x64/cache/option b/.xmake/windows/x64/cache/option new file mode 100644 index 0000000..6f31cf5 --- /dev/null +++ b/.xmake/windows/x64/cache/option @@ -0,0 +1 @@ +{ } \ No newline at end of file diff --git a/.xmake/windows/x64/cache/package b/.xmake/windows/x64/cache/package new file mode 100644 index 0000000..6f31cf5 --- /dev/null +++ b/.xmake/windows/x64/cache/package @@ -0,0 +1 @@ +{ } \ No newline at end of file diff --git a/.xmake/windows/x64/cache/project b/.xmake/windows/x64/cache/project new file mode 100644 index 0000000..6f31cf5 --- /dev/null +++ b/.xmake/windows/x64/cache/project @@ -0,0 +1 @@ +{ } \ No newline at end of file diff --git a/.xmake/windows/x64/cache/toolchain b/.xmake/windows/x64/cache/toolchain new file mode 100644 index 0000000..1721f1e --- /dev/null +++ b/.xmake/windows/x64/cache/toolchain @@ -0,0 +1,38 @@ +{ + tool_target_UniversalCanCore_windows_x64_cc = { + program = "c:/applications/program custom/msys2/mingw64/bin/gcc.exe", + toolname = "gcc", + toolchain_info = { + name = "mingw64", + arch = "x64", + cachekey = "mingw64_arch_x64_plat_windows", + plat = "windows" + } + }, + mingw64_arch_x64_plat_windows = { + plat = "windows", + __checked = true, + arch = "x64", + __global = true + }, + tool_target_UniversalCanCore_windows_x64_ld = { + program = "c:/applications/program custom/msys2/mingw64/bin/g++.exe", + toolname = "gxx", + toolchain_info = { + name = "mingw64", + arch = "x64", + cachekey = "mingw64_arch_x64_plat_windows", + plat = "windows" + } + }, + tool_target_UniversalCanCore_windows_x64_cxx = { + program = "c:/applications/program custom/msys2/mingw64/bin/g++.exe", + toolname = "gxx", + toolchain_info = { + name = "mingw64", + arch = "x64", + cachekey = "mingw64_arch_x64_plat_windows", + plat = "windows" + } + } +} \ No newline at end of file diff --git a/.xmake/windows/x64/project.lock b/.xmake/windows/x64/project.lock new file mode 100644 index 0000000..e69de29 diff --git a/.xmake/windows/x64/xmake.conf b/.xmake/windows/x64/xmake.conf new file mode 100644 index 0000000..8beef03 --- /dev/null +++ b/.xmake/windows/x64/xmake.conf @@ -0,0 +1,14 @@ +{ + __toolchains_windows_x64 = { + "mingw64" + }, + arch = "x64", + builddir = "build", + ccache = true, + host = "windows", + kind = "static", + mode = "release", + ndk_stdcxx = true, + plat = "windows", + toolchain = "mingw64" +} \ No newline at end of file diff --git a/Inc/CanReceiveTask.h b/Inc/CanReceiveTask.h new file mode 100644 index 0000000..41e689d --- /dev/null +++ b/Inc/CanReceiveTask.h @@ -0,0 +1,6 @@ +#ifndef __CAN_RECEIVE_TASK_H__ +#define __CAN_RECEIVE_TASK_H__ + +#include "System.h" + +#endif diff --git a/Inc/SocketApiProtocol.h b/Inc/SocketApiProtocol.h new file mode 100644 index 0000000..cc2ae0c --- /dev/null +++ b/Inc/SocketApiProtocol.h @@ -0,0 +1,8 @@ +#ifndef __SOCKET_API_PROTOCOL_H__ +#define __SOCKET_API_PROTOCOL_H__ + +#include "System.h" + +void SocketApiProtocolInit(uint32_t SocketPort); + +#endif diff --git a/Inc/System.h b/Inc/System.h new file mode 100644 index 0000000..bc2ba7a --- /dev/null +++ b/Inc/System.h @@ -0,0 +1,36 @@ +#ifndef __SYSTEM_H__ +#define __SYSTEM_H__ + +#include "asio.hpp" +#include +#include +#include +#include +#include +#include + +using TickType_t = uint32_t; //类似FreeRTOS的ms时间数 + +#define DISABLE 0x00 +#define ENABLE 0x01 + +#define PRODUCT_SC_HHS_USB_CAN_II 0 //四川和华盛USB-CAN-II +#define PRODUCT_ZLG_USB_CAN_II 1 //zlg的USB-CAN-II +#define PRODUCT_GC_USB_CAN_II 2 //GC的USB-CAN-II + +typedef struct +{ + int ProductInfo; //产品信息 + int logEn; //日志记录开关 + int CanOpenStatus[2]; //CAN通道状态 +}SystemConfig; + +extern SystemConfig SystemCall; + +void logAdd(const std::string& filename, const std::string& content); +void SystemCallInit(void); +void vTaskDelay(TickType_t ms); + + + +#endif \ No newline at end of file diff --git a/Packages/asio-1.36.0/COPYING b/Packages/asio-1.36.0/COPYING new file mode 100644 index 0000000..47a3e6b --- /dev/null +++ b/Packages/asio-1.36.0/COPYING @@ -0,0 +1,4 @@ +Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) + +Distributed under the Boost Software License, Version 1.0. (See accompanying +file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) diff --git a/Packages/asio-1.36.0/INSTALL b/Packages/asio-1.36.0/INSTALL new file mode 100644 index 0000000..1dd78db --- /dev/null +++ b/Packages/asio-1.36.0/INSTALL @@ -0,0 +1,5 @@ +See doc/index.html for information on: + - External dependencies + - Using, building, and configuring Asio + - Supported platforms + - How to build the tests and examples diff --git a/Packages/asio-1.36.0/LICENSE_1_0.txt b/Packages/asio-1.36.0/LICENSE_1_0.txt new file mode 100644 index 0000000..36b7cd9 --- /dev/null +++ b/Packages/asio-1.36.0/LICENSE_1_0.txt @@ -0,0 +1,23 @@ +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/Packages/asio-1.36.0/Makefile.am b/Packages/asio-1.36.0/Makefile.am new file mode 100644 index 0000000..8093c8c --- /dev/null +++ b/Packages/asio-1.36.0/Makefile.am @@ -0,0 +1,22 @@ +AUTOMAKE_OPTIONS = foreign dist-bzip2 dist-zip parallel-tests + +noarch_pkgconfigdir = $(datadir)/pkgconfig +noarch_pkgconfig_DATA = asio.pc + +SUBDIRS = include src + +MAINTAINERCLEANFILES = \ + $(srcdir)/aclocal.m4 \ + $(srcdir)/configure \ + $(srcdir)/config.guess \ + $(srcdir)/config.sub \ + $(srcdir)/depcomp \ + $(srcdir)/install-sh \ + $(srcdir)/missing \ + $(srcdir)/mkinstalldirs \ + $(srcdir)/Makefile.in \ + asio-*.tar.gz + +EXTRA_DIST = \ + LICENSE_1_0.txt \ + doc diff --git a/Packages/asio-1.36.0/Makefile.in b/Packages/asio-1.36.0/Makefile.in new file mode 100644 index 0000000..cf49a4e --- /dev/null +++ b/Packages/asio-1.36.0/Makefile.in @@ -0,0 +1,857 @@ +# Makefile.in generated by automake 1.17 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2024 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +am__is_gnu_make = { \ + if test -z '$(MAKELEVEL)'; then \ + false; \ + elif test -n '$(MAKE_HOST)'; then \ + true; \ + elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \ + true; \ + else \ + false; \ + fi; \ +} +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) +am__rm_f = rm -f $(am__rm_f_notfound) +am__rm_rf = rm -rf $(am__rm_f_notfound) +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = . +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +DIST_COMMON = $(srcdir)/Makefile.am $(top_srcdir)/configure \ + $(am__configure_deps) $(am__DIST_COMMON) +am__CONFIG_DISTCLEAN_FILES = config.status config.cache config.log \ + configure.lineno config.status.lineno +mkinstalldirs = $(install_sh) -d +CONFIG_CLEAN_FILES = asio.pc +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +RECURSIVE_TARGETS = all-recursive check-recursive cscopelist-recursive \ + ctags-recursive dvi-recursive html-recursive info-recursive \ + install-data-recursive install-dvi-recursive \ + install-exec-recursive install-html-recursive \ + install-info-recursive install-pdf-recursive \ + install-ps-recursive install-recursive installcheck-recursive \ + installdirs-recursive pdf-recursive ps-recursive \ + tags-recursive uninstall-recursive +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && echo $$files | $(am__xargs_n) 40 $(am__rm_f); }; \ + } +am__installdirs = "$(DESTDIR)$(noarch_pkgconfigdir)" +DATA = $(noarch_pkgconfig_DATA) +RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ + distclean-recursive maintainer-clean-recursive +am__recursive_targets = \ + $(RECURSIVE_TARGETS) \ + $(RECURSIVE_CLEAN_TARGETS) \ + $(am__extra_recursive_targets) +AM_RECURSIVE_TARGETS = $(am__recursive_targets:-recursive=) TAGS CTAGS \ + cscope distdir distdir-am dist dist-all distcheck +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +# Read a list of newline-separated strings from the standard input, +# and print each of them once, without duplicates. Input order is +# *not* preserved. +am__uniquify_input = $(AWK) '\ + BEGIN { nonempty = 0; } \ + { items[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in items) print i; }; } \ +' +# Make sure the list of sources is unique. This is necessary because, +# e.g., the same source file might be shared among _SOURCES variables +# for different programs/libraries. +am__define_uniq_tagged_files = \ + list='$(am__tagged_files)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | $(am__uniquify_input)` +DIST_SUBDIRS = $(SUBDIRS) +am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/asio.pc.in COPYING \ + INSTALL README compile config.guess config.sub depcomp \ + install-sh missing +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +distdir = $(PACKAGE)-$(VERSION) +top_distdir = $(distdir) +am__remove_distdir = \ + if test -d "$(distdir)"; then \ + find "$(distdir)" -type d ! -perm -700 -exec chmod u+rwx {} ';' \ + ; rm -rf "$(distdir)" \ + || { sleep 5 && rm -rf "$(distdir)"; }; \ + else :; fi +am__post_remove_distdir = $(am__remove_distdir) +am__relativize = \ + dir0=`pwd`; \ + sed_first='s,^\([^/]*\)/.*$$,\1,'; \ + sed_rest='s,^[^/]*/*,,'; \ + sed_last='s,^.*/\([^/]*\)$$,\1,'; \ + sed_butlast='s,/*[^/]*$$,,'; \ + while test -n "$$dir1"; do \ + first=`echo "$$dir1" | sed -e "$$sed_first"`; \ + if test "$$first" != "."; then \ + if test "$$first" = ".."; then \ + dir2=`echo "$$dir0" | sed -e "$$sed_last"`/"$$dir2"; \ + dir0=`echo "$$dir0" | sed -e "$$sed_butlast"`; \ + else \ + first2=`echo "$$dir2" | sed -e "$$sed_first"`; \ + if test "$$first2" = "$$first"; then \ + dir2=`echo "$$dir2" | sed -e "$$sed_rest"`; \ + else \ + dir2="../$$dir2"; \ + fi; \ + dir0="$$dir0"/"$$first"; \ + fi; \ + fi; \ + dir1=`echo "$$dir1" | sed -e "$$sed_rest"`; \ + done; \ + reldir="$$dir2" +DIST_ARCHIVES = $(distdir).tar.gz $(distdir).tar.bz2 $(distdir).zip +GZIP_ENV = -9 +DIST_TARGETS = dist-bzip2 dist-gzip dist-zip +# Exists only to be overridden by the user if desired. +AM_DISTCHECK_DVI_TARGET = dvi +distuninstallcheck_listfiles = find . -type f -print +am__distuninstallcheck_listfiles = $(distuninstallcheck_listfiles) \ + | sed 's|^\./|$(prefix)/|' | grep -v '$(infodir)/dir$$' +distcleancheck_listfiles = \ + find . \( -type f -a \! \ + \( -name .nfs* -o -name .smb* -o -name .__afs* \) \) -print +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPPFLAGS = @CPPFLAGS@ +CSCOPE = @CSCOPE@ +CTAGS = @CTAGS@ +CXX = @CXX@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +ETAGS = @ETAGS@ +EXEEXT = @EXEEXT@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +RANLIB = @RANLIB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__rm_f_notfound = @am__rm_f_notfound@ +am__tar = @am__tar@ +am__untar = @am__untar@ +am__xargs_n = @am__xargs_n@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +runstatedir = @runstatedir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +AUTOMAKE_OPTIONS = foreign dist-bzip2 dist-zip parallel-tests +noarch_pkgconfigdir = $(datadir)/pkgconfig +noarch_pkgconfig_DATA = asio.pc +SUBDIRS = include src +MAINTAINERCLEANFILES = \ + $(srcdir)/aclocal.m4 \ + $(srcdir)/configure \ + $(srcdir)/config.guess \ + $(srcdir)/config.sub \ + $(srcdir)/depcomp \ + $(srcdir)/install-sh \ + $(srcdir)/missing \ + $(srcdir)/mkinstalldirs \ + $(srcdir)/Makefile.in \ + asio-*.tar.gz + +EXTRA_DIST = \ + LICENSE_1_0.txt \ + doc + +all: all-recursive + +.SUFFIXES: +am--refresh: Makefile + @: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + echo ' cd $(srcdir) && $(AUTOMAKE) --foreign'; \ + $(am__cd) $(srcdir) && $(AUTOMAKE) --foreign \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + echo ' $(SHELL) ./config.status'; \ + $(SHELL) ./config.status;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__maybe_remake_depfiles)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__maybe_remake_depfiles);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + $(SHELL) ./config.status --recheck + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + $(am__cd) $(srcdir) && $(AUTOCONF) +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + $(am__cd) $(srcdir) && $(ACLOCAL) $(ACLOCAL_AMFLAGS) +$(am__aclocal_m4_deps): +asio.pc: $(top_builddir)/config.status $(srcdir)/asio.pc.in + cd $(top_builddir) && $(SHELL) ./config.status $@ +install-noarch_pkgconfigDATA: $(noarch_pkgconfig_DATA) + @$(NORMAL_INSTALL) + @list='$(noarch_pkgconfig_DATA)'; test -n "$(noarch_pkgconfigdir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(noarch_pkgconfigdir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(noarch_pkgconfigdir)" || exit 1; \ + fi; \ + for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; \ + done | $(am__base_list) | \ + while read files; do \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(noarch_pkgconfigdir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(noarch_pkgconfigdir)" || exit $$?; \ + done + +uninstall-noarch_pkgconfigDATA: + @$(NORMAL_UNINSTALL) + @list='$(noarch_pkgconfig_DATA)'; test -n "$(noarch_pkgconfigdir)" || list=; \ + files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ + dir='$(DESTDIR)$(noarch_pkgconfigdir)'; $(am__uninstall_files_from_dir) + +# This directory's subdirectories are mostly independent; you can cd +# into them and run 'make' without going through this Makefile. +# To change the values of 'make' variables: instead of editing Makefiles, +# (1) if the variable is set in 'config.status', edit 'config.status' +# (which will cause the Makefiles to be regenerated when you run 'make'); +# (2) otherwise, pass the desired values on the 'make' command line. +$(am__recursive_targets): + @fail=; \ + if $(am__make_keepgoing); then \ + failcom='fail=yes'; \ + else \ + failcom='exit 1'; \ + fi; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ + fi; test -z "$$fail" + +ID: $(am__tagged_files) + $(am__define_uniq_tagged_files); mkid -fID $$unique +tags: tags-recursive +TAGS: tags + +tags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + set x; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + set "$$@" "$$include_option=$$here/$$subdir/TAGS"; \ + fi; \ + done; \ + $(am__define_uniq_tagged_files); \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$unique; \ + fi; \ + fi +ctags: ctags-recursive + +CTAGS: ctags +ctags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + $(am__define_uniq_tagged_files); \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" +cscope: cscope.files + test ! -s cscope.files \ + || $(CSCOPE) -b -q $(AM_CSCOPEFLAGS) $(CSCOPEFLAGS) -i cscope.files $(CSCOPE_ARGS) +clean-cscope: + -rm -f cscope.files +cscope.files: clean-cscope cscopelist +cscopelist: cscopelist-recursive + +cscopelist-am: $(am__tagged_files) + list='$(am__tagged_files)'; \ + case "$(srcdir)" in \ + [\\/]* | ?:[\\/]*) sdir="$(srcdir)" ;; \ + *) sdir=$(subdir)/$(srcdir) ;; \ + esac; \ + for i in $$list; do \ + if test -f "$$i"; then \ + echo "$(subdir)/$$i"; \ + else \ + echo "$$sdir/$$i"; \ + fi; \ + done >> $(top_builddir)/cscope.files + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags + -rm -f cscope.out cscope.in.out cscope.po.out cscope.files +distdir: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) distdir-am + +distdir-am: $(DISTFILES) + $(am__remove_distdir) + $(AM_V_at)$(MKDIR_P) "$(distdir)" + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + $(am__make_dryrun) \ + || test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ + dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ + $(am__relativize); \ + new_distdir=$$reldir; \ + dir1=$$subdir; dir2="$(top_distdir)"; \ + $(am__relativize); \ + new_top_distdir=$$reldir; \ + echo " (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) top_distdir="$$new_top_distdir" distdir="$$new_distdir" \\"; \ + echo " am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)"; \ + ($(am__cd) $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$new_top_distdir" \ + distdir="$$new_distdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + am__skip_mode_fix=: \ + distdir) \ + || exit 1; \ + fi; \ + done + -test -n "$(am__skip_mode_fix)" \ + || find "$(distdir)" -type d ! -perm -755 \ + -exec chmod u+rwx,go+rx {} \; -o \ + ! -type d ! -perm -444 -links 1 -exec chmod a+r {} \; -o \ + ! -type d ! -perm -400 -exec chmod a+r {} \; -o \ + ! -type d ! -perm -444 -exec $(install_sh) -c -m a+r {} {} \; \ + || chmod -R a+r "$(distdir)" +dist-gzip: distdir + tardir=$(distdir) && $(am__tar) | eval GZIP= gzip $(GZIP_ENV) -c >$(distdir).tar.gz + $(am__post_remove_distdir) +dist-bzip2: distdir + tardir=$(distdir) && $(am__tar) | BZIP2=$${BZIP2--9} bzip2 -c >$(distdir).tar.bz2 + $(am__post_remove_distdir) + +dist-lzip: distdir + tardir=$(distdir) && $(am__tar) | lzip -c $${LZIP_OPT--9} >$(distdir).tar.lz + $(am__post_remove_distdir) + +dist-xz: distdir + tardir=$(distdir) && $(am__tar) | XZ_OPT=$${XZ_OPT--e} xz -c >$(distdir).tar.xz + $(am__post_remove_distdir) + +dist-zstd: distdir + tardir=$(distdir) && $(am__tar) | zstd -c $${ZSTD_CLEVEL-$${ZSTD_OPT--19}} >$(distdir).tar.zst + $(am__post_remove_distdir) + +dist-tarZ: distdir + @echo WARNING: "Support for distribution archives compressed with" \ + "legacy program 'compress' is deprecated." >&2 + @echo WARNING: "It will be removed altogether in Automake 2.0" >&2 + tardir=$(distdir) && $(am__tar) | compress -c >$(distdir).tar.Z + $(am__post_remove_distdir) + +dist-shar: distdir + @echo WARNING: "Support for shar distribution archives is" \ + "deprecated." >&2 + @echo WARNING: "It will be removed altogether in Automake 2.0" >&2 + shar $(distdir) | eval GZIP= gzip $(GZIP_ENV) -c >$(distdir).shar.gz + $(am__post_remove_distdir) +dist-zip: distdir + -rm -f $(distdir).zip + zip -rq $(distdir).zip $(distdir) + $(am__post_remove_distdir) + +dist dist-all: + $(MAKE) $(AM_MAKEFLAGS) $(DIST_TARGETS) am__post_remove_distdir='@:' + $(am__post_remove_distdir) + +# This target untars the dist file and tries a VPATH configuration. Then +# it guarantees that the distribution is self-contained by making another +# tarfile. +distcheck: dist + case '$(DIST_ARCHIVES)' in \ + *.tar.gz*) \ + eval GZIP= gzip -dc $(distdir).tar.gz | $(am__untar) ;;\ + *.tar.bz2*) \ + bzip2 -dc $(distdir).tar.bz2 | $(am__untar) ;;\ + *.tar.lz*) \ + lzip -dc $(distdir).tar.lz | $(am__untar) ;;\ + *.tar.xz*) \ + xz -dc $(distdir).tar.xz | $(am__untar) ;;\ + *.tar.Z*) \ + uncompress -c $(distdir).tar.Z | $(am__untar) ;;\ + *.shar.gz*) \ + eval GZIP= gzip -dc $(distdir).shar.gz | unshar ;;\ + *.zip*) \ + unzip $(distdir).zip ;;\ + *.tar.zst*) \ + zstd -dc $(distdir).tar.zst | $(am__untar) ;;\ + esac + chmod -R a-w $(distdir) + chmod u+w $(distdir) + mkdir $(distdir)/_build $(distdir)/_build/sub $(distdir)/_inst + chmod a-w $(distdir) + test -d $(distdir)/_build || exit 0; \ + dc_install_base=`$(am__cd) $(distdir)/_inst && pwd | sed -e 's,^[^:\\/]:[\\/],/,'` \ + && dc_destdir="$${TMPDIR-/tmp}/am-dc-$$$$/" \ + && am__cwd=`pwd` \ + && $(am__cd) $(distdir)/_build/sub \ + && ../../configure \ + $(AM_DISTCHECK_CONFIGURE_FLAGS) \ + $(DISTCHECK_CONFIGURE_FLAGS) \ + --srcdir=../.. --prefix="$$dc_install_base" \ + && $(MAKE) $(AM_MAKEFLAGS) \ + && $(MAKE) $(AM_MAKEFLAGS) $(AM_DISTCHECK_DVI_TARGET) \ + && $(MAKE) $(AM_MAKEFLAGS) check \ + && $(MAKE) $(AM_MAKEFLAGS) install \ + && $(MAKE) $(AM_MAKEFLAGS) installcheck \ + && $(MAKE) $(AM_MAKEFLAGS) uninstall \ + && $(MAKE) $(AM_MAKEFLAGS) distuninstallcheck_dir="$$dc_install_base" \ + distuninstallcheck \ + && chmod -R a-w "$$dc_install_base" \ + && ({ \ + (cd ../.. && umask 077 && mkdir "$$dc_destdir") \ + && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" install \ + && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" uninstall \ + && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" \ + distuninstallcheck_dir="$$dc_destdir" distuninstallcheck; \ + } || { rm -rf "$$dc_destdir"; exit 1; }) \ + && rm -rf "$$dc_destdir" \ + && $(MAKE) $(AM_MAKEFLAGS) dist \ + && rm -rf $(DIST_ARCHIVES) \ + && $(MAKE) $(AM_MAKEFLAGS) distcleancheck \ + && cd "$$am__cwd" \ + || exit 1 + $(am__post_remove_distdir) + @(echo "$(distdir) archives ready for distribution: "; \ + list='$(DIST_ARCHIVES)'; for i in $$list; do echo $$i; done) | \ + sed -e 1h -e 1s/./=/g -e 1p -e 1x -e '$$p' -e '$$x' +distuninstallcheck: + @test -n '$(distuninstallcheck_dir)' || { \ + echo 'ERROR: trying to run $@ with an empty' \ + '$$(distuninstallcheck_dir)' >&2; \ + exit 1; \ + }; \ + $(am__cd) '$(distuninstallcheck_dir)' || { \ + echo 'ERROR: cannot chdir into $(distuninstallcheck_dir)' >&2; \ + exit 1; \ + }; \ + test `$(am__distuninstallcheck_listfiles) | wc -l` -eq 0 \ + || { echo "ERROR: files left after uninstall:" ; \ + if test -n "$(DESTDIR)"; then \ + echo " (check DESTDIR support)"; \ + fi ; \ + $(distuninstallcheck_listfiles) ; \ + exit 1; } >&2 +distcleancheck: distclean + @if test '$(srcdir)' = . ; then \ + echo "ERROR: distcleancheck can only run from a VPATH build" ; \ + exit 1 ; \ + fi + @test `$(distcleancheck_listfiles) | wc -l` -eq 0 \ + || { echo "ERROR: files left in build directory after distclean:" ; \ + $(distcleancheck_listfiles) ; \ + exit 1; } >&2 +check-am: all-am +check: check-recursive +all-am: Makefile $(DATA) +installdirs: installdirs-recursive +installdirs-am: + for dir in "$(DESTDIR)$(noarch_pkgconfigdir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-recursive +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -$(am__rm_f) $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || $(am__rm_f) $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -$(am__rm_f) $(MAINTAINERCLEANFILES) +clean: clean-recursive + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-recursive + -rm -f $(am__CONFIG_DISTCLEAN_FILES) + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-recursive + +dvi-am: + +html: html-recursive + +html-am: + +info: info-recursive + +info-am: + +install-data-am: install-noarch_pkgconfigDATA + +install-dvi: install-dvi-recursive + +install-dvi-am: + +install-exec-am: + +install-html: install-html-recursive + +install-html-am: + +install-info: install-info-recursive + +install-info-am: + +install-man: + +install-pdf: install-pdf-recursive + +install-pdf-am: + +install-ps: install-ps-recursive + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-recursive + -rm -f $(am__CONFIG_DISTCLEAN_FILES) + -rm -rf $(top_srcdir)/autom4te.cache + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-recursive + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-recursive + +pdf-am: + +ps: ps-recursive + +ps-am: + +uninstall-am: uninstall-noarch_pkgconfigDATA + +.MAKE: $(am__recursive_targets) install-am install-strip + +.PHONY: $(am__recursive_targets) CTAGS GTAGS TAGS all all-am \ + am--refresh check check-am clean clean-cscope clean-generic \ + cscope cscopelist-am ctags ctags-am dist dist-all dist-bzip2 \ + dist-gzip dist-lzip dist-shar dist-tarZ dist-xz dist-zip \ + dist-zstd distcheck distclean distclean-generic distclean-tags \ + distcleancheck distdir distuninstallcheck dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-noarch_pkgconfigDATA \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + installdirs-am maintainer-clean maintainer-clean-generic \ + mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags \ + tags-am uninstall uninstall-am uninstall-noarch_pkgconfigDATA + +.PRECIOUS: Makefile + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: + +# Tell GNU make to disable its built-in pattern rules. +%:: %,v +%:: RCS/%,v +%:: RCS/% +%:: s.% +%:: SCCS/s.% diff --git a/Packages/asio-1.36.0/README b/Packages/asio-1.36.0/README new file mode 100644 index 0000000..cce00ad --- /dev/null +++ b/Packages/asio-1.36.0/README @@ -0,0 +1,4 @@ +asio version 1.36.0 +Released Saturday, 16 August 2025. + +See doc/index.html for API documentation and a tutorial. diff --git a/Packages/asio-1.36.0/aclocal.m4 b/Packages/asio-1.36.0/aclocal.m4 new file mode 100644 index 0000000..105a8ef --- /dev/null +++ b/Packages/asio-1.36.0/aclocal.m4 @@ -0,0 +1,1343 @@ +# generated automatically by aclocal 1.17 -*- Autoconf -*- + +# Copyright (C) 1996-2024 Free Software Foundation, Inc. + +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +m4_ifndef([AC_CONFIG_MACRO_DIRS], [m4_defun([_AM_CONFIG_MACRO_DIRS], [])m4_defun([AC_CONFIG_MACRO_DIRS], [_AM_CONFIG_MACRO_DIRS($@)])]) +m4_ifndef([AC_AUTOCONF_VERSION], + [m4_copy([m4_PACKAGE_VERSION], [AC_AUTOCONF_VERSION])])dnl +m4_if(m4_defn([AC_AUTOCONF_VERSION]), [2.72],, +[m4_warning([this file was generated for autoconf 2.72. +You have another version of autoconf. It may work, but is not guaranteed to. +If you have problems, you may need to regenerate the build system entirely. +To do so, use the procedure documented by the package, typically 'autoreconf'.])]) + +# Copyright (C) 2002-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_AUTOMAKE_VERSION(VERSION) +# ---------------------------- +# Automake X.Y traces this macro to ensure aclocal.m4 has been +# generated from the m4 files accompanying Automake X.Y. +# (This private macro should not be called outside this file.) +AC_DEFUN([AM_AUTOMAKE_VERSION], +[am__api_version='1.17' +dnl Some users find AM_AUTOMAKE_VERSION and mistake it for a way to +dnl require some minimum version. Point them to the right macro. +m4_if([$1], [1.17], [], + [AC_FATAL([Do not call $0, use AM_INIT_AUTOMAKE([$1]).])])dnl +]) + +# _AM_AUTOCONF_VERSION(VERSION) +# ----------------------------- +# aclocal traces this macro to find the Autoconf version. +# This is a private macro too. Using m4_define simplifies +# the logic in aclocal, which can simply ignore this definition. +m4_define([_AM_AUTOCONF_VERSION], []) + +# AM_SET_CURRENT_AUTOMAKE_VERSION +# ------------------------------- +# Call AM_AUTOMAKE_VERSION and AM_AUTOMAKE_VERSION so they can be traced. +# This function is AC_REQUIREd by AM_INIT_AUTOMAKE. +AC_DEFUN([AM_SET_CURRENT_AUTOMAKE_VERSION], +[AM_AUTOMAKE_VERSION([1.17])dnl +m4_ifndef([AC_AUTOCONF_VERSION], + [m4_copy([m4_PACKAGE_VERSION], [AC_AUTOCONF_VERSION])])dnl +_AM_AUTOCONF_VERSION(m4_defn([AC_AUTOCONF_VERSION]))]) + +# AM_AUX_DIR_EXPAND -*- Autoconf -*- + +# Copyright (C) 2001-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# For projects using AC_CONFIG_AUX_DIR([foo]), Autoconf sets +# $ac_aux_dir to '$srcdir/foo'. In other projects, it is set to +# '$srcdir', '$srcdir/..', or '$srcdir/../..'. +# +# Of course, Automake must honor this variable whenever it calls a +# tool from the auxiliary directory. The problem is that $srcdir (and +# therefore $ac_aux_dir as well) can be either absolute or relative, +# depending on how configure is run. This is pretty annoying, since +# it makes $ac_aux_dir quite unusable in subdirectories: in the top +# source directory, any form will work fine, but in subdirectories a +# relative path needs to be adjusted first. +# +# $ac_aux_dir/missing +# fails when called from a subdirectory if $ac_aux_dir is relative +# $top_srcdir/$ac_aux_dir/missing +# fails if $ac_aux_dir is absolute, +# fails when called from a subdirectory in a VPATH build with +# a relative $ac_aux_dir +# +# The reason of the latter failure is that $top_srcdir and $ac_aux_dir +# are both prefixed by $srcdir. In an in-source build this is usually +# harmless because $srcdir is '.', but things will broke when you +# start a VPATH build or use an absolute $srcdir. +# +# So we could use something similar to $top_srcdir/$ac_aux_dir/missing, +# iff we strip the leading $srcdir from $ac_aux_dir. That would be: +# am_aux_dir='\$(top_srcdir)/'`expr "$ac_aux_dir" : "$srcdir//*\(.*\)"` +# and then we would define $MISSING as +# MISSING="\${SHELL} $am_aux_dir/missing" +# This will work as long as MISSING is not called from configure, because +# unfortunately $(top_srcdir) has no meaning in configure. +# However there are other variables, like CC, which are often used in +# configure, and could therefore not use this "fixed" $ac_aux_dir. +# +# Another solution, used here, is to always expand $ac_aux_dir to an +# absolute PATH. The drawback is that using absolute paths prevent a +# configured tree to be moved without reconfiguration. + +AC_DEFUN([AM_AUX_DIR_EXPAND], +[AC_REQUIRE([AC_CONFIG_AUX_DIR_DEFAULT])dnl +# Expand $ac_aux_dir to an absolute path. +am_aux_dir=`cd "$ac_aux_dir" && pwd` +]) + +# AM_CONDITIONAL -*- Autoconf -*- + +# Copyright (C) 1997-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_CONDITIONAL(NAME, SHELL-CONDITION) +# ------------------------------------- +# Define a conditional. +AC_DEFUN([AM_CONDITIONAL], +[AC_PREREQ([2.52])dnl + m4_if([$1], [TRUE], [AC_FATAL([$0: invalid condition: $1])], + [$1], [FALSE], [AC_FATAL([$0: invalid condition: $1])])dnl +AC_SUBST([$1_TRUE])dnl +AC_SUBST([$1_FALSE])dnl +_AM_SUBST_NOTMAKE([$1_TRUE])dnl +_AM_SUBST_NOTMAKE([$1_FALSE])dnl +m4_define([_AM_COND_VALUE_$1], [$2])dnl +if $2; then + $1_TRUE= + $1_FALSE='#' +else + $1_TRUE='#' + $1_FALSE= +fi +AC_CONFIG_COMMANDS_PRE( +[if test -z "${$1_TRUE}" && test -z "${$1_FALSE}"; then + AC_MSG_ERROR([[conditional "$1" was never defined. +Usually this means the macro was only invoked conditionally.]]) +fi])]) + +# Copyright (C) 1999-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + + +# There are a few dirty hacks below to avoid letting 'AC_PROG_CC' be +# written in clear, in which case automake, when reading aclocal.m4, +# will think it sees a *use*, and therefore will trigger all it's +# C support machinery. Also note that it means that autoscan, seeing +# CC etc. in the Makefile, will ask for an AC_PROG_CC use... + + +# _AM_DEPENDENCIES(NAME) +# ---------------------- +# See how the compiler implements dependency checking. +# NAME is "CC", "CXX", "OBJC", "OBJCXX", "UPC", or "GJC". +# We try a few techniques and use that to set a single cache variable. +# +# We don't AC_REQUIRE the corresponding AC_PROG_CC since the latter was +# modified to invoke _AM_DEPENDENCIES(CC); we would have a circular +# dependency, and given that the user is not expected to run this macro, +# just rely on AC_PROG_CC. +AC_DEFUN([_AM_DEPENDENCIES], +[AC_REQUIRE([AM_SET_DEPDIR])dnl +AC_REQUIRE([AM_OUTPUT_DEPENDENCY_COMMANDS])dnl +AC_REQUIRE([AM_MAKE_INCLUDE])dnl +AC_REQUIRE([AM_DEP_TRACK])dnl + +m4_if([$1], [CC], [depcc="$CC" am_compiler_list=], + [$1], [CXX], [depcc="$CXX" am_compiler_list=], + [$1], [OBJC], [depcc="$OBJC" am_compiler_list='gcc3 gcc'], + [$1], [OBJCXX], [depcc="$OBJCXX" am_compiler_list='gcc3 gcc'], + [$1], [UPC], [depcc="$UPC" am_compiler_list=], + [$1], [GCJ], [depcc="$GCJ" am_compiler_list='gcc3 gcc'], + [depcc="$$1" am_compiler_list=]) + +AC_CACHE_CHECK([dependency style of $depcc], + [am_cv_$1_dependencies_compiler_type], +[if test -z "$AMDEP_TRUE" && test -f "$am_depcomp"; then + # We make a subdir and do the tests there. Otherwise we can end up + # making bogus files that we don't know about and never remove. For + # instance it was reported that on HP-UX the gcc test will end up + # making a dummy file named 'D' -- because '-MD' means "put the output + # in D". + rm -rf conftest.dir + mkdir conftest.dir + # Copy depcomp to subdir because otherwise we won't find it if we're + # using a relative directory. + cp "$am_depcomp" conftest.dir + cd conftest.dir + # We will build objects and dependencies in a subdirectory because + # it helps to detect inapplicable dependency modes. For instance + # both Tru64's cc and ICC support -MD to output dependencies as a + # side effect of compilation, but ICC will put the dependencies in + # the current directory while Tru64 will put them in the object + # directory. + mkdir sub + + am_cv_$1_dependencies_compiler_type=none + if test "$am_compiler_list" = ""; then + am_compiler_list=`sed -n ['s/^#*\([a-zA-Z0-9]*\))$/\1/p'] < ./depcomp` + fi + am__universal=false + m4_case([$1], [CC], + [case " $depcc " in #( + *\ -arch\ *\ -arch\ *) am__universal=true ;; + esac], + [CXX], + [case " $depcc " in #( + *\ -arch\ *\ -arch\ *) am__universal=true ;; + esac]) + + for depmode in $am_compiler_list; do + # Setup a source with many dependencies, because some compilers + # like to wrap large dependency lists on column 80 (with \), and + # we should not choose a depcomp mode which is confused by this. + # + # We need to recreate these files for each test, as the compiler may + # overwrite some of them when testing with obscure command lines. + # This happens at least with the AIX C compiler. + : > sub/conftest.c + for i in 1 2 3 4 5 6; do + echo '#include "conftst'$i'.h"' >> sub/conftest.c + # Using ": > sub/conftst$i.h" creates only sub/conftst1.h with + # Solaris 10 /bin/sh. + echo '/* dummy */' > sub/conftst$i.h + done + echo "${am__include} ${am__quote}sub/conftest.Po${am__quote}" > confmf + + # We check with '-c' and '-o' for the sake of the "dashmstdout" + # mode. It turns out that the SunPro C++ compiler does not properly + # handle '-M -o', and we need to detect this. Also, some Intel + # versions had trouble with output in subdirs. + am__obj=sub/conftest.${OBJEXT-o} + am__minus_obj="-o $am__obj" + case $depmode in + gcc) + # This depmode causes a compiler race in universal mode. + test "$am__universal" = false || continue + ;; + nosideeffect) + # After this tag, mechanisms are not by side-effect, so they'll + # only be used when explicitly requested. + if test "x$enable_dependency_tracking" = xyes; then + continue + else + break + fi + ;; + msvc7 | msvc7msys | msvisualcpp | msvcmsys) + # This compiler won't grok '-c -o', but also, the minuso test has + # not run yet. These depmodes are late enough in the game, and + # so weak that their functioning should not be impacted. + am__obj=conftest.${OBJEXT-o} + am__minus_obj= + ;; + none) break ;; + esac + if depmode=$depmode \ + source=sub/conftest.c object=$am__obj \ + depfile=sub/conftest.Po tmpdepfile=sub/conftest.TPo \ + $SHELL ./depcomp $depcc -c $am__minus_obj sub/conftest.c \ + >/dev/null 2>conftest.err && + grep sub/conftst1.h sub/conftest.Po > /dev/null 2>&1 && + grep sub/conftst6.h sub/conftest.Po > /dev/null 2>&1 && + grep $am__obj sub/conftest.Po > /dev/null 2>&1 && + ${MAKE-make} -s -f confmf > /dev/null 2>&1; then + # icc doesn't choke on unknown options, it will just issue warnings + # or remarks (even with -Werror). So we grep stderr for any message + # that says an option was ignored or not supported. + # When given -MP, icc 7.0 and 7.1 complain thus: + # icc: Command line warning: ignoring option '-M'; no argument required + # The diagnosis changed in icc 8.0: + # icc: Command line remark: option '-MP' not supported + if (grep 'ignoring option' conftest.err || + grep 'not supported' conftest.err) >/dev/null 2>&1; then :; else + am_cv_$1_dependencies_compiler_type=$depmode + break + fi + fi + done + + cd .. + rm -rf conftest.dir +else + am_cv_$1_dependencies_compiler_type=none +fi +]) +AC_SUBST([$1DEPMODE], [depmode=$am_cv_$1_dependencies_compiler_type]) +AM_CONDITIONAL([am__fastdep$1], [ + test "x$enable_dependency_tracking" != xno \ + && test "$am_cv_$1_dependencies_compiler_type" = gcc3]) +]) + + +# AM_SET_DEPDIR +# ------------- +# Choose a directory name for dependency files. +# This macro is AC_REQUIREd in _AM_DEPENDENCIES. +AC_DEFUN([AM_SET_DEPDIR], +[AC_REQUIRE([AM_SET_LEADING_DOT])dnl +AC_SUBST([DEPDIR], ["${am__leading_dot}deps"])dnl +]) + + +# AM_DEP_TRACK +# ------------ +AC_DEFUN([AM_DEP_TRACK], +[AC_ARG_ENABLE([dependency-tracking], [dnl +AS_HELP_STRING( + [--enable-dependency-tracking], + [do not reject slow dependency extractors]) +AS_HELP_STRING( + [--disable-dependency-tracking], + [speeds up one-time build])]) +if test "x$enable_dependency_tracking" != xno; then + am_depcomp="$ac_aux_dir/depcomp" + AMDEPBACKSLASH='\' + am__nodep='_no' +fi +AM_CONDITIONAL([AMDEP], [test "x$enable_dependency_tracking" != xno]) +AC_SUBST([AMDEPBACKSLASH])dnl +_AM_SUBST_NOTMAKE([AMDEPBACKSLASH])dnl +AC_SUBST([am__nodep])dnl +_AM_SUBST_NOTMAKE([am__nodep])dnl +]) + +# Generate code to set up dependency tracking. -*- Autoconf -*- + +# Copyright (C) 1999-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_OUTPUT_DEPENDENCY_COMMANDS +# ------------------------------ +AC_DEFUN([_AM_OUTPUT_DEPENDENCY_COMMANDS], +[{ + # Older Autoconf quotes --file arguments for eval, but not when files + # are listed without --file. Let's play safe and only enable the eval + # if we detect the quoting. + # TODO: see whether this extra hack can be removed once we start + # requiring Autoconf 2.70 or later. + AS_CASE([$CONFIG_FILES], + [*\'*], [eval set x "$CONFIG_FILES"], + [*], [set x $CONFIG_FILES]) + shift + # Used to flag and report bootstrapping failures. + am_rc=0 + for am_mf + do + # Strip MF so we end up with the name of the file. + am_mf=`AS_ECHO(["$am_mf"]) | sed -e 's/:.*$//'` + # Check whether this is an Automake generated Makefile which includes + # dependency-tracking related rules and includes. + # Grep'ing the whole file directly is not great: AIX grep has a line + # limit of 2048, but all sed's we know have understand at least 4000. + sed -n 's,^am--depfiles:.*,X,p' "$am_mf" | grep X >/dev/null 2>&1 \ + || continue + am_dirpart=`AS_DIRNAME(["$am_mf"])` + am_filepart=`AS_BASENAME(["$am_mf"])` + AM_RUN_LOG([cd "$am_dirpart" \ + && sed -e '/# am--include-marker/d' "$am_filepart" \ + | $MAKE -f - am--depfiles]) || am_rc=$? + done + if test $am_rc -ne 0; then + AC_MSG_FAILURE([Something went wrong bootstrapping makefile fragments + for automatic dependency tracking. If GNU make was not used, consider + re-running the configure script with MAKE="gmake" (or whatever is + necessary). You can also try re-running configure with the + '--disable-dependency-tracking' option to at least be able to build + the package (albeit without support for automatic dependency tracking).]) + fi + AS_UNSET([am_dirpart]) + AS_UNSET([am_filepart]) + AS_UNSET([am_mf]) + AS_UNSET([am_rc]) + rm -f conftest-deps.mk +} +])# _AM_OUTPUT_DEPENDENCY_COMMANDS + + +# AM_OUTPUT_DEPENDENCY_COMMANDS +# ----------------------------- +# This macro should only be invoked once -- use via AC_REQUIRE. +# +# This code is only required when automatic dependency tracking is enabled. +# This creates each '.Po' and '.Plo' makefile fragment that we'll need in +# order to bootstrap the dependency handling code. +AC_DEFUN([AM_OUTPUT_DEPENDENCY_COMMANDS], +[AC_CONFIG_COMMANDS([depfiles], + [test x"$AMDEP_TRUE" != x"" || _AM_OUTPUT_DEPENDENCY_COMMANDS], + [AMDEP_TRUE="$AMDEP_TRUE" MAKE="${MAKE-make}"])]) + +# Do all the work for Automake. -*- Autoconf -*- + +# Copyright (C) 1996-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This macro actually does too much. Some checks are only needed if +# your package does certain things. But this isn't really a big deal. + +dnl Redefine AC_PROG_CC to automatically invoke _AM_PROG_CC_C_O. +m4_define([AC_PROG_CC], +m4_defn([AC_PROG_CC]) +[_AM_PROG_CC_C_O +]) + +# AM_INIT_AUTOMAKE(PACKAGE, VERSION, [NO-DEFINE]) +# AM_INIT_AUTOMAKE([OPTIONS]) +# ----------------------------------------------- +# The call with PACKAGE and VERSION arguments is the old style +# call (pre autoconf-2.50), which is being phased out. PACKAGE +# and VERSION should now be passed to AC_INIT and removed from +# the call to AM_INIT_AUTOMAKE. +# We support both call styles for the transition. After +# the next Automake release, Autoconf can make the AC_INIT +# arguments mandatory, and then we can depend on a new Autoconf +# release and drop the old call support. +AC_DEFUN([AM_INIT_AUTOMAKE], +[AC_PREREQ([2.65])dnl +m4_ifdef([_$0_ALREADY_INIT], + [m4_fatal([$0 expanded multiple times +]m4_defn([_$0_ALREADY_INIT]))], + [m4_define([_$0_ALREADY_INIT], m4_expansion_stack)])dnl +dnl Autoconf wants to disallow AM_ names. We explicitly allow +dnl the ones we care about. +m4_pattern_allow([^AM_[A-Z]+FLAGS$])dnl +AC_REQUIRE([AM_SET_CURRENT_AUTOMAKE_VERSION])dnl +AC_REQUIRE([AC_PROG_INSTALL])dnl +if test "`cd $srcdir && pwd`" != "`pwd`"; then + # Use -I$(srcdir) only when $(srcdir) != ., so that make's output + # is not polluted with repeated "-I." + AC_SUBST([am__isrc], [' -I$(srcdir)'])_AM_SUBST_NOTMAKE([am__isrc])dnl + # test to see if srcdir already configured + if test -f $srcdir/config.status; then + AC_MSG_ERROR([source directory already configured; run "make distclean" there first]) + fi +fi + +# test whether we have cygpath +if test -z "$CYGPATH_W"; then + if (cygpath --version) >/dev/null 2>/dev/null; then + CYGPATH_W='cygpath -w' + else + CYGPATH_W=echo + fi +fi +AC_SUBST([CYGPATH_W]) + +# Define the identity of the package. +dnl Distinguish between old-style and new-style calls. +m4_ifval([$2], +[AC_DIAGNOSE([obsolete], + [$0: two- and three-arguments forms are deprecated.]) +m4_ifval([$3], [_AM_SET_OPTION([no-define])])dnl + AC_SUBST([PACKAGE], [$1])dnl + AC_SUBST([VERSION], [$2])], +[_AM_SET_OPTIONS([$1])dnl +dnl Diagnose old-style AC_INIT with new-style AM_AUTOMAKE_INIT. +m4_if( + m4_ifset([AC_PACKAGE_NAME], [ok]):m4_ifset([AC_PACKAGE_VERSION], [ok]), + [ok:ok],, + [m4_fatal([AC_INIT should be called with package and version arguments])])dnl + AC_SUBST([PACKAGE], ['AC_PACKAGE_TARNAME'])dnl + AC_SUBST([VERSION], ['AC_PACKAGE_VERSION'])])dnl + +_AM_IF_OPTION([no-define],, +[AC_DEFINE_UNQUOTED([PACKAGE], ["$PACKAGE"], [Name of package]) + AC_DEFINE_UNQUOTED([VERSION], ["$VERSION"], [Version number of package])])dnl + +# Some tools Automake needs. +AC_REQUIRE([AM_SANITY_CHECK])dnl +AC_REQUIRE([AC_ARG_PROGRAM])dnl +AM_MISSING_PROG([ACLOCAL], [aclocal-${am__api_version}]) +AM_MISSING_PROG([AUTOCONF], [autoconf]) +AM_MISSING_PROG([AUTOMAKE], [automake-${am__api_version}]) +AM_MISSING_PROG([AUTOHEADER], [autoheader]) +AM_MISSING_PROG([MAKEINFO], [makeinfo]) +AC_REQUIRE([AM_PROG_INSTALL_SH])dnl +AC_REQUIRE([AM_PROG_INSTALL_STRIP])dnl +AC_REQUIRE([AC_PROG_MKDIR_P])dnl +# For better backward compatibility. To be removed once Automake 1.9.x +# dies out for good. For more background, see: +# +# +AC_SUBST([mkdir_p], ['$(MKDIR_P)']) +# We need awk for the "check" target (and possibly the TAP driver). The +# system "awk" is bad on some platforms. +AC_REQUIRE([AC_PROG_AWK])dnl +AC_REQUIRE([AC_PROG_MAKE_SET])dnl +AC_REQUIRE([AM_SET_LEADING_DOT])dnl +_AM_IF_OPTION([tar-ustar], [_AM_PROG_TAR([ustar])], + [_AM_IF_OPTION([tar-pax], [_AM_PROG_TAR([pax])], + [_AM_PROG_TAR([v7])])]) +_AM_IF_OPTION([no-dependencies],, +[AC_PROVIDE_IFELSE([AC_PROG_CC], + [_AM_DEPENDENCIES([CC])], + [m4_define([AC_PROG_CC], + m4_defn([AC_PROG_CC])[_AM_DEPENDENCIES([CC])])])dnl +AC_PROVIDE_IFELSE([AC_PROG_CXX], + [_AM_DEPENDENCIES([CXX])], + [m4_define([AC_PROG_CXX], + m4_defn([AC_PROG_CXX])[_AM_DEPENDENCIES([CXX])])])dnl +AC_PROVIDE_IFELSE([AC_PROG_OBJC], + [_AM_DEPENDENCIES([OBJC])], + [m4_define([AC_PROG_OBJC], + m4_defn([AC_PROG_OBJC])[_AM_DEPENDENCIES([OBJC])])])dnl +AC_PROVIDE_IFELSE([AC_PROG_OBJCXX], + [_AM_DEPENDENCIES([OBJCXX])], + [m4_define([AC_PROG_OBJCXX], + m4_defn([AC_PROG_OBJCXX])[_AM_DEPENDENCIES([OBJCXX])])])dnl +]) +# Variables for tags utilities; see am/tags.am +if test -z "$CTAGS"; then + CTAGS=ctags +fi +AC_SUBST([CTAGS]) +if test -z "$ETAGS"; then + ETAGS=etags +fi +AC_SUBST([ETAGS]) +if test -z "$CSCOPE"; then + CSCOPE=cscope +fi +AC_SUBST([CSCOPE]) + +AC_REQUIRE([_AM_SILENT_RULES])dnl +dnl The testsuite driver may need to know about EXEEXT, so add the +dnl 'am__EXEEXT' conditional if _AM_COMPILER_EXEEXT was seen. This +dnl macro is hooked onto _AC_COMPILER_EXEEXT early, see below. +AC_CONFIG_COMMANDS_PRE(dnl +[m4_provide_if([_AM_COMPILER_EXEEXT], + [AM_CONDITIONAL([am__EXEEXT], [test -n "$EXEEXT"])])])dnl + +AC_REQUIRE([_AM_PROG_RM_F]) +AC_REQUIRE([_AM_PROG_XARGS_N]) + +dnl The trailing newline in this macro's definition is deliberate, for +dnl backward compatibility and to allow trailing 'dnl'-style comments +dnl after the AM_INIT_AUTOMAKE invocation. See automake bug#16841. +]) + +dnl Hook into '_AC_COMPILER_EXEEXT' early to learn its expansion. Do not +dnl add the conditional right here, as _AC_COMPILER_EXEEXT may be further +dnl mangled by Autoconf and run in a shell conditional statement. +m4_define([_AC_COMPILER_EXEEXT], +m4_defn([_AC_COMPILER_EXEEXT])[m4_provide([_AM_COMPILER_EXEEXT])]) + +# When config.status generates a header, we must update the stamp-h file. +# This file resides in the same directory as the config header +# that is generated. The stamp files are numbered to have different names. + +# Autoconf calls _AC_AM_CONFIG_HEADER_HOOK (when defined) in the +# loop where config.status creates the headers, so we can generate +# our stamp files there. +AC_DEFUN([_AC_AM_CONFIG_HEADER_HOOK], +[# Compute $1's index in $config_headers. +_am_arg=$1 +_am_stamp_count=1 +for _am_header in $config_headers :; do + case $_am_header in + $_am_arg | $_am_arg:* ) + break ;; + * ) + _am_stamp_count=`expr $_am_stamp_count + 1` ;; + esac +done +echo "timestamp for $_am_arg" >`AS_DIRNAME(["$_am_arg"])`/stamp-h[]$_am_stamp_count]) + +# Copyright (C) 2001-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_PROG_INSTALL_SH +# ------------------ +# Define $install_sh. +AC_DEFUN([AM_PROG_INSTALL_SH], +[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl +if test x"${install_sh+set}" != xset; then + case $am_aux_dir in + *\ * | *\ *) + install_sh="\${SHELL} '$am_aux_dir/install-sh'" ;; + *) + install_sh="\${SHELL} $am_aux_dir/install-sh" + esac +fi +AC_SUBST([install_sh])]) + +# Copyright (C) 2003-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# Check whether the underlying file-system supports filenames +# with a leading dot. For instance MS-DOS doesn't. +AC_DEFUN([AM_SET_LEADING_DOT], +[rm -rf .tst 2>/dev/null +mkdir .tst 2>/dev/null +if test -d .tst; then + am__leading_dot=. +else + am__leading_dot=_ +fi +rmdir .tst 2>/dev/null +AC_SUBST([am__leading_dot])]) + +# Add --enable-maintainer-mode option to configure. -*- Autoconf -*- +# From Jim Meyering + +# Copyright (C) 1996-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_MAINTAINER_MODE([DEFAULT-MODE]) +# ---------------------------------- +# Control maintainer-specific portions of Makefiles. +# Default is to disable them, unless 'enable' is passed literally. +# For symmetry, 'disable' may be passed as well. Anyway, the user +# can override the default with the --enable/--disable switch. +AC_DEFUN([AM_MAINTAINER_MODE], +[m4_case(m4_default([$1], [disable]), + [enable], [m4_define([am_maintainer_other], [disable])], + [disable], [m4_define([am_maintainer_other], [enable])], + [m4_define([am_maintainer_other], [enable]) + m4_warn([syntax], [unexpected argument to AM@&t@_MAINTAINER_MODE: $1])]) +AC_MSG_CHECKING([whether to enable maintainer-specific portions of Makefiles]) + dnl maintainer-mode's default is 'disable' unless 'enable' is passed + AC_ARG_ENABLE([maintainer-mode], + [AS_HELP_STRING([--]am_maintainer_other[-maintainer-mode], + am_maintainer_other[ make rules and dependencies not useful + (and sometimes confusing) to the casual installer])], + [USE_MAINTAINER_MODE=$enableval], + [USE_MAINTAINER_MODE=]m4_if(am_maintainer_other, [enable], [no], [yes])) + AC_MSG_RESULT([$USE_MAINTAINER_MODE]) + AM_CONDITIONAL([MAINTAINER_MODE], [test $USE_MAINTAINER_MODE = yes]) + MAINT=$MAINTAINER_MODE_TRUE + AC_SUBST([MAINT])dnl +] +) + +# Check to see how 'make' treats includes. -*- Autoconf -*- + +# Copyright (C) 2001-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_MAKE_INCLUDE() +# ----------------- +# Check whether make has an 'include' directive that can support all +# the idioms we need for our automatic dependency tracking code. +AC_DEFUN([AM_MAKE_INCLUDE], +[AC_MSG_CHECKING([whether ${MAKE-make} supports the include directive]) +cat > confinc.mk << 'END' +am__doit: + @echo this is the am__doit target >confinc.out +.PHONY: am__doit +END +am__include="#" +am__quote= +# BSD make does it like this. +echo '.include "confinc.mk" # ignored' > confmf.BSD +# Other make implementations (GNU, Solaris 10, AIX) do it like this. +echo 'include confinc.mk # ignored' > confmf.GNU +_am_result=no +for s in GNU BSD; do + AM_RUN_LOG([${MAKE-make} -f confmf.$s && cat confinc.out]) + AS_CASE([$?:`cat confinc.out 2>/dev/null`], + ['0:this is the am__doit target'], + [AS_CASE([$s], + [BSD], [am__include='.include' am__quote='"'], + [am__include='include' am__quote=''])]) + if test "$am__include" != "#"; then + _am_result="yes ($s style)" + break + fi +done +rm -f confinc.* confmf.* +AC_MSG_RESULT([${_am_result}]) +AC_SUBST([am__include])]) +AC_SUBST([am__quote])]) + +# Fake the existence of programs that GNU maintainers use. -*- Autoconf -*- + +# Copyright (C) 1997-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_MISSING_PROG(NAME, PROGRAM) +# ------------------------------ +AC_DEFUN([AM_MISSING_PROG], +[AC_REQUIRE([AM_MISSING_HAS_RUN]) +$1=${$1-"${am_missing_run}$2"} +AC_SUBST($1)]) + +# AM_MISSING_HAS_RUN +# ------------------ +# Define MISSING if not defined so far and test if it is modern enough. +# If it is, set am_missing_run to use it, otherwise, to nothing. +AC_DEFUN([AM_MISSING_HAS_RUN], +[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl +AC_REQUIRE_AUX_FILE([missing])dnl +if test x"${MISSING+set}" != xset; then + MISSING="\${SHELL} '$am_aux_dir/missing'" +fi +# Use eval to expand $SHELL +if eval "$MISSING --is-lightweight"; then + am_missing_run="$MISSING " +else + am_missing_run= + AC_MSG_WARN(['missing' script is too old or missing]) +fi +]) + +# Helper functions for option handling. -*- Autoconf -*- + +# Copyright (C) 2001-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_MANGLE_OPTION(NAME) +# ----------------------- +AC_DEFUN([_AM_MANGLE_OPTION], +[[_AM_OPTION_]m4_bpatsubst($1, [[^a-zA-Z0-9_]], [_])]) + +# _AM_SET_OPTION(NAME) +# -------------------- +# Set option NAME. Presently that only means defining a flag for this option. +AC_DEFUN([_AM_SET_OPTION], +[m4_define(_AM_MANGLE_OPTION([$1]), [1])]) + +# _AM_SET_OPTIONS(OPTIONS) +# ------------------------ +# OPTIONS is a space-separated list of Automake options. +AC_DEFUN([_AM_SET_OPTIONS], +[m4_foreach_w([_AM_Option], [$1], [_AM_SET_OPTION(_AM_Option)])]) + +# _AM_IF_OPTION(OPTION, IF-SET, [IF-NOT-SET]) +# ------------------------------------------- +# Execute IF-SET if OPTION is set, IF-NOT-SET otherwise. +AC_DEFUN([_AM_IF_OPTION], +[m4_ifset(_AM_MANGLE_OPTION([$1]), [$2], [$3])]) + +# Copyright (C) 1999-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_PROG_CC_C_O +# --------------- +# Like AC_PROG_CC_C_O, but changed for automake. We rewrite AC_PROG_CC +# to automatically call this. +AC_DEFUN([_AM_PROG_CC_C_O], +[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl +AC_REQUIRE_AUX_FILE([compile])dnl +AC_LANG_PUSH([C])dnl +AC_CACHE_CHECK( + [whether $CC understands -c and -o together], + [am_cv_prog_cc_c_o], + [AC_LANG_CONFTEST([AC_LANG_PROGRAM([])]) + # Make sure it works both with $CC and with simple cc. + # Following AC_PROG_CC_C_O, we do the test twice because some + # compilers refuse to overwrite an existing .o file with -o, + # though they will create one. + am_cv_prog_cc_c_o=yes + for am_i in 1 2; do + if AM_RUN_LOG([$CC -c conftest.$ac_ext -o conftest2.$ac_objext]) \ + && test -f conftest2.$ac_objext; then + : OK + else + am_cv_prog_cc_c_o=no + break + fi + done + rm -f core conftest* + unset am_i]) +if test "$am_cv_prog_cc_c_o" != yes; then + # Losing compiler, so override with the script. + # FIXME: It is wrong to rewrite CC. + # But if we don't then we get into trouble of one sort or another. + # A longer-term fix would be to have automake use am__CC in this case, + # and then we could set am__CC="\$(top_srcdir)/compile \$(CC)" + CC="$am_aux_dir/compile $CC" +fi +AC_LANG_POP([C])]) + +# For backward compatibility. +AC_DEFUN_ONCE([AM_PROG_CC_C_O], [AC_REQUIRE([AC_PROG_CC])]) + +# Copyright (C) 2022-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_PROG_RM_F +# --------------- +# Check whether 'rm -f' without any arguments works. +# https://bugs.gnu.org/10828 +AC_DEFUN([_AM_PROG_RM_F], +[am__rm_f_notfound= +AS_IF([(rm -f && rm -fr && rm -rf) 2>/dev/null], [], [am__rm_f_notfound='""']) +AC_SUBST(am__rm_f_notfound) +]) + +# Copyright (C) 2001-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_RUN_LOG(COMMAND) +# ------------------- +# Run COMMAND, save the exit status in ac_status, and log it. +# (This has been adapted from Autoconf's _AC_RUN_LOG macro.) +AC_DEFUN([AM_RUN_LOG], +[{ echo "$as_me:$LINENO: $1" >&AS_MESSAGE_LOG_FD + ($1) >&AS_MESSAGE_LOG_FD 2>&AS_MESSAGE_LOG_FD + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&AS_MESSAGE_LOG_FD + (exit $ac_status); }]) + +# Check to make sure that the build environment is sane. -*- Autoconf -*- + +# Copyright (C) 1996-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_SLEEP_FRACTIONAL_SECONDS +# ---------------------------- +AC_DEFUN([_AM_SLEEP_FRACTIONAL_SECONDS], [dnl +AC_CACHE_CHECK([whether sleep supports fractional seconds], + am_cv_sleep_fractional_seconds, [dnl +AS_IF([sleep 0.001 2>/dev/null], [am_cv_sleep_fractional_seconds=yes], + [am_cv_sleep_fractional_seconds=no]) +])]) + +# _AM_FILESYSTEM_TIMESTAMP_RESOLUTION +# ----------------------------------- +# Determine the filesystem's resolution for file modification +# timestamps. The coarsest we know of is FAT, with a resolution +# of only two seconds, even with the most recent "exFAT" extensions. +# The finest (e.g. ext4 with large inodes, XFS, ZFS) is one +# nanosecond, matching clock_gettime. However, it is probably not +# possible to delay execution of a shell script for less than one +# millisecond, due to process creation overhead and scheduling +# granularity, so we don't check for anything finer than that. (See below.) +AC_DEFUN([_AM_FILESYSTEM_TIMESTAMP_RESOLUTION], [dnl +AC_REQUIRE([_AM_SLEEP_FRACTIONAL_SECONDS]) +AC_CACHE_CHECK([filesystem timestamp resolution], + am_cv_filesystem_timestamp_resolution, [dnl +# Default to the worst case. +am_cv_filesystem_timestamp_resolution=2 + +# Only try to go finer than 1 sec if sleep can do it. +# Don't try 1 sec, because if 0.01 sec and 0.1 sec don't work, +# - 1 sec is not much of a win compared to 2 sec, and +# - it takes 2 seconds to perform the test whether 1 sec works. +# +# Instead, just use the default 2s on platforms that have 1s resolution, +# accept the extra 1s delay when using $sleep in the Automake tests, in +# exchange for not incurring the 2s delay for running the test for all +# packages. +# +am_try_resolutions= +if test "$am_cv_sleep_fractional_seconds" = yes; then + # Even a millisecond often causes a bunch of false positives, + # so just try a hundredth of a second. The time saved between .001 and + # .01 is not terribly consequential. + am_try_resolutions="0.01 0.1 $am_try_resolutions" +fi + +# In order to catch current-generation FAT out, we must *modify* files +# that already exist; the *creation* timestamp is finer. Use names +# that make ls -t sort them differently when they have equal +# timestamps than when they have distinct timestamps, keeping +# in mind that ls -t prints the *newest* file first. +rm -f conftest.ts? +: > conftest.ts1 +: > conftest.ts2 +: > conftest.ts3 + +# Make sure ls -t actually works. Do 'set' in a subshell so we don't +# clobber the current shell's arguments. (Outer-level square brackets +# are removed by m4; they're present so that m4 does not expand +# ; be careful, easy to get confused.) +if ( + set X `[ls -t conftest.ts[12]]` && + { + test "$[]*" != "X conftest.ts1 conftest.ts2" || + test "$[]*" != "X conftest.ts2 conftest.ts1"; + } +); then :; else + # If neither matched, then we have a broken ls. This can happen + # if, for instance, CONFIG_SHELL is bash and it inherits a + # broken ls alias from the environment. This has actually + # happened. Such a system could not be considered "sane". + _AS_ECHO_UNQUOTED( + ["Bad output from ls -t: \"`[ls -t conftest.ts[12]]`\""], + [AS_MESSAGE_LOG_FD]) + AC_MSG_FAILURE([ls -t produces unexpected output. +Make sure there is not a broken ls alias in your environment.]) +fi + +for am_try_res in $am_try_resolutions; do + # Any one fine-grained sleep might happen to cross the boundary + # between two values of a coarser actual resolution, but if we do + # two fine-grained sleeps in a row, at least one of them will fall + # entirely within a coarse interval. + echo alpha > conftest.ts1 + sleep $am_try_res + echo beta > conftest.ts2 + sleep $am_try_res + echo gamma > conftest.ts3 + + # We assume that 'ls -t' will make use of high-resolution + # timestamps if the operating system supports them at all. + if (set X `ls -t conftest.ts?` && + test "$[]2" = conftest.ts3 && + test "$[]3" = conftest.ts2 && + test "$[]4" = conftest.ts1); then + # + # Ok, ls -t worked. If we're at a resolution of 1 second, we're done, + # because we don't need to test make. + make_ok=true + if test $am_try_res != 1; then + # But if we've succeeded so far with a subsecond resolution, we + # have one more thing to check: make. It can happen that + # everything else supports the subsecond mtimes, but make doesn't; + # notably on macOS, which ships make 3.81 from 2006 (the last one + # released under GPLv2). https://bugs.gnu.org/68808 + # + # We test $MAKE if it is defined in the environment, else "make". + # It might get overridden later, but our hope is that in practice + # it does not matter: it is the system "make" which is (by far) + # the most likely to be broken, whereas if the user overrides it, + # probably they did so with a better, or at least not worse, make. + # https://lists.gnu.org/archive/html/automake/2024-06/msg00051.html + # + # Create a Makefile (real tab character here): + rm -f conftest.mk + echo 'conftest.ts1: conftest.ts2' >conftest.mk + echo ' touch conftest.ts2' >>conftest.mk + # + # Now, running + # touch conftest.ts1; touch conftest.ts2; make + # should touch ts1 because ts2 is newer. This could happen by luck, + # but most often, it will fail if make's support is insufficient. So + # test for several consecutive successes. + # + # (We reuse conftest.ts[12] because we still want to modify existing + # files, not create new ones, per above.) + n=0 + make=${MAKE-make} + until test $n -eq 3; do + echo one > conftest.ts1 + sleep $am_try_res + echo two > conftest.ts2 # ts2 should now be newer than ts1 + if $make -f conftest.mk | grep 'up to date' >/dev/null; then + make_ok=false + break # out of $n loop + fi + n=`expr $n + 1` + done + fi + # + if $make_ok; then + # Everything we know to check worked out, so call this resolution good. + am_cv_filesystem_timestamp_resolution=$am_try_res + break # out of $am_try_res loop + fi + # Otherwise, we'll go on to check the next resolution. + fi +done +rm -f conftest.ts? +# (end _am_filesystem_timestamp_resolution) +])]) + +# AM_SANITY_CHECK +# --------------- +AC_DEFUN([AM_SANITY_CHECK], +[AC_REQUIRE([_AM_FILESYSTEM_TIMESTAMP_RESOLUTION]) +# This check should not be cached, as it may vary across builds of +# different projects. +AC_MSG_CHECKING([whether build environment is sane]) +# Reject unsafe characters in $srcdir or the absolute working directory +# name. Accept space and tab only in the latter. +am_lf=' +' +case `pwd` in + *[[\\\"\#\$\&\'\`$am_lf]]*) + AC_MSG_ERROR([unsafe absolute working directory name]);; +esac +case $srcdir in + *[[\\\"\#\$\&\'\`$am_lf\ \ ]]*) + AC_MSG_ERROR([unsafe srcdir value: '$srcdir']);; +esac + +# Do 'set' in a subshell so we don't clobber the current shell's +# arguments. Must try -L first in case configure is actually a +# symlink; some systems play weird games with the mod time of symlinks +# (eg FreeBSD returns the mod time of the symlink's containing +# directory). +am_build_env_is_sane=no +am_has_slept=no +rm -f conftest.file +for am_try in 1 2; do + echo "timestamp, slept: $am_has_slept" > conftest.file + if ( + set X `ls -Lt "$srcdir/configure" conftest.file 2> /dev/null` + if test "$[]*" = "X"; then + # -L didn't work. + set X `ls -t "$srcdir/configure" conftest.file` + fi + test "$[]2" = conftest.file + ); then + am_build_env_is_sane=yes + break + fi + # Just in case. + sleep "$am_cv_filesystem_timestamp_resolution" + am_has_slept=yes +done + +AC_MSG_RESULT([$am_build_env_is_sane]) +if test "$am_build_env_is_sane" = no; then + AC_MSG_ERROR([newly created file is older than distributed files! +Check your system clock]) +fi + +# If we didn't sleep, we still need to ensure time stamps of config.status and +# generated files are strictly newer. +am_sleep_pid= +AS_IF([test -e conftest.file || grep 'slept: no' conftest.file >/dev/null 2>&1],, [dnl + ( sleep "$am_cv_filesystem_timestamp_resolution" ) & + am_sleep_pid=$! +]) +AC_CONFIG_COMMANDS_PRE( + [AC_MSG_CHECKING([that generated files are newer than configure]) + if test -n "$am_sleep_pid"; then + # Hide warnings about reused PIDs. + wait $am_sleep_pid 2>/dev/null + fi + AC_MSG_RESULT([done])]) +rm -f conftest.file +]) + +# Copyright (C) 2009-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_SILENT_RULES +# ---------------- +# Enable less verbose build rules support. +AC_DEFUN([_AM_SILENT_RULES], +[AM_DEFAULT_VERBOSITY=1 +AC_ARG_ENABLE([silent-rules], [dnl +AS_HELP_STRING( + [--enable-silent-rules], + [less verbose build output (undo: "make V=1")]) +AS_HELP_STRING( + [--disable-silent-rules], + [verbose build output (undo: "make V=0")])dnl +]) +dnl +dnl A few 'make' implementations (e.g., NonStop OS and NextStep) +dnl do not support nested variable expansions. +dnl See automake bug#9928 and bug#10237. +am_make=${MAKE-make} +AC_CACHE_CHECK([whether $am_make supports nested variables], + [am_cv_make_support_nested_variables], + [if AS_ECHO([['TRUE=$(BAR$(V)) +BAR0=false +BAR1=true +V=1 +am__doit: + @$(TRUE) +.PHONY: am__doit']]) | $am_make -f - >/dev/null 2>&1; then + am_cv_make_support_nested_variables=yes +else + am_cv_make_support_nested_variables=no +fi]) +AC_SUBST([AM_V])dnl +AM_SUBST_NOTMAKE([AM_V])dnl +AC_SUBST([AM_DEFAULT_V])dnl +AM_SUBST_NOTMAKE([AM_DEFAULT_V])dnl +AC_SUBST([AM_DEFAULT_VERBOSITY])dnl +AM_BACKSLASH='\' +AC_SUBST([AM_BACKSLASH])dnl +_AM_SUBST_NOTMAKE([AM_BACKSLASH])dnl +dnl Delay evaluation of AM_DEFAULT_VERBOSITY to the end to allow multiple calls +dnl to AM_SILENT_RULES to change the default value. +AC_CONFIG_COMMANDS_PRE([dnl +case $enable_silent_rules in @%:@ ((( + yes) AM_DEFAULT_VERBOSITY=0;; + no) AM_DEFAULT_VERBOSITY=1;; +esac +if test $am_cv_make_support_nested_variables = yes; then + dnl Using '$V' instead of '$(V)' breaks IRIX make. + AM_V='$(V)' + AM_DEFAULT_V='$(AM_DEFAULT_VERBOSITY)' +else + AM_V=$AM_DEFAULT_VERBOSITY + AM_DEFAULT_V=$AM_DEFAULT_VERBOSITY +fi +])dnl +]) + +# AM_SILENT_RULES([DEFAULT]) +# -------------------------- +# Set the default verbosity level to DEFAULT ("yes" being less verbose, "no" or +# empty being verbose). +AC_DEFUN([AM_SILENT_RULES], +[AC_REQUIRE([_AM_SILENT_RULES]) +AM_DEFAULT_VERBOSITY=m4_if([$1], [yes], [0], [1])]) + +# Copyright (C) 2001-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# AM_PROG_INSTALL_STRIP +# --------------------- +# One issue with vendor 'install' (even GNU) is that you can't +# specify the program used to strip binaries. This is especially +# annoying in cross-compiling environments, where the build's strip +# is unlikely to handle the host's binaries. +# Fortunately install-sh will honor a STRIPPROG variable, so we +# always use install-sh in "make install-strip", and initialize +# STRIPPROG with the value of the STRIP variable (set by the user). +AC_DEFUN([AM_PROG_INSTALL_STRIP], +[AC_REQUIRE([AM_PROG_INSTALL_SH])dnl +# Installed binaries are usually stripped using 'strip' when the user +# run "make install-strip". However 'strip' might not be the right +# tool to use in cross-compilation environments, therefore Automake +# will honor the 'STRIP' environment variable to overrule this program. +dnl Don't test for $cross_compiling = yes, because it might be 'maybe'. +if test "$cross_compiling" != no; then + AC_CHECK_TOOL([STRIP], [strip], :) +fi +INSTALL_STRIP_PROGRAM="\$(install_sh) -c -s" +AC_SUBST([INSTALL_STRIP_PROGRAM])]) + +# Copyright (C) 2006-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_SUBST_NOTMAKE(VARIABLE) +# --------------------------- +# Prevent Automake from outputting VARIABLE = @VARIABLE@ in Makefile.in. +# This macro is traced by Automake. +AC_DEFUN([_AM_SUBST_NOTMAKE]) + +# AM_SUBST_NOTMAKE(VARIABLE) +# -------------------------- +# Public sister of _AM_SUBST_NOTMAKE. +AC_DEFUN([AM_SUBST_NOTMAKE], [_AM_SUBST_NOTMAKE($@)]) + +# Check how to create a tarball. -*- Autoconf -*- + +# Copyright (C) 2004-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_PROG_TAR(FORMAT) +# -------------------- +# Check how to create a tarball in format FORMAT. +# FORMAT should be one of 'v7', 'ustar', or 'pax'. +# +# Substitute a variable $(am__tar) that is a command +# writing to stdout a FORMAT-tarball containing the directory +# $tardir. +# tardir=directory && $(am__tar) > result.tar +# +# Substitute a variable $(am__untar) that extract such +# a tarball read from stdin. +# $(am__untar) < result.tar +# +AC_DEFUN([_AM_PROG_TAR], +[# Always define AMTAR for backward compatibility. Yes, it's still used +# in the wild :-( We should find a proper way to deprecate it ... +AC_SUBST([AMTAR], ['$${TAR-tar}']) + +# We'll loop over all known methods to create a tar archive until one works. +_am_tools='gnutar m4_if([$1], [ustar], [plaintar]) pax cpio none' + +m4_if([$1], [v7], + [am__tar='$${TAR-tar} chof - "$$tardir"' am__untar='$${TAR-tar} xf -'], + + [m4_case([$1], + [ustar], + [# The POSIX 1988 'ustar' format is defined with fixed-size fields. + # There is notably a 21 bits limit for the UID and the GID. In fact, + # the 'pax' utility can hang on bigger UID/GID (see automake bug#8343 + # and bug#13588). + am_max_uid=2097151 # 2^21 - 1 + am_max_gid=$am_max_uid + # The $UID and $GID variables are not portable, so we need to resort + # to the POSIX-mandated id(1) utility. Errors in the 'id' calls + # below are definitely unexpected, so allow the users to see them + # (that is, avoid stderr redirection). + am_uid=`id -u || echo unknown` + am_gid=`id -g || echo unknown` + AC_MSG_CHECKING([whether UID '$am_uid' is supported by ustar format]) + if test x$am_uid = xunknown; then + AC_MSG_WARN([ancient id detected; assuming current UID is ok, but dist-ustar might not work]) + elif test $am_uid -le $am_max_uid; then + AC_MSG_RESULT([yes]) + else + AC_MSG_RESULT([no]) + _am_tools=none + fi + AC_MSG_CHECKING([whether GID '$am_gid' is supported by ustar format]) + if test x$gm_gid = xunknown; then + AC_MSG_WARN([ancient id detected; assuming current GID is ok, but dist-ustar might not work]) + elif test $am_gid -le $am_max_gid; then + AC_MSG_RESULT([yes]) + else + AC_MSG_RESULT([no]) + _am_tools=none + fi], + + [pax], + [], + + [m4_fatal([Unknown tar format])]) + + AC_MSG_CHECKING([how to create a $1 tar archive]) + + # Go ahead even if we have the value already cached. We do so because we + # need to set the values for the 'am__tar' and 'am__untar' variables. + _am_tools=${am_cv_prog_tar_$1-$_am_tools} + + for _am_tool in $_am_tools; do + case $_am_tool in + gnutar) + for _am_tar in tar gnutar gtar; do + AM_RUN_LOG([$_am_tar --version]) && break + done + am__tar="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$$tardir"' + am__tar_="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$tardir"' + am__untar="$_am_tar -xf -" + ;; + plaintar) + # Must skip GNU tar: if it does not support --format= it doesn't create + # ustar tarball either. + (tar --version) >/dev/null 2>&1 && continue + am__tar='tar chf - "$$tardir"' + am__tar_='tar chf - "$tardir"' + am__untar='tar xf -' + ;; + pax) + am__tar='pax -L -x $1 -w "$$tardir"' + am__tar_='pax -L -x $1 -w "$tardir"' + am__untar='pax -r' + ;; + cpio) + am__tar='find "$$tardir" -print | cpio -o -H $1 -L' + am__tar_='find "$tardir" -print | cpio -o -H $1 -L' + am__untar='cpio -i -H $1 -d' + ;; + none) + am__tar=false + am__tar_=false + am__untar=false + ;; + esac + + # If the value was cached, stop now. We just wanted to have am__tar + # and am__untar set. + test -n "${am_cv_prog_tar_$1}" && break + + # tar/untar a dummy directory, and stop if the command works. + rm -rf conftest.dir + mkdir conftest.dir + echo GrepMe > conftest.dir/file + AM_RUN_LOG([tardir=conftest.dir && eval $am__tar_ >conftest.tar]) + rm -rf conftest.dir + if test -s conftest.tar; then + AM_RUN_LOG([$am__untar /dev/null 2>&1 && break + fi + done + rm -rf conftest.dir + + AC_CACHE_VAL([am_cv_prog_tar_$1], [am_cv_prog_tar_$1=$_am_tool]) + AC_MSG_RESULT([$am_cv_prog_tar_$1])]) + +AC_SUBST([am__tar]) +AC_SUBST([am__untar]) +]) # _AM_PROG_TAR + +# Copyright (C) 2022-2024 Free Software Foundation, Inc. +# +# This file is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# _AM_PROG_XARGS_N +# ---------------- +# Check whether 'xargs -n' works. It should work everywhere, so the fallback +# is not optimized at all as we never expect to use it. +AC_DEFUN([_AM_PROG_XARGS_N], +[AC_CACHE_CHECK([xargs -n works], am_cv_xargs_n_works, [dnl +AS_IF([test "`echo 1 2 3 | xargs -n2 echo`" = "1 2 +3"], [am_cv_xargs_n_works=yes], [am_cv_xargs_n_works=no])]) +AS_IF([test "$am_cv_xargs_n_works" = yes], [am__xargs_n='xargs -n'], [dnl + am__xargs_n='am__xargs_n () { shift; sed "s/ /\\n/g" | while read am__xargs_n_arg; do "$@" "$am__xargs_n_arg"; done; }' +])dnl +AC_SUBST(am__xargs_n) +]) + diff --git a/Packages/asio-1.36.0/asio.pc.in b/Packages/asio-1.36.0/asio.pc.in new file mode 100644 index 0000000..b93eb67 --- /dev/null +++ b/Packages/asio-1.36.0/asio.pc.in @@ -0,0 +1,11 @@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +includedir=@includedir@ + +Name: @PACKAGE_NAME@ +Description: A cross-platform C++ library for network and low-level I/O programming that provides developers with a consistent asynchronous model using a modern C++ approach. +Version: @PACKAGE_VERSION@ +Cflags: -I${includedir} +Lflags: +Requires: +Requires.private: diff --git a/Packages/asio-1.36.0/compile b/Packages/asio-1.36.0/compile new file mode 100644 index 0000000..49b3d05 --- /dev/null +++ b/Packages/asio-1.36.0/compile @@ -0,0 +1,351 @@ +#! /bin/sh +# Wrapper for compilers which do not understand '-c -o'. + +scriptversion=2024-06-19.01; # UTC + +# Copyright (C) 1999-2024 Free Software Foundation, Inc. +# Written by Tom Tromey . +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# As a special exception to the GNU General Public License, if you +# distribute this file as part of a program that contains a +# configuration script generated by Autoconf, you may include it under +# the same distribution terms that you use for the rest of that program. + +# This file is maintained in Automake, please report +# bugs to or send patches to +# . + +nl=' +' + +# We need space, tab and new line, in precisely that order. Quoting is +# there to prevent tools from complaining about whitespace usage. +IFS=" "" $nl" + +file_conv= + +# func_file_conv build_file lazy +# Convert a $build file to $host form and store it in $file +# Currently only supports Windows hosts. If the determined conversion +# type is listed in (the comma separated) LAZY, no conversion will +# take place. +func_file_conv () +{ + file=$1 + case $file in + / | /[!/]*) # absolute file, and not a UNC file + if test -z "$file_conv"; then + # lazily determine how to convert abs files + case `uname -s` in + MINGW*) + file_conv=mingw + ;; + CYGWIN* | MSYS*) + file_conv=cygwin + ;; + *) + file_conv=wine + ;; + esac + fi + case $file_conv/,$2, in + *,$file_conv,*) + ;; + mingw/*) + file=`cmd //C echo "$file " | sed -e 's/"\(.*\) " *$/\1/'` + ;; + cygwin/* | msys/*) + file=`cygpath -m "$file" || echo "$file"` + ;; + wine/*) + file=`winepath -w "$file" || echo "$file"` + ;; + esac + ;; + esac +} + +# func_cl_dashL linkdir +# Make cl look for libraries in LINKDIR +func_cl_dashL () +{ + func_file_conv "$1" + if test -z "$lib_path"; then + lib_path=$file + else + lib_path="$lib_path;$file" + fi + linker_opts="$linker_opts -LIBPATH:$file" +} + +# func_cl_dashl library +# Do a library search-path lookup for cl +func_cl_dashl () +{ + lib=$1 + found=no + save_IFS=$IFS + IFS=';' + for dir in $lib_path $LIB + do + IFS=$save_IFS + if $shared && test -f "$dir/$lib.dll.lib"; then + found=yes + lib=$dir/$lib.dll.lib + break + fi + if test -f "$dir/$lib.lib"; then + found=yes + lib=$dir/$lib.lib + break + fi + if test -f "$dir/lib$lib.a"; then + found=yes + lib=$dir/lib$lib.a + break + fi + done + IFS=$save_IFS + + if test "$found" != yes; then + lib=$lib.lib + fi +} + +# func_cl_wrapper cl arg... +# Adjust compile command to suit cl +func_cl_wrapper () +{ + # Assume a capable shell + lib_path= + shared=: + linker_opts= + for arg + do + if test -n "$eat"; then + eat= + else + case $1 in + -o) + # configure might choose to run compile as 'compile cc -o foo foo.c'. + eat=1 + case $2 in + *.o | *.lo | *.[oO][bB][jJ]) + func_file_conv "$2" + set x "$@" -Fo"$file" + shift + ;; + *) + func_file_conv "$2" + set x "$@" -Fe"$file" + shift + ;; + esac + ;; + -I) + eat=1 + func_file_conv "$2" mingw + set x "$@" -I"$file" + shift + ;; + -I*) + func_file_conv "${1#-I}" mingw + set x "$@" -I"$file" + shift + ;; + -l) + eat=1 + func_cl_dashl "$2" + set x "$@" "$lib" + shift + ;; + -l*) + func_cl_dashl "${1#-l}" + set x "$@" "$lib" + shift + ;; + -L) + eat=1 + func_cl_dashL "$2" + ;; + -L*) + func_cl_dashL "${1#-L}" + ;; + -static) + shared=false + ;; + -Wl,*) + arg=${1#-Wl,} + save_ifs="$IFS"; IFS=',' + for flag in $arg; do + IFS="$save_ifs" + linker_opts="$linker_opts $flag" + done + IFS="$save_ifs" + ;; + -Xlinker) + eat=1 + linker_opts="$linker_opts $2" + ;; + -*) + set x "$@" "$1" + shift + ;; + *.cc | *.CC | *.cxx | *.CXX | *.[cC]++) + func_file_conv "$1" + set x "$@" -Tp"$file" + shift + ;; + *.c | *.cpp | *.CPP | *.lib | *.LIB | *.Lib | *.OBJ | *.obj | *.[oO]) + func_file_conv "$1" mingw + set x "$@" "$file" + shift + ;; + *) + set x "$@" "$1" + shift + ;; + esac + fi + shift + done + if test -n "$linker_opts"; then + linker_opts="-link$linker_opts" + fi + exec "$@" $linker_opts + exit 1 +} + +eat= + +case $1 in + '') + echo "$0: No command. Try '$0 --help' for more information." 1>&2 + exit 1; + ;; + -h | --h*) + cat <<\EOF +Usage: compile [--help] [--version] PROGRAM [ARGS] + +Wrapper for compilers which do not understand '-c -o'. +Remove '-o dest.o' from ARGS, run PROGRAM with the remaining +arguments, and rename the output as expected. + +If you are trying to build a whole package this is not the +right script to run: please start by reading the file 'INSTALL'. + +Report bugs to . +GNU Automake home page: . +General help using GNU software: . +EOF + exit $? + ;; + -v | --v*) + echo "compile (GNU Automake) $scriptversion" + exit $? + ;; + cl | *[/\\]cl | cl.exe | *[/\\]cl.exe | \ + clang-cl | *[/\\]clang-cl | clang-cl.exe | *[/\\]clang-cl.exe | \ + icl | *[/\\]icl | icl.exe | *[/\\]icl.exe ) + func_cl_wrapper "$@" # Doesn't return... + ;; +esac + +ofile= +cfile= + +for arg +do + if test -n "$eat"; then + eat= + else + case $1 in + -o) + # configure might choose to run compile as 'compile cc -o foo foo.c'. + # So we strip '-o arg' only if arg is an object. + eat=1 + case $2 in + *.o | *.obj) + ofile=$2 + ;; + *) + set x "$@" -o "$2" + shift + ;; + esac + ;; + *.c) + cfile=$1 + set x "$@" "$1" + shift + ;; + *) + set x "$@" "$1" + shift + ;; + esac + fi + shift +done + +if test -z "$ofile" || test -z "$cfile"; then + # If no '-o' option was seen then we might have been invoked from a + # pattern rule where we don't need one. That is ok -- this is a + # normal compilation that the losing compiler can handle. If no + # '.c' file was seen then we are probably linking. That is also + # ok. + exec "$@" +fi + +# Name of file we expect compiler to create. +cofile=`echo "$cfile" | sed 's|^.*[\\/]||; s|^[a-zA-Z]:||; s/\.c$/.o/'` + +# Create the lock directory. +# Note: use '[/\\:.-]' here to ensure that we don't use the same name +# that we are using for the .o file. Also, base the name on the expected +# object file name, since that is what matters with a parallel build. +lockdir=`echo "$cofile" | sed -e 's|[/\\:.-]|_|g'`.d +while true; do + if mkdir "$lockdir" >/dev/null 2>&1; then + break + fi + sleep 1 +done +# FIXME: race condition here if user kills between mkdir and trap. +trap "rmdir '$lockdir'; exit 1" 1 2 15 + +# Run the compile. +"$@" +ret=$? + +if test -f "$cofile"; then + test "$cofile" = "$ofile" || mv "$cofile" "$ofile" +elif test -f "${cofile}bj"; then + test "${cofile}bj" = "$ofile" || mv "${cofile}bj" "$ofile" +fi + +rmdir "$lockdir" +exit $ret + +# Local Variables: +# mode: shell-script +# sh-indentation: 2 +# eval: (add-hook 'before-save-hook 'time-stamp) +# time-stamp-start: "scriptversion=" +# time-stamp-format: "%:y-%02m-%02d.%02H" +# time-stamp-time-zone: "UTC0" +# time-stamp-end: "; # UTC" +# End: diff --git a/Packages/asio-1.36.0/config.guess b/Packages/asio-1.36.0/config.guess new file mode 100644 index 0000000..f6d217a --- /dev/null +++ b/Packages/asio-1.36.0/config.guess @@ -0,0 +1,1812 @@ +#! /bin/sh +# Attempt to guess a canonical system name. +# Copyright 1992-2024 Free Software Foundation, Inc. + +# shellcheck disable=SC2006,SC2268 # see below for rationale + +timestamp='2024-01-01' + +# This file is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, see . +# +# As a special exception to the GNU General Public License, if you +# distribute this file as part of a program that contains a +# configuration script generated by Autoconf, you may include it under +# the same distribution terms that you use for the rest of that +# program. This Exception is an additional permission under section 7 +# of the GNU General Public License, version 3 ("GPLv3"). +# +# Originally written by Per Bothner; maintained since 2000 by Ben Elliston. +# +# You can get the latest version of this script from: +# https://git.savannah.gnu.org/cgit/config.git/plain/config.guess +# +# Please send patches to . + + +# The "shellcheck disable" line above the timestamp inhibits complaints +# about features and limitations of the classic Bourne shell that were +# superseded or lifted in POSIX. However, this script identifies a wide +# variety of pre-POSIX systems that do not have POSIX shells at all, and +# even some reasonably current systems (Solaris 10 as case-in-point) still +# have a pre-POSIX /bin/sh. + + +me=`echo "$0" | sed -e 's,.*/,,'` + +usage="\ +Usage: $0 [OPTION] + +Output the configuration name of the system '$me' is run on. + +Options: + -h, --help print this help, then exit + -t, --time-stamp print date of last modification, then exit + -v, --version print version number, then exit + +Report bugs and patches to ." + +version="\ +GNU config.guess ($timestamp) + +Originally written by Per Bothner. +Copyright 1992-2024 Free Software Foundation, Inc. + +This is free software; see the source for copying conditions. There is NO +warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." + +help=" +Try '$me --help' for more information." + +# Parse command line +while test $# -gt 0 ; do + case $1 in + --time-stamp | --time* | -t ) + echo "$timestamp" ; exit ;; + --version | -v ) + echo "$version" ; exit ;; + --help | --h* | -h ) + echo "$usage"; exit ;; + -- ) # Stop option processing + shift; break ;; + - ) # Use stdin as input. + break ;; + -* ) + echo "$me: invalid option $1$help" >&2 + exit 1 ;; + * ) + break ;; + esac +done + +if test $# != 0; then + echo "$me: too many arguments$help" >&2 + exit 1 +fi + +# Just in case it came from the environment. +GUESS= + +# CC_FOR_BUILD -- compiler used by this script. Note that the use of a +# compiler to aid in system detection is discouraged as it requires +# temporary files to be created and, as you can see below, it is a +# headache to deal with in a portable fashion. + +# Historically, 'CC_FOR_BUILD' used to be named 'HOST_CC'. We still +# use 'HOST_CC' if defined, but it is deprecated. + +# Portable tmp directory creation inspired by the Autoconf team. + +tmp= +# shellcheck disable=SC2172 +trap 'test -z "$tmp" || rm -fr "$tmp"' 0 1 2 13 15 + +set_cc_for_build() { + # prevent multiple calls if $tmp is already set + test "$tmp" && return 0 + : "${TMPDIR=/tmp}" + # shellcheck disable=SC2039,SC3028 + { tmp=`(umask 077 && mktemp -d "$TMPDIR/cgXXXXXX") 2>/dev/null` && test -n "$tmp" && test -d "$tmp" ; } || + { test -n "$RANDOM" && tmp=$TMPDIR/cg$$-$RANDOM && (umask 077 && mkdir "$tmp" 2>/dev/null) ; } || + { tmp=$TMPDIR/cg-$$ && (umask 077 && mkdir "$tmp" 2>/dev/null) && echo "Warning: creating insecure temp directory" >&2 ; } || + { echo "$me: cannot create a temporary directory in $TMPDIR" >&2 ; exit 1 ; } + dummy=$tmp/dummy + case ${CC_FOR_BUILD-},${HOST_CC-},${CC-} in + ,,) echo "int x;" > "$dummy.c" + for driver in cc gcc c89 c99 ; do + if ($driver -c -o "$dummy.o" "$dummy.c") >/dev/null 2>&1 ; then + CC_FOR_BUILD=$driver + break + fi + done + if test x"$CC_FOR_BUILD" = x ; then + CC_FOR_BUILD=no_compiler_found + fi + ;; + ,,*) CC_FOR_BUILD=$CC ;; + ,*,*) CC_FOR_BUILD=$HOST_CC ;; + esac +} + +# This is needed to find uname on a Pyramid OSx when run in the BSD universe. +# (ghazi@noc.rutgers.edu 1994-08-24) +if test -f /.attbin/uname ; then + PATH=$PATH:/.attbin ; export PATH +fi + +UNAME_MACHINE=`(uname -m) 2>/dev/null` || UNAME_MACHINE=unknown +UNAME_RELEASE=`(uname -r) 2>/dev/null` || UNAME_RELEASE=unknown +UNAME_SYSTEM=`(uname -s) 2>/dev/null` || UNAME_SYSTEM=unknown +UNAME_VERSION=`(uname -v) 2>/dev/null` || UNAME_VERSION=unknown + +case $UNAME_SYSTEM in +Linux|GNU|GNU/*) + LIBC=unknown + + set_cc_for_build + cat <<-EOF > "$dummy.c" + #if defined(__ANDROID__) + LIBC=android + #else + #include + #if defined(__UCLIBC__) + LIBC=uclibc + #elif defined(__dietlibc__) + LIBC=dietlibc + #elif defined(__GLIBC__) + LIBC=gnu + #elif defined(__LLVM_LIBC__) + LIBC=llvm + #else + #include + /* First heuristic to detect musl libc. */ + #ifdef __DEFINED_va_list + LIBC=musl + #endif + #endif + #endif + EOF + cc_set_libc=`$CC_FOR_BUILD -E "$dummy.c" 2>/dev/null | grep '^LIBC' | sed 's, ,,g'` + eval "$cc_set_libc" + + # Second heuristic to detect musl libc. + if [ "$LIBC" = unknown ] && + command -v ldd >/dev/null && + ldd --version 2>&1 | grep -q ^musl; then + LIBC=musl + fi + + # If the system lacks a compiler, then just pick glibc. + # We could probably try harder. + if [ "$LIBC" = unknown ]; then + LIBC=gnu + fi + ;; +esac + +# Note: order is significant - the case branches are not exclusive. + +case $UNAME_MACHINE:$UNAME_SYSTEM:$UNAME_RELEASE:$UNAME_VERSION in + *:NetBSD:*:*) + # NetBSD (nbsd) targets should (where applicable) match one or + # more of the tuples: *-*-netbsdelf*, *-*-netbsdaout*, + # *-*-netbsdecoff* and *-*-netbsd*. For targets that recently + # switched to ELF, *-*-netbsd* would select the old + # object file format. This provides both forward + # compatibility and a consistent mechanism for selecting the + # object file format. + # + # Note: NetBSD doesn't particularly care about the vendor + # portion of the name. We always set it to "unknown". + UNAME_MACHINE_ARCH=`(uname -p 2>/dev/null || \ + /sbin/sysctl -n hw.machine_arch 2>/dev/null || \ + /usr/sbin/sysctl -n hw.machine_arch 2>/dev/null || \ + echo unknown)` + case $UNAME_MACHINE_ARCH in + aarch64eb) machine=aarch64_be-unknown ;; + armeb) machine=armeb-unknown ;; + arm*) machine=arm-unknown ;; + sh3el) machine=shl-unknown ;; + sh3eb) machine=sh-unknown ;; + sh5el) machine=sh5le-unknown ;; + earmv*) + arch=`echo "$UNAME_MACHINE_ARCH" | sed -e 's,^e\(armv[0-9]\).*$,\1,'` + endian=`echo "$UNAME_MACHINE_ARCH" | sed -ne 's,^.*\(eb\)$,\1,p'` + machine=${arch}${endian}-unknown + ;; + *) machine=$UNAME_MACHINE_ARCH-unknown ;; + esac + # The Operating System including object format, if it has switched + # to ELF recently (or will in the future) and ABI. + case $UNAME_MACHINE_ARCH in + earm*) + os=netbsdelf + ;; + arm*|i386|m68k|ns32k|sh3*|sparc|vax) + set_cc_for_build + if echo __ELF__ | $CC_FOR_BUILD -E - 2>/dev/null \ + | grep -q __ELF__ + then + # Once all utilities can be ECOFF (netbsdecoff) or a.out (netbsdaout). + # Return netbsd for either. FIX? + os=netbsd + else + os=netbsdelf + fi + ;; + *) + os=netbsd + ;; + esac + # Determine ABI tags. + case $UNAME_MACHINE_ARCH in + earm*) + expr='s/^earmv[0-9]/-eabi/;s/eb$//' + abi=`echo "$UNAME_MACHINE_ARCH" | sed -e "$expr"` + ;; + esac + # The OS release + # Debian GNU/NetBSD machines have a different userland, and + # thus, need a distinct triplet. However, they do not need + # kernel version information, so it can be replaced with a + # suitable tag, in the style of linux-gnu. + case $UNAME_VERSION in + Debian*) + release='-gnu' + ;; + *) + release=`echo "$UNAME_RELEASE" | sed -e 's/[-_].*//' | cut -d. -f1,2` + ;; + esac + # Since CPU_TYPE-MANUFACTURER-KERNEL-OPERATING_SYSTEM: + # contains redundant information, the shorter form: + # CPU_TYPE-MANUFACTURER-OPERATING_SYSTEM is used. + GUESS=$machine-${os}${release}${abi-} + ;; + *:Bitrig:*:*) + UNAME_MACHINE_ARCH=`arch | sed 's/Bitrig.//'` + GUESS=$UNAME_MACHINE_ARCH-unknown-bitrig$UNAME_RELEASE + ;; + *:OpenBSD:*:*) + UNAME_MACHINE_ARCH=`arch | sed 's/OpenBSD.//'` + GUESS=$UNAME_MACHINE_ARCH-unknown-openbsd$UNAME_RELEASE + ;; + *:SecBSD:*:*) + UNAME_MACHINE_ARCH=`arch | sed 's/SecBSD.//'` + GUESS=$UNAME_MACHINE_ARCH-unknown-secbsd$UNAME_RELEASE + ;; + *:LibertyBSD:*:*) + UNAME_MACHINE_ARCH=`arch | sed 's/^.*BSD\.//'` + GUESS=$UNAME_MACHINE_ARCH-unknown-libertybsd$UNAME_RELEASE + ;; + *:MidnightBSD:*:*) + GUESS=$UNAME_MACHINE-unknown-midnightbsd$UNAME_RELEASE + ;; + *:ekkoBSD:*:*) + GUESS=$UNAME_MACHINE-unknown-ekkobsd$UNAME_RELEASE + ;; + *:SolidBSD:*:*) + GUESS=$UNAME_MACHINE-unknown-solidbsd$UNAME_RELEASE + ;; + *:OS108:*:*) + GUESS=$UNAME_MACHINE-unknown-os108_$UNAME_RELEASE + ;; + macppc:MirBSD:*:*) + GUESS=powerpc-unknown-mirbsd$UNAME_RELEASE + ;; + *:MirBSD:*:*) + GUESS=$UNAME_MACHINE-unknown-mirbsd$UNAME_RELEASE + ;; + *:Sortix:*:*) + GUESS=$UNAME_MACHINE-unknown-sortix + ;; + *:Twizzler:*:*) + GUESS=$UNAME_MACHINE-unknown-twizzler + ;; + *:Redox:*:*) + GUESS=$UNAME_MACHINE-unknown-redox + ;; + mips:OSF1:*.*) + GUESS=mips-dec-osf1 + ;; + alpha:OSF1:*:*) + # Reset EXIT trap before exiting to avoid spurious non-zero exit code. + trap '' 0 + case $UNAME_RELEASE in + *4.0) + UNAME_RELEASE=`/usr/sbin/sizer -v | awk '{print $3}'` + ;; + *5.*) + UNAME_RELEASE=`/usr/sbin/sizer -v | awk '{print $4}'` + ;; + esac + # According to Compaq, /usr/sbin/psrinfo has been available on + # OSF/1 and Tru64 systems produced since 1995. I hope that + # covers most systems running today. This code pipes the CPU + # types through head -n 1, so we only detect the type of CPU 0. + ALPHA_CPU_TYPE=`/usr/sbin/psrinfo -v | sed -n -e 's/^ The alpha \(.*\) processor.*$/\1/p' | head -n 1` + case $ALPHA_CPU_TYPE in + "EV4 (21064)") + UNAME_MACHINE=alpha ;; + "EV4.5 (21064)") + UNAME_MACHINE=alpha ;; + "LCA4 (21066/21068)") + UNAME_MACHINE=alpha ;; + "EV5 (21164)") + UNAME_MACHINE=alphaev5 ;; + "EV5.6 (21164A)") + UNAME_MACHINE=alphaev56 ;; + "EV5.6 (21164PC)") + UNAME_MACHINE=alphapca56 ;; + "EV5.7 (21164PC)") + UNAME_MACHINE=alphapca57 ;; + "EV6 (21264)") + UNAME_MACHINE=alphaev6 ;; + "EV6.7 (21264A)") + UNAME_MACHINE=alphaev67 ;; + "EV6.8CB (21264C)") + UNAME_MACHINE=alphaev68 ;; + "EV6.8AL (21264B)") + UNAME_MACHINE=alphaev68 ;; + "EV6.8CX (21264D)") + UNAME_MACHINE=alphaev68 ;; + "EV6.9A (21264/EV69A)") + UNAME_MACHINE=alphaev69 ;; + "EV7 (21364)") + UNAME_MACHINE=alphaev7 ;; + "EV7.9 (21364A)") + UNAME_MACHINE=alphaev79 ;; + esac + # A Pn.n version is a patched version. + # A Vn.n version is a released version. + # A Tn.n version is a released field test version. + # A Xn.n version is an unreleased experimental baselevel. + # 1.2 uses "1.2" for uname -r. + OSF_REL=`echo "$UNAME_RELEASE" | sed -e 's/^[PVTX]//' | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz` + GUESS=$UNAME_MACHINE-dec-osf$OSF_REL + ;; + Amiga*:UNIX_System_V:4.0:*) + GUESS=m68k-unknown-sysv4 + ;; + *:[Aa]miga[Oo][Ss]:*:*) + GUESS=$UNAME_MACHINE-unknown-amigaos + ;; + *:[Mm]orph[Oo][Ss]:*:*) + GUESS=$UNAME_MACHINE-unknown-morphos + ;; + *:OS/390:*:*) + GUESS=i370-ibm-openedition + ;; + *:z/VM:*:*) + GUESS=s390-ibm-zvmoe + ;; + *:OS400:*:*) + GUESS=powerpc-ibm-os400 + ;; + arm:RISC*:1.[012]*:*|arm:riscix:1.[012]*:*) + GUESS=arm-acorn-riscix$UNAME_RELEASE + ;; + arm*:riscos:*:*|arm*:RISCOS:*:*) + GUESS=arm-unknown-riscos + ;; + SR2?01:HI-UX/MPP:*:* | SR8000:HI-UX/MPP:*:*) + GUESS=hppa1.1-hitachi-hiuxmpp + ;; + Pyramid*:OSx*:*:* | MIS*:OSx*:*:* | MIS*:SMP_DC-OSx*:*:*) + # akee@wpdis03.wpafb.af.mil (Earle F. Ake) contributed MIS and NILE. + case `(/bin/universe) 2>/dev/null` in + att) GUESS=pyramid-pyramid-sysv3 ;; + *) GUESS=pyramid-pyramid-bsd ;; + esac + ;; + NILE*:*:*:dcosx) + GUESS=pyramid-pyramid-svr4 + ;; + DRS?6000:unix:4.0:6*) + GUESS=sparc-icl-nx6 + ;; + DRS?6000:UNIX_SV:4.2*:7* | DRS?6000:isis:4.2*:7*) + case `/usr/bin/uname -p` in + sparc) GUESS=sparc-icl-nx7 ;; + esac + ;; + s390x:SunOS:*:*) + SUN_REL=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*//'` + GUESS=$UNAME_MACHINE-ibm-solaris2$SUN_REL + ;; + sun4H:SunOS:5.*:*) + SUN_REL=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*//'` + GUESS=sparc-hal-solaris2$SUN_REL + ;; + sun4*:SunOS:5.*:* | tadpole*:SunOS:5.*:*) + SUN_REL=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*//'` + GUESS=sparc-sun-solaris2$SUN_REL + ;; + i86pc:AuroraUX:5.*:* | i86xen:AuroraUX:5.*:*) + GUESS=i386-pc-auroraux$UNAME_RELEASE + ;; + i86pc:SunOS:5.*:* | i86xen:SunOS:5.*:*) + set_cc_for_build + SUN_ARCH=i386 + # If there is a compiler, see if it is configured for 64-bit objects. + # Note that the Sun cc does not turn __LP64__ into 1 like gcc does. + # This test works for both compilers. + if test "$CC_FOR_BUILD" != no_compiler_found; then + if (echo '#ifdef __amd64'; echo IS_64BIT_ARCH; echo '#endif') | \ + (CCOPTS="" $CC_FOR_BUILD -m64 -E - 2>/dev/null) | \ + grep IS_64BIT_ARCH >/dev/null + then + SUN_ARCH=x86_64 + fi + fi + SUN_REL=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*//'` + GUESS=$SUN_ARCH-pc-solaris2$SUN_REL + ;; + sun4*:SunOS:6*:*) + # According to config.sub, this is the proper way to canonicalize + # SunOS6. Hard to guess exactly what SunOS6 will be like, but + # it's likely to be more like Solaris than SunOS4. + SUN_REL=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*//'` + GUESS=sparc-sun-solaris3$SUN_REL + ;; + sun4*:SunOS:*:*) + case `/usr/bin/arch -k` in + Series*|S4*) + UNAME_RELEASE=`uname -v` + ;; + esac + # Japanese Language versions have a version number like '4.1.3-JL'. + SUN_REL=`echo "$UNAME_RELEASE" | sed -e 's/-/_/'` + GUESS=sparc-sun-sunos$SUN_REL + ;; + sun3*:SunOS:*:*) + GUESS=m68k-sun-sunos$UNAME_RELEASE + ;; + sun*:*:4.2BSD:*) + UNAME_RELEASE=`(sed 1q /etc/motd | awk '{print substr($5,1,3)}') 2>/dev/null` + test "x$UNAME_RELEASE" = x && UNAME_RELEASE=3 + case `/bin/arch` in + sun3) + GUESS=m68k-sun-sunos$UNAME_RELEASE + ;; + sun4) + GUESS=sparc-sun-sunos$UNAME_RELEASE + ;; + esac + ;; + aushp:SunOS:*:*) + GUESS=sparc-auspex-sunos$UNAME_RELEASE + ;; + # The situation for MiNT is a little confusing. The machine name + # can be virtually everything (everything which is not + # "atarist" or "atariste" at least should have a processor + # > m68000). The system name ranges from "MiNT" over "FreeMiNT" + # to the lowercase version "mint" (or "freemint"). Finally + # the system name "TOS" denotes a system which is actually not + # MiNT. But MiNT is downward compatible to TOS, so this should + # be no problem. + atarist[e]:*MiNT:*:* | atarist[e]:*mint:*:* | atarist[e]:*TOS:*:*) + GUESS=m68k-atari-mint$UNAME_RELEASE + ;; + atari*:*MiNT:*:* | atari*:*mint:*:* | atarist[e]:*TOS:*:*) + GUESS=m68k-atari-mint$UNAME_RELEASE + ;; + *falcon*:*MiNT:*:* | *falcon*:*mint:*:* | *falcon*:*TOS:*:*) + GUESS=m68k-atari-mint$UNAME_RELEASE + ;; + milan*:*MiNT:*:* | milan*:*mint:*:* | *milan*:*TOS:*:*) + GUESS=m68k-milan-mint$UNAME_RELEASE + ;; + hades*:*MiNT:*:* | hades*:*mint:*:* | *hades*:*TOS:*:*) + GUESS=m68k-hades-mint$UNAME_RELEASE + ;; + *:*MiNT:*:* | *:*mint:*:* | *:*TOS:*:*) + GUESS=m68k-unknown-mint$UNAME_RELEASE + ;; + m68k:machten:*:*) + GUESS=m68k-apple-machten$UNAME_RELEASE + ;; + powerpc:machten:*:*) + GUESS=powerpc-apple-machten$UNAME_RELEASE + ;; + RISC*:Mach:*:*) + GUESS=mips-dec-mach_bsd4.3 + ;; + RISC*:ULTRIX:*:*) + GUESS=mips-dec-ultrix$UNAME_RELEASE + ;; + VAX*:ULTRIX*:*:*) + GUESS=vax-dec-ultrix$UNAME_RELEASE + ;; + 2020:CLIX:*:* | 2430:CLIX:*:*) + GUESS=clipper-intergraph-clix$UNAME_RELEASE + ;; + mips:*:*:UMIPS | mips:*:*:RISCos) + set_cc_for_build + sed 's/^ //' << EOF > "$dummy.c" +#ifdef __cplusplus +#include /* for printf() prototype */ + int main (int argc, char *argv[]) { +#else + int main (argc, argv) int argc; char *argv[]; { +#endif + #if defined (host_mips) && defined (MIPSEB) + #if defined (SYSTYPE_SYSV) + printf ("mips-mips-riscos%ssysv\\n", argv[1]); exit (0); + #endif + #if defined (SYSTYPE_SVR4) + printf ("mips-mips-riscos%ssvr4\\n", argv[1]); exit (0); + #endif + #if defined (SYSTYPE_BSD43) || defined(SYSTYPE_BSD) + printf ("mips-mips-riscos%sbsd\\n", argv[1]); exit (0); + #endif + #endif + exit (-1); + } +EOF + $CC_FOR_BUILD -o "$dummy" "$dummy.c" && + dummyarg=`echo "$UNAME_RELEASE" | sed -n 's/\([0-9]*\).*/\1/p'` && + SYSTEM_NAME=`"$dummy" "$dummyarg"` && + { echo "$SYSTEM_NAME"; exit; } + GUESS=mips-mips-riscos$UNAME_RELEASE + ;; + Motorola:PowerMAX_OS:*:*) + GUESS=powerpc-motorola-powermax + ;; + Motorola:*:4.3:PL8-*) + GUESS=powerpc-harris-powermax + ;; + Night_Hawk:*:*:PowerMAX_OS | Synergy:PowerMAX_OS:*:*) + GUESS=powerpc-harris-powermax + ;; + Night_Hawk:Power_UNIX:*:*) + GUESS=powerpc-harris-powerunix + ;; + m88k:CX/UX:7*:*) + GUESS=m88k-harris-cxux7 + ;; + m88k:*:4*:R4*) + GUESS=m88k-motorola-sysv4 + ;; + m88k:*:3*:R3*) + GUESS=m88k-motorola-sysv3 + ;; + AViiON:dgux:*:*) + # DG/UX returns AViiON for all architectures + UNAME_PROCESSOR=`/usr/bin/uname -p` + if test "$UNAME_PROCESSOR" = mc88100 || test "$UNAME_PROCESSOR" = mc88110 + then + if test "$TARGET_BINARY_INTERFACE"x = m88kdguxelfx || \ + test "$TARGET_BINARY_INTERFACE"x = x + then + GUESS=m88k-dg-dgux$UNAME_RELEASE + else + GUESS=m88k-dg-dguxbcs$UNAME_RELEASE + fi + else + GUESS=i586-dg-dgux$UNAME_RELEASE + fi + ;; + M88*:DolphinOS:*:*) # DolphinOS (SVR3) + GUESS=m88k-dolphin-sysv3 + ;; + M88*:*:R3*:*) + # Delta 88k system running SVR3 + GUESS=m88k-motorola-sysv3 + ;; + XD88*:*:*:*) # Tektronix XD88 system running UTekV (SVR3) + GUESS=m88k-tektronix-sysv3 + ;; + Tek43[0-9][0-9]:UTek:*:*) # Tektronix 4300 system running UTek (BSD) + GUESS=m68k-tektronix-bsd + ;; + *:IRIX*:*:*) + IRIX_REL=`echo "$UNAME_RELEASE" | sed -e 's/-/_/g'` + GUESS=mips-sgi-irix$IRIX_REL + ;; + ????????:AIX?:[12].1:2) # AIX 2.2.1 or AIX 2.1.1 is RT/PC AIX. + GUESS=romp-ibm-aix # uname -m gives an 8 hex-code CPU id + ;; # Note that: echo "'`uname -s`'" gives 'AIX ' + i*86:AIX:*:*) + GUESS=i386-ibm-aix + ;; + ia64:AIX:*:*) + if test -x /usr/bin/oslevel ; then + IBM_REV=`/usr/bin/oslevel` + else + IBM_REV=$UNAME_VERSION.$UNAME_RELEASE + fi + GUESS=$UNAME_MACHINE-ibm-aix$IBM_REV + ;; + *:AIX:2:3) + if grep bos325 /usr/include/stdio.h >/dev/null 2>&1; then + set_cc_for_build + sed 's/^ //' << EOF > "$dummy.c" + #include + + main() + { + if (!__power_pc()) + exit(1); + puts("powerpc-ibm-aix3.2.5"); + exit(0); + } +EOF + if $CC_FOR_BUILD -o "$dummy" "$dummy.c" && SYSTEM_NAME=`"$dummy"` + then + GUESS=$SYSTEM_NAME + else + GUESS=rs6000-ibm-aix3.2.5 + fi + elif grep bos324 /usr/include/stdio.h >/dev/null 2>&1; then + GUESS=rs6000-ibm-aix3.2.4 + else + GUESS=rs6000-ibm-aix3.2 + fi + ;; + *:AIX:*:[4567]) + IBM_CPU_ID=`/usr/sbin/lsdev -C -c processor -S available | sed 1q | awk '{ print $1 }'` + if /usr/sbin/lsattr -El "$IBM_CPU_ID" | grep ' POWER' >/dev/null 2>&1; then + IBM_ARCH=rs6000 + else + IBM_ARCH=powerpc + fi + if test -x /usr/bin/lslpp ; then + IBM_REV=`/usr/bin/lslpp -Lqc bos.rte.libc | \ + awk -F: '{ print $3 }' | sed s/[0-9]*$/0/` + else + IBM_REV=$UNAME_VERSION.$UNAME_RELEASE + fi + GUESS=$IBM_ARCH-ibm-aix$IBM_REV + ;; + *:AIX:*:*) + GUESS=rs6000-ibm-aix + ;; + ibmrt:4.4BSD:*|romp-ibm:4.4BSD:*) + GUESS=romp-ibm-bsd4.4 + ;; + ibmrt:*BSD:*|romp-ibm:BSD:*) # covers RT/PC BSD and + GUESS=romp-ibm-bsd$UNAME_RELEASE # 4.3 with uname added to + ;; # report: romp-ibm BSD 4.3 + *:BOSX:*:*) + GUESS=rs6000-bull-bosx + ;; + DPX/2?00:B.O.S.:*:*) + GUESS=m68k-bull-sysv3 + ;; + 9000/[34]??:4.3bsd:1.*:*) + GUESS=m68k-hp-bsd + ;; + hp300:4.4BSD:*:* | 9000/[34]??:4.3bsd:2.*:*) + GUESS=m68k-hp-bsd4.4 + ;; + 9000/[34678]??:HP-UX:*:*) + HPUX_REV=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*.[0B]*//'` + case $UNAME_MACHINE in + 9000/31?) HP_ARCH=m68000 ;; + 9000/[34]??) HP_ARCH=m68k ;; + 9000/[678][0-9][0-9]) + if test -x /usr/bin/getconf; then + sc_cpu_version=`/usr/bin/getconf SC_CPU_VERSION 2>/dev/null` + sc_kernel_bits=`/usr/bin/getconf SC_KERNEL_BITS 2>/dev/null` + case $sc_cpu_version in + 523) HP_ARCH=hppa1.0 ;; # CPU_PA_RISC1_0 + 528) HP_ARCH=hppa1.1 ;; # CPU_PA_RISC1_1 + 532) # CPU_PA_RISC2_0 + case $sc_kernel_bits in + 32) HP_ARCH=hppa2.0n ;; + 64) HP_ARCH=hppa2.0w ;; + '') HP_ARCH=hppa2.0 ;; # HP-UX 10.20 + esac ;; + esac + fi + if test "$HP_ARCH" = ""; then + set_cc_for_build + sed 's/^ //' << EOF > "$dummy.c" + + #define _HPUX_SOURCE + #include + #include + + int main () + { + #if defined(_SC_KERNEL_BITS) + long bits = sysconf(_SC_KERNEL_BITS); + #endif + long cpu = sysconf (_SC_CPU_VERSION); + + switch (cpu) + { + case CPU_PA_RISC1_0: puts ("hppa1.0"); break; + case CPU_PA_RISC1_1: puts ("hppa1.1"); break; + case CPU_PA_RISC2_0: + #if defined(_SC_KERNEL_BITS) + switch (bits) + { + case 64: puts ("hppa2.0w"); break; + case 32: puts ("hppa2.0n"); break; + default: puts ("hppa2.0"); break; + } break; + #else /* !defined(_SC_KERNEL_BITS) */ + puts ("hppa2.0"); break; + #endif + default: puts ("hppa1.0"); break; + } + exit (0); + } +EOF + (CCOPTS="" $CC_FOR_BUILD -o "$dummy" "$dummy.c" 2>/dev/null) && HP_ARCH=`"$dummy"` + test -z "$HP_ARCH" && HP_ARCH=hppa + fi ;; + esac + if test "$HP_ARCH" = hppa2.0w + then + set_cc_for_build + + # hppa2.0w-hp-hpux* has a 64-bit kernel and a compiler generating + # 32-bit code. hppa64-hp-hpux* has the same kernel and a compiler + # generating 64-bit code. GNU and HP use different nomenclature: + # + # $ CC_FOR_BUILD=cc ./config.guess + # => hppa2.0w-hp-hpux11.23 + # $ CC_FOR_BUILD="cc +DA2.0w" ./config.guess + # => hppa64-hp-hpux11.23 + + if echo __LP64__ | (CCOPTS="" $CC_FOR_BUILD -E - 2>/dev/null) | + grep -q __LP64__ + then + HP_ARCH=hppa2.0w + else + HP_ARCH=hppa64 + fi + fi + GUESS=$HP_ARCH-hp-hpux$HPUX_REV + ;; + ia64:HP-UX:*:*) + HPUX_REV=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*.[0B]*//'` + GUESS=ia64-hp-hpux$HPUX_REV + ;; + 3050*:HI-UX:*:*) + set_cc_for_build + sed 's/^ //' << EOF > "$dummy.c" + #include + int + main () + { + long cpu = sysconf (_SC_CPU_VERSION); + /* The order matters, because CPU_IS_HP_MC68K erroneously returns + true for CPU_PA_RISC1_0. CPU_IS_PA_RISC returns correct + results, however. */ + if (CPU_IS_PA_RISC (cpu)) + { + switch (cpu) + { + case CPU_PA_RISC1_0: puts ("hppa1.0-hitachi-hiuxwe2"); break; + case CPU_PA_RISC1_1: puts ("hppa1.1-hitachi-hiuxwe2"); break; + case CPU_PA_RISC2_0: puts ("hppa2.0-hitachi-hiuxwe2"); break; + default: puts ("hppa-hitachi-hiuxwe2"); break; + } + } + else if (CPU_IS_HP_MC68K (cpu)) + puts ("m68k-hitachi-hiuxwe2"); + else puts ("unknown-hitachi-hiuxwe2"); + exit (0); + } +EOF + $CC_FOR_BUILD -o "$dummy" "$dummy.c" && SYSTEM_NAME=`"$dummy"` && + { echo "$SYSTEM_NAME"; exit; } + GUESS=unknown-hitachi-hiuxwe2 + ;; + 9000/7??:4.3bsd:*:* | 9000/8?[79]:4.3bsd:*:*) + GUESS=hppa1.1-hp-bsd + ;; + 9000/8??:4.3bsd:*:*) + GUESS=hppa1.0-hp-bsd + ;; + *9??*:MPE/iX:*:* | *3000*:MPE/iX:*:*) + GUESS=hppa1.0-hp-mpeix + ;; + hp7??:OSF1:*:* | hp8?[79]:OSF1:*:*) + GUESS=hppa1.1-hp-osf + ;; + hp8??:OSF1:*:*) + GUESS=hppa1.0-hp-osf + ;; + i*86:OSF1:*:*) + if test -x /usr/sbin/sysversion ; then + GUESS=$UNAME_MACHINE-unknown-osf1mk + else + GUESS=$UNAME_MACHINE-unknown-osf1 + fi + ;; + parisc*:Lites*:*:*) + GUESS=hppa1.1-hp-lites + ;; + C1*:ConvexOS:*:* | convex:ConvexOS:C1*:*) + GUESS=c1-convex-bsd + ;; + C2*:ConvexOS:*:* | convex:ConvexOS:C2*:*) + if getsysinfo -f scalar_acc + then echo c32-convex-bsd + else echo c2-convex-bsd + fi + exit ;; + C34*:ConvexOS:*:* | convex:ConvexOS:C34*:*) + GUESS=c34-convex-bsd + ;; + C38*:ConvexOS:*:* | convex:ConvexOS:C38*:*) + GUESS=c38-convex-bsd + ;; + C4*:ConvexOS:*:* | convex:ConvexOS:C4*:*) + GUESS=c4-convex-bsd + ;; + CRAY*Y-MP:*:*:*) + CRAY_REL=`echo "$UNAME_RELEASE" | sed -e 's/\.[^.]*$/.X/'` + GUESS=ymp-cray-unicos$CRAY_REL + ;; + CRAY*[A-Z]90:*:*:*) + echo "$UNAME_MACHINE"-cray-unicos"$UNAME_RELEASE" \ + | sed -e 's/CRAY.*\([A-Z]90\)/\1/' \ + -e y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/ \ + -e 's/\.[^.]*$/.X/' + exit ;; + CRAY*TS:*:*:*) + CRAY_REL=`echo "$UNAME_RELEASE" | sed -e 's/\.[^.]*$/.X/'` + GUESS=t90-cray-unicos$CRAY_REL + ;; + CRAY*T3E:*:*:*) + CRAY_REL=`echo "$UNAME_RELEASE" | sed -e 's/\.[^.]*$/.X/'` + GUESS=alphaev5-cray-unicosmk$CRAY_REL + ;; + CRAY*SV1:*:*:*) + CRAY_REL=`echo "$UNAME_RELEASE" | sed -e 's/\.[^.]*$/.X/'` + GUESS=sv1-cray-unicos$CRAY_REL + ;; + *:UNICOS/mp:*:*) + CRAY_REL=`echo "$UNAME_RELEASE" | sed -e 's/\.[^.]*$/.X/'` + GUESS=craynv-cray-unicosmp$CRAY_REL + ;; + F30[01]:UNIX_System_V:*:* | F700:UNIX_System_V:*:*) + FUJITSU_PROC=`uname -m | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz` + FUJITSU_SYS=`uname -p | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz | sed -e 's/\///'` + FUJITSU_REL=`echo "$UNAME_RELEASE" | sed -e 's/ /_/'` + GUESS=${FUJITSU_PROC}-fujitsu-${FUJITSU_SYS}${FUJITSU_REL} + ;; + 5000:UNIX_System_V:4.*:*) + FUJITSU_SYS=`uname -p | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz | sed -e 's/\///'` + FUJITSU_REL=`echo "$UNAME_RELEASE" | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz | sed -e 's/ /_/'` + GUESS=sparc-fujitsu-${FUJITSU_SYS}${FUJITSU_REL} + ;; + i*86:BSD/386:*:* | i*86:BSD/OS:*:* | *:Ascend\ Embedded/OS:*:*) + GUESS=$UNAME_MACHINE-pc-bsdi$UNAME_RELEASE + ;; + sparc*:BSD/OS:*:*) + GUESS=sparc-unknown-bsdi$UNAME_RELEASE + ;; + *:BSD/OS:*:*) + GUESS=$UNAME_MACHINE-unknown-bsdi$UNAME_RELEASE + ;; + arm:FreeBSD:*:*) + UNAME_PROCESSOR=`uname -p` + set_cc_for_build + if echo __ARM_PCS_VFP | $CC_FOR_BUILD -E - 2>/dev/null \ + | grep -q __ARM_PCS_VFP + then + FREEBSD_REL=`echo "$UNAME_RELEASE" | sed -e 's/[-(].*//'` + GUESS=$UNAME_PROCESSOR-unknown-freebsd$FREEBSD_REL-gnueabi + else + FREEBSD_REL=`echo "$UNAME_RELEASE" | sed -e 's/[-(].*//'` + GUESS=$UNAME_PROCESSOR-unknown-freebsd$FREEBSD_REL-gnueabihf + fi + ;; + *:FreeBSD:*:*) + UNAME_PROCESSOR=`uname -p` + case $UNAME_PROCESSOR in + amd64) + UNAME_PROCESSOR=x86_64 ;; + i386) + UNAME_PROCESSOR=i586 ;; + esac + FREEBSD_REL=`echo "$UNAME_RELEASE" | sed -e 's/[-(].*//'` + GUESS=$UNAME_PROCESSOR-unknown-freebsd$FREEBSD_REL + ;; + i*:CYGWIN*:*) + GUESS=$UNAME_MACHINE-pc-cygwin + ;; + *:MINGW64*:*) + GUESS=$UNAME_MACHINE-pc-mingw64 + ;; + *:MINGW*:*) + GUESS=$UNAME_MACHINE-pc-mingw32 + ;; + *:MSYS*:*) + GUESS=$UNAME_MACHINE-pc-msys + ;; + i*:PW*:*) + GUESS=$UNAME_MACHINE-pc-pw32 + ;; + *:SerenityOS:*:*) + GUESS=$UNAME_MACHINE-pc-serenity + ;; + *:Interix*:*) + case $UNAME_MACHINE in + x86) + GUESS=i586-pc-interix$UNAME_RELEASE + ;; + authenticamd | genuineintel | EM64T) + GUESS=x86_64-unknown-interix$UNAME_RELEASE + ;; + IA64) + GUESS=ia64-unknown-interix$UNAME_RELEASE + ;; + esac ;; + i*:UWIN*:*) + GUESS=$UNAME_MACHINE-pc-uwin + ;; + amd64:CYGWIN*:*:* | x86_64:CYGWIN*:*:*) + GUESS=x86_64-pc-cygwin + ;; + prep*:SunOS:5.*:*) + SUN_REL=`echo "$UNAME_RELEASE" | sed -e 's/[^.]*//'` + GUESS=powerpcle-unknown-solaris2$SUN_REL + ;; + *:GNU:*:*) + # the GNU system + GNU_ARCH=`echo "$UNAME_MACHINE" | sed -e 's,[-/].*$,,'` + GNU_REL=`echo "$UNAME_RELEASE" | sed -e 's,/.*$,,'` + GUESS=$GNU_ARCH-unknown-$LIBC$GNU_REL + ;; + *:GNU/*:*:*) + # other systems with GNU libc and userland + GNU_SYS=`echo "$UNAME_SYSTEM" | sed 's,^[^/]*/,,' | tr "[:upper:]" "[:lower:]"` + GNU_REL=`echo "$UNAME_RELEASE" | sed -e 's/[-(].*//'` + GUESS=$UNAME_MACHINE-unknown-$GNU_SYS$GNU_REL-$LIBC + ;; + x86_64:[Mm]anagarm:*:*|i?86:[Mm]anagarm:*:*) + GUESS="$UNAME_MACHINE-pc-managarm-mlibc" + ;; + *:[Mm]anagarm:*:*) + GUESS="$UNAME_MACHINE-unknown-managarm-mlibc" + ;; + *:Minix:*:*) + GUESS=$UNAME_MACHINE-unknown-minix + ;; + aarch64:Linux:*:*) + set_cc_for_build + CPU=$UNAME_MACHINE + LIBCABI=$LIBC + if test "$CC_FOR_BUILD" != no_compiler_found; then + ABI=64 + sed 's/^ //' << EOF > "$dummy.c" + #ifdef __ARM_EABI__ + #ifdef __ARM_PCS_VFP + ABI=eabihf + #else + ABI=eabi + #endif + #endif +EOF + cc_set_abi=`$CC_FOR_BUILD -E "$dummy.c" 2>/dev/null | grep '^ABI' | sed 's, ,,g'` + eval "$cc_set_abi" + case $ABI in + eabi | eabihf) CPU=armv8l; LIBCABI=$LIBC$ABI ;; + esac + fi + GUESS=$CPU-unknown-linux-$LIBCABI + ;; + aarch64_be:Linux:*:*) + UNAME_MACHINE=aarch64_be + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + alpha:Linux:*:*) + case `sed -n '/^cpu model/s/^.*: \(.*\)/\1/p' /proc/cpuinfo 2>/dev/null` in + EV5) UNAME_MACHINE=alphaev5 ;; + EV56) UNAME_MACHINE=alphaev56 ;; + PCA56) UNAME_MACHINE=alphapca56 ;; + PCA57) UNAME_MACHINE=alphapca56 ;; + EV6) UNAME_MACHINE=alphaev6 ;; + EV67) UNAME_MACHINE=alphaev67 ;; + EV68*) UNAME_MACHINE=alphaev68 ;; + esac + objdump --private-headers /bin/sh | grep -q ld.so.1 + if test "$?" = 0 ; then LIBC=gnulibc1 ; fi + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + arc:Linux:*:* | arceb:Linux:*:* | arc32:Linux:*:* | arc64:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + arm*:Linux:*:*) + set_cc_for_build + if echo __ARM_EABI__ | $CC_FOR_BUILD -E - 2>/dev/null \ + | grep -q __ARM_EABI__ + then + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + else + if echo __ARM_PCS_VFP | $CC_FOR_BUILD -E - 2>/dev/null \ + | grep -q __ARM_PCS_VFP + then + GUESS=$UNAME_MACHINE-unknown-linux-${LIBC}eabi + else + GUESS=$UNAME_MACHINE-unknown-linux-${LIBC}eabihf + fi + fi + ;; + avr32*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + cris:Linux:*:*) + GUESS=$UNAME_MACHINE-axis-linux-$LIBC + ;; + crisv32:Linux:*:*) + GUESS=$UNAME_MACHINE-axis-linux-$LIBC + ;; + e2k:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + frv:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + hexagon:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + i*86:Linux:*:*) + GUESS=$UNAME_MACHINE-pc-linux-$LIBC + ;; + ia64:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + k1om:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + kvx:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + kvx:cos:*:*) + GUESS=$UNAME_MACHINE-unknown-cos + ;; + kvx:mbr:*:*) + GUESS=$UNAME_MACHINE-unknown-mbr + ;; + loongarch32:Linux:*:* | loongarch64:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + m32r*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + m68*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + mips:Linux:*:* | mips64:Linux:*:*) + set_cc_for_build + IS_GLIBC=0 + test x"${LIBC}" = xgnu && IS_GLIBC=1 + sed 's/^ //' << EOF > "$dummy.c" + #undef CPU + #undef mips + #undef mipsel + #undef mips64 + #undef mips64el + #if ${IS_GLIBC} && defined(_ABI64) + LIBCABI=gnuabi64 + #else + #if ${IS_GLIBC} && defined(_ABIN32) + LIBCABI=gnuabin32 + #else + LIBCABI=${LIBC} + #endif + #endif + + #if ${IS_GLIBC} && defined(__mips64) && defined(__mips_isa_rev) && __mips_isa_rev>=6 + CPU=mipsisa64r6 + #else + #if ${IS_GLIBC} && !defined(__mips64) && defined(__mips_isa_rev) && __mips_isa_rev>=6 + CPU=mipsisa32r6 + #else + #if defined(__mips64) + CPU=mips64 + #else + CPU=mips + #endif + #endif + #endif + + #if defined(__MIPSEL__) || defined(__MIPSEL) || defined(_MIPSEL) || defined(MIPSEL) + MIPS_ENDIAN=el + #else + #if defined(__MIPSEB__) || defined(__MIPSEB) || defined(_MIPSEB) || defined(MIPSEB) + MIPS_ENDIAN= + #else + MIPS_ENDIAN= + #endif + #endif +EOF + cc_set_vars=`$CC_FOR_BUILD -E "$dummy.c" 2>/dev/null | grep '^CPU\|^MIPS_ENDIAN\|^LIBCABI'` + eval "$cc_set_vars" + test "x$CPU" != x && { echo "$CPU${MIPS_ENDIAN}-unknown-linux-$LIBCABI"; exit; } + ;; + mips64el:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + openrisc*:Linux:*:*) + GUESS=or1k-unknown-linux-$LIBC + ;; + or32:Linux:*:* | or1k*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + padre:Linux:*:*) + GUESS=sparc-unknown-linux-$LIBC + ;; + parisc64:Linux:*:* | hppa64:Linux:*:*) + GUESS=hppa64-unknown-linux-$LIBC + ;; + parisc:Linux:*:* | hppa:Linux:*:*) + # Look for CPU level + case `grep '^cpu[^a-z]*:' /proc/cpuinfo 2>/dev/null | cut -d' ' -f2` in + PA7*) GUESS=hppa1.1-unknown-linux-$LIBC ;; + PA8*) GUESS=hppa2.0-unknown-linux-$LIBC ;; + *) GUESS=hppa-unknown-linux-$LIBC ;; + esac + ;; + ppc64:Linux:*:*) + GUESS=powerpc64-unknown-linux-$LIBC + ;; + ppc:Linux:*:*) + GUESS=powerpc-unknown-linux-$LIBC + ;; + ppc64le:Linux:*:*) + GUESS=powerpc64le-unknown-linux-$LIBC + ;; + ppcle:Linux:*:*) + GUESS=powerpcle-unknown-linux-$LIBC + ;; + riscv32:Linux:*:* | riscv32be:Linux:*:* | riscv64:Linux:*:* | riscv64be:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + s390:Linux:*:* | s390x:Linux:*:*) + GUESS=$UNAME_MACHINE-ibm-linux-$LIBC + ;; + sh64*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + sh*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + sparc:Linux:*:* | sparc64:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + tile*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + vax:Linux:*:*) + GUESS=$UNAME_MACHINE-dec-linux-$LIBC + ;; + x86_64:Linux:*:*) + set_cc_for_build + CPU=$UNAME_MACHINE + LIBCABI=$LIBC + if test "$CC_FOR_BUILD" != no_compiler_found; then + ABI=64 + sed 's/^ //' << EOF > "$dummy.c" + #ifdef __i386__ + ABI=x86 + #else + #ifdef __ILP32__ + ABI=x32 + #endif + #endif +EOF + cc_set_abi=`$CC_FOR_BUILD -E "$dummy.c" 2>/dev/null | grep '^ABI' | sed 's, ,,g'` + eval "$cc_set_abi" + case $ABI in + x86) CPU=i686 ;; + x32) LIBCABI=${LIBC}x32 ;; + esac + fi + GUESS=$CPU-pc-linux-$LIBCABI + ;; + xtensa*:Linux:*:*) + GUESS=$UNAME_MACHINE-unknown-linux-$LIBC + ;; + i*86:DYNIX/ptx:4*:*) + # ptx 4.0 does uname -s correctly, with DYNIX/ptx in there. + # earlier versions are messed up and put the nodename in both + # sysname and nodename. + GUESS=i386-sequent-sysv4 + ;; + i*86:UNIX_SV:4.2MP:2.*) + # Unixware is an offshoot of SVR4, but it has its own version + # number series starting with 2... + # I am not positive that other SVR4 systems won't match this, + # I just have to hope. -- rms. + # Use sysv4.2uw... so that sysv4* matches it. + GUESS=$UNAME_MACHINE-pc-sysv4.2uw$UNAME_VERSION + ;; + i*86:OS/2:*:*) + # If we were able to find 'uname', then EMX Unix compatibility + # is probably installed. + GUESS=$UNAME_MACHINE-pc-os2-emx + ;; + i*86:XTS-300:*:STOP) + GUESS=$UNAME_MACHINE-unknown-stop + ;; + i*86:atheos:*:*) + GUESS=$UNAME_MACHINE-unknown-atheos + ;; + i*86:syllable:*:*) + GUESS=$UNAME_MACHINE-pc-syllable + ;; + i*86:LynxOS:2.*:* | i*86:LynxOS:3.[01]*:* | i*86:LynxOS:4.[02]*:*) + GUESS=i386-unknown-lynxos$UNAME_RELEASE + ;; + i*86:*DOS:*:*) + GUESS=$UNAME_MACHINE-pc-msdosdjgpp + ;; + i*86:*:4.*:*) + UNAME_REL=`echo "$UNAME_RELEASE" | sed 's/\/MP$//'` + if grep Novell /usr/include/link.h >/dev/null 2>/dev/null; then + GUESS=$UNAME_MACHINE-univel-sysv$UNAME_REL + else + GUESS=$UNAME_MACHINE-pc-sysv$UNAME_REL + fi + ;; + i*86:*:5:[678]*) + # UnixWare 7.x, OpenUNIX and OpenServer 6. + case `/bin/uname -X | grep "^Machine"` in + *486*) UNAME_MACHINE=i486 ;; + *Pentium) UNAME_MACHINE=i586 ;; + *Pent*|*Celeron) UNAME_MACHINE=i686 ;; + esac + GUESS=$UNAME_MACHINE-unknown-sysv${UNAME_RELEASE}${UNAME_SYSTEM}${UNAME_VERSION} + ;; + i*86:*:3.2:*) + if test -f /usr/options/cb.name; then + UNAME_REL=`sed -n 's/.*Version //p' /dev/null >/dev/null ; then + UNAME_REL=`(/bin/uname -X|grep Release|sed -e 's/.*= //')` + (/bin/uname -X|grep i80486 >/dev/null) && UNAME_MACHINE=i486 + (/bin/uname -X|grep '^Machine.*Pentium' >/dev/null) \ + && UNAME_MACHINE=i586 + (/bin/uname -X|grep '^Machine.*Pent *II' >/dev/null) \ + && UNAME_MACHINE=i686 + (/bin/uname -X|grep '^Machine.*Pentium Pro' >/dev/null) \ + && UNAME_MACHINE=i686 + GUESS=$UNAME_MACHINE-pc-sco$UNAME_REL + else + GUESS=$UNAME_MACHINE-pc-sysv32 + fi + ;; + pc:*:*:*) + # Left here for compatibility: + # uname -m prints for DJGPP always 'pc', but it prints nothing about + # the processor, so we play safe by assuming i586. + # Note: whatever this is, it MUST be the same as what config.sub + # prints for the "djgpp" host, or else GDB configure will decide that + # this is a cross-build. + GUESS=i586-pc-msdosdjgpp + ;; + Intel:Mach:3*:*) + GUESS=i386-pc-mach3 + ;; + paragon:*:*:*) + GUESS=i860-intel-osf1 + ;; + i860:*:4.*:*) # i860-SVR4 + if grep Stardent /usr/include/sys/uadmin.h >/dev/null 2>&1 ; then + GUESS=i860-stardent-sysv$UNAME_RELEASE # Stardent Vistra i860-SVR4 + else # Add other i860-SVR4 vendors below as they are discovered. + GUESS=i860-unknown-sysv$UNAME_RELEASE # Unknown i860-SVR4 + fi + ;; + mini*:CTIX:SYS*5:*) + # "miniframe" + GUESS=m68010-convergent-sysv + ;; + mc68k:UNIX:SYSTEM5:3.51m) + GUESS=m68k-convergent-sysv + ;; + M680?0:D-NIX:5.3:*) + GUESS=m68k-diab-dnix + ;; + M68*:*:R3V[5678]*:*) + test -r /sysV68 && { echo 'm68k-motorola-sysv'; exit; } ;; + 3[345]??:*:4.0:3.0 | 3[34]??A:*:4.0:3.0 | 3[34]??,*:*:4.0:3.0 | 3[34]??/*:*:4.0:3.0 | 4400:*:4.0:3.0 | 4850:*:4.0:3.0 | SKA40:*:4.0:3.0 | SDS2:*:4.0:3.0 | SHG2:*:4.0:3.0 | S7501*:*:4.0:3.0) + OS_REL='' + test -r /etc/.relid \ + && OS_REL=.`sed -n 's/[^ ]* [^ ]* \([0-9][0-9]\).*/\1/p' < /etc/.relid` + /bin/uname -p 2>/dev/null | grep 86 >/dev/null \ + && { echo i486-ncr-sysv4.3"$OS_REL"; exit; } + /bin/uname -p 2>/dev/null | /bin/grep entium >/dev/null \ + && { echo i586-ncr-sysv4.3"$OS_REL"; exit; } ;; + 3[34]??:*:4.0:* | 3[34]??,*:*:4.0:*) + /bin/uname -p 2>/dev/null | grep 86 >/dev/null \ + && { echo i486-ncr-sysv4; exit; } ;; + NCR*:*:4.2:* | MPRAS*:*:4.2:*) + OS_REL='.3' + test -r /etc/.relid \ + && OS_REL=.`sed -n 's/[^ ]* [^ ]* \([0-9][0-9]\).*/\1/p' < /etc/.relid` + /bin/uname -p 2>/dev/null | grep 86 >/dev/null \ + && { echo i486-ncr-sysv4.3"$OS_REL"; exit; } + /bin/uname -p 2>/dev/null | /bin/grep entium >/dev/null \ + && { echo i586-ncr-sysv4.3"$OS_REL"; exit; } + /bin/uname -p 2>/dev/null | /bin/grep pteron >/dev/null \ + && { echo i586-ncr-sysv4.3"$OS_REL"; exit; } ;; + m68*:LynxOS:2.*:* | m68*:LynxOS:3.0*:*) + GUESS=m68k-unknown-lynxos$UNAME_RELEASE + ;; + mc68030:UNIX_System_V:4.*:*) + GUESS=m68k-atari-sysv4 + ;; + TSUNAMI:LynxOS:2.*:*) + GUESS=sparc-unknown-lynxos$UNAME_RELEASE + ;; + rs6000:LynxOS:2.*:*) + GUESS=rs6000-unknown-lynxos$UNAME_RELEASE + ;; + PowerPC:LynxOS:2.*:* | PowerPC:LynxOS:3.[01]*:* | PowerPC:LynxOS:4.[02]*:*) + GUESS=powerpc-unknown-lynxos$UNAME_RELEASE + ;; + SM[BE]S:UNIX_SV:*:*) + GUESS=mips-dde-sysv$UNAME_RELEASE + ;; + RM*:ReliantUNIX-*:*:*) + GUESS=mips-sni-sysv4 + ;; + RM*:SINIX-*:*:*) + GUESS=mips-sni-sysv4 + ;; + *:SINIX-*:*:*) + if uname -p 2>/dev/null >/dev/null ; then + UNAME_MACHINE=`(uname -p) 2>/dev/null` + GUESS=$UNAME_MACHINE-sni-sysv4 + else + GUESS=ns32k-sni-sysv + fi + ;; + PENTIUM:*:4.0*:*) # Unisys 'ClearPath HMP IX 4000' SVR4/MP effort + # says + GUESS=i586-unisys-sysv4 + ;; + *:UNIX_System_V:4*:FTX*) + # From Gerald Hewes . + # How about differentiating between stratus architectures? -djm + GUESS=hppa1.1-stratus-sysv4 + ;; + *:*:*:FTX*) + # From seanf@swdc.stratus.com. + GUESS=i860-stratus-sysv4 + ;; + i*86:VOS:*:*) + # From Paul.Green@stratus.com. + GUESS=$UNAME_MACHINE-stratus-vos + ;; + *:VOS:*:*) + # From Paul.Green@stratus.com. + GUESS=hppa1.1-stratus-vos + ;; + mc68*:A/UX:*:*) + GUESS=m68k-apple-aux$UNAME_RELEASE + ;; + news*:NEWS-OS:6*:*) + GUESS=mips-sony-newsos6 + ;; + R[34]000:*System_V*:*:* | R4000:UNIX_SYSV:*:* | R*000:UNIX_SV:*:*) + if test -d /usr/nec; then + GUESS=mips-nec-sysv$UNAME_RELEASE + else + GUESS=mips-unknown-sysv$UNAME_RELEASE + fi + ;; + BeBox:BeOS:*:*) # BeOS running on hardware made by Be, PPC only. + GUESS=powerpc-be-beos + ;; + BeMac:BeOS:*:*) # BeOS running on Mac or Mac clone, PPC only. + GUESS=powerpc-apple-beos + ;; + BePC:BeOS:*:*) # BeOS running on Intel PC compatible. + GUESS=i586-pc-beos + ;; + BePC:Haiku:*:*) # Haiku running on Intel PC compatible. + GUESS=i586-pc-haiku + ;; + ppc:Haiku:*:*) # Haiku running on Apple PowerPC + GUESS=powerpc-apple-haiku + ;; + *:Haiku:*:*) # Haiku modern gcc (not bound by BeOS compat) + GUESS=$UNAME_MACHINE-unknown-haiku + ;; + SX-4:SUPER-UX:*:*) + GUESS=sx4-nec-superux$UNAME_RELEASE + ;; + SX-5:SUPER-UX:*:*) + GUESS=sx5-nec-superux$UNAME_RELEASE + ;; + SX-6:SUPER-UX:*:*) + GUESS=sx6-nec-superux$UNAME_RELEASE + ;; + SX-7:SUPER-UX:*:*) + GUESS=sx7-nec-superux$UNAME_RELEASE + ;; + SX-8:SUPER-UX:*:*) + GUESS=sx8-nec-superux$UNAME_RELEASE + ;; + SX-8R:SUPER-UX:*:*) + GUESS=sx8r-nec-superux$UNAME_RELEASE + ;; + SX-ACE:SUPER-UX:*:*) + GUESS=sxace-nec-superux$UNAME_RELEASE + ;; + Power*:Rhapsody:*:*) + GUESS=powerpc-apple-rhapsody$UNAME_RELEASE + ;; + *:Rhapsody:*:*) + GUESS=$UNAME_MACHINE-apple-rhapsody$UNAME_RELEASE + ;; + arm64:Darwin:*:*) + GUESS=aarch64-apple-darwin$UNAME_RELEASE + ;; + *:Darwin:*:*) + UNAME_PROCESSOR=`uname -p` + case $UNAME_PROCESSOR in + unknown) UNAME_PROCESSOR=powerpc ;; + esac + if command -v xcode-select > /dev/null 2> /dev/null && \ + ! xcode-select --print-path > /dev/null 2> /dev/null ; then + # Avoid executing cc if there is no toolchain installed as + # cc will be a stub that puts up a graphical alert + # prompting the user to install developer tools. + CC_FOR_BUILD=no_compiler_found + else + set_cc_for_build + fi + if test "$CC_FOR_BUILD" != no_compiler_found; then + if (echo '#ifdef __LP64__'; echo IS_64BIT_ARCH; echo '#endif') | \ + (CCOPTS="" $CC_FOR_BUILD -E - 2>/dev/null) | \ + grep IS_64BIT_ARCH >/dev/null + then + case $UNAME_PROCESSOR in + i386) UNAME_PROCESSOR=x86_64 ;; + powerpc) UNAME_PROCESSOR=powerpc64 ;; + esac + fi + # On 10.4-10.6 one might compile for PowerPC via gcc -arch ppc + if (echo '#ifdef __POWERPC__'; echo IS_PPC; echo '#endif') | \ + (CCOPTS="" $CC_FOR_BUILD -E - 2>/dev/null) | \ + grep IS_PPC >/dev/null + then + UNAME_PROCESSOR=powerpc + fi + elif test "$UNAME_PROCESSOR" = i386 ; then + # uname -m returns i386 or x86_64 + UNAME_PROCESSOR=$UNAME_MACHINE + fi + GUESS=$UNAME_PROCESSOR-apple-darwin$UNAME_RELEASE + ;; + *:procnto*:*:* | *:QNX:[0123456789]*:*) + UNAME_PROCESSOR=`uname -p` + if test "$UNAME_PROCESSOR" = x86; then + UNAME_PROCESSOR=i386 + UNAME_MACHINE=pc + fi + GUESS=$UNAME_PROCESSOR-$UNAME_MACHINE-nto-qnx$UNAME_RELEASE + ;; + *:QNX:*:4*) + GUESS=i386-pc-qnx + ;; + NEO-*:NONSTOP_KERNEL:*:*) + GUESS=neo-tandem-nsk$UNAME_RELEASE + ;; + NSE-*:NONSTOP_KERNEL:*:*) + GUESS=nse-tandem-nsk$UNAME_RELEASE + ;; + NSR-*:NONSTOP_KERNEL:*:*) + GUESS=nsr-tandem-nsk$UNAME_RELEASE + ;; + NSV-*:NONSTOP_KERNEL:*:*) + GUESS=nsv-tandem-nsk$UNAME_RELEASE + ;; + NSX-*:NONSTOP_KERNEL:*:*) + GUESS=nsx-tandem-nsk$UNAME_RELEASE + ;; + *:NonStop-UX:*:*) + GUESS=mips-compaq-nonstopux + ;; + BS2000:POSIX*:*:*) + GUESS=bs2000-siemens-sysv + ;; + DS/*:UNIX_System_V:*:*) + GUESS=$UNAME_MACHINE-$UNAME_SYSTEM-$UNAME_RELEASE + ;; + *:Plan9:*:*) + # "uname -m" is not consistent, so use $cputype instead. 386 + # is converted to i386 for consistency with other x86 + # operating systems. + if test "${cputype-}" = 386; then + UNAME_MACHINE=i386 + elif test "x${cputype-}" != x; then + UNAME_MACHINE=$cputype + fi + GUESS=$UNAME_MACHINE-unknown-plan9 + ;; + *:TOPS-10:*:*) + GUESS=pdp10-unknown-tops10 + ;; + *:TENEX:*:*) + GUESS=pdp10-unknown-tenex + ;; + KS10:TOPS-20:*:* | KL10:TOPS-20:*:* | TYPE4:TOPS-20:*:*) + GUESS=pdp10-dec-tops20 + ;; + XKL-1:TOPS-20:*:* | TYPE5:TOPS-20:*:*) + GUESS=pdp10-xkl-tops20 + ;; + *:TOPS-20:*:*) + GUESS=pdp10-unknown-tops20 + ;; + *:ITS:*:*) + GUESS=pdp10-unknown-its + ;; + SEI:*:*:SEIUX) + GUESS=mips-sei-seiux$UNAME_RELEASE + ;; + *:DragonFly:*:*) + DRAGONFLY_REL=`echo "$UNAME_RELEASE" | sed -e 's/[-(].*//'` + GUESS=$UNAME_MACHINE-unknown-dragonfly$DRAGONFLY_REL + ;; + *:*VMS:*:*) + UNAME_MACHINE=`(uname -p) 2>/dev/null` + case $UNAME_MACHINE in + A*) GUESS=alpha-dec-vms ;; + I*) GUESS=ia64-dec-vms ;; + V*) GUESS=vax-dec-vms ;; + esac ;; + *:XENIX:*:SysV) + GUESS=i386-pc-xenix + ;; + i*86:skyos:*:*) + SKYOS_REL=`echo "$UNAME_RELEASE" | sed -e 's/ .*$//'` + GUESS=$UNAME_MACHINE-pc-skyos$SKYOS_REL + ;; + i*86:rdos:*:*) + GUESS=$UNAME_MACHINE-pc-rdos + ;; + i*86:Fiwix:*:*) + GUESS=$UNAME_MACHINE-pc-fiwix + ;; + *:AROS:*:*) + GUESS=$UNAME_MACHINE-unknown-aros + ;; + x86_64:VMkernel:*:*) + GUESS=$UNAME_MACHINE-unknown-esx + ;; + amd64:Isilon\ OneFS:*:*) + GUESS=x86_64-unknown-onefs + ;; + *:Unleashed:*:*) + GUESS=$UNAME_MACHINE-unknown-unleashed$UNAME_RELEASE + ;; + *:Ironclad:*:*) + GUESS=$UNAME_MACHINE-unknown-ironclad + ;; +esac + +# Do we have a guess based on uname results? +if test "x$GUESS" != x; then + echo "$GUESS" + exit +fi + +# No uname command or uname output not recognized. +set_cc_for_build +cat > "$dummy.c" < +#include +#endif +#if defined(ultrix) || defined(_ultrix) || defined(__ultrix) || defined(__ultrix__) +#if defined (vax) || defined (__vax) || defined (__vax__) || defined(mips) || defined(__mips) || defined(__mips__) || defined(MIPS) || defined(__MIPS__) +#include +#if defined(_SIZE_T_) || defined(SIGLOST) +#include +#endif +#endif +#endif +main () +{ +#if defined (sony) +#if defined (MIPSEB) + /* BFD wants "bsd" instead of "newsos". Perhaps BFD should be changed, + I don't know.... */ + printf ("mips-sony-bsd\n"); exit (0); +#else +#include + printf ("m68k-sony-newsos%s\n", +#ifdef NEWSOS4 + "4" +#else + "" +#endif + ); exit (0); +#endif +#endif + +#if defined (NeXT) +#if !defined (__ARCHITECTURE__) +#define __ARCHITECTURE__ "m68k" +#endif + int version; + version=`(hostinfo | sed -n 's/.*NeXT Mach \([0-9]*\).*/\1/p') 2>/dev/null`; + if (version < 4) + printf ("%s-next-nextstep%d\n", __ARCHITECTURE__, version); + else + printf ("%s-next-openstep%d\n", __ARCHITECTURE__, version); + exit (0); +#endif + +#if defined (MULTIMAX) || defined (n16) +#if defined (UMAXV) + printf ("ns32k-encore-sysv\n"); exit (0); +#else +#if defined (CMU) + printf ("ns32k-encore-mach\n"); exit (0); +#else + printf ("ns32k-encore-bsd\n"); exit (0); +#endif +#endif +#endif + +#if defined (__386BSD__) + printf ("i386-pc-bsd\n"); exit (0); +#endif + +#if defined (sequent) +#if defined (i386) + printf ("i386-sequent-dynix\n"); exit (0); +#endif +#if defined (ns32000) + printf ("ns32k-sequent-dynix\n"); exit (0); +#endif +#endif + +#if defined (_SEQUENT_) + struct utsname un; + + uname(&un); + if (strncmp(un.version, "V2", 2) == 0) { + printf ("i386-sequent-ptx2\n"); exit (0); + } + if (strncmp(un.version, "V1", 2) == 0) { /* XXX is V1 correct? */ + printf ("i386-sequent-ptx1\n"); exit (0); + } + printf ("i386-sequent-ptx\n"); exit (0); +#endif + +#if defined (vax) +#if !defined (ultrix) +#include +#if defined (BSD) +#if BSD == 43 + printf ("vax-dec-bsd4.3\n"); exit (0); +#else +#if BSD == 199006 + printf ("vax-dec-bsd4.3reno\n"); exit (0); +#else + printf ("vax-dec-bsd\n"); exit (0); +#endif +#endif +#else + printf ("vax-dec-bsd\n"); exit (0); +#endif +#else +#if defined(_SIZE_T_) || defined(SIGLOST) + struct utsname un; + uname (&un); + printf ("vax-dec-ultrix%s\n", un.release); exit (0); +#else + printf ("vax-dec-ultrix\n"); exit (0); +#endif +#endif +#endif +#if defined(ultrix) || defined(_ultrix) || defined(__ultrix) || defined(__ultrix__) +#if defined(mips) || defined(__mips) || defined(__mips__) || defined(MIPS) || defined(__MIPS__) +#if defined(_SIZE_T_) || defined(SIGLOST) + struct utsname *un; + uname (&un); + printf ("mips-dec-ultrix%s\n", un.release); exit (0); +#else + printf ("mips-dec-ultrix\n"); exit (0); +#endif +#endif +#endif + +#if defined (alliant) && defined (i860) + printf ("i860-alliant-bsd\n"); exit (0); +#endif + + exit (1); +} +EOF + +$CC_FOR_BUILD -o "$dummy" "$dummy.c" 2>/dev/null && SYSTEM_NAME=`"$dummy"` && + { echo "$SYSTEM_NAME"; exit; } + +# Apollos put the system type in the environment. +test -d /usr/apollo && { echo "$ISP-apollo-$SYSTYPE"; exit; } + +echo "$0: unable to guess system type" >&2 + +case $UNAME_MACHINE:$UNAME_SYSTEM in + mips:Linux | mips64:Linux) + # If we got here on MIPS GNU/Linux, output extra information. + cat >&2 <&2 <&2 </dev/null || echo unknown` +uname -r = `(uname -r) 2>/dev/null || echo unknown` +uname -s = `(uname -s) 2>/dev/null || echo unknown` +uname -v = `(uname -v) 2>/dev/null || echo unknown` + +/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null` +/bin/uname -X = `(/bin/uname -X) 2>/dev/null` + +hostinfo = `(hostinfo) 2>/dev/null` +/bin/universe = `(/bin/universe) 2>/dev/null` +/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null` +/bin/arch = `(/bin/arch) 2>/dev/null` +/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null` +/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null` + +UNAME_MACHINE = "$UNAME_MACHINE" +UNAME_RELEASE = "$UNAME_RELEASE" +UNAME_SYSTEM = "$UNAME_SYSTEM" +UNAME_VERSION = "$UNAME_VERSION" +EOF +fi + +exit 1 + +# Local variables: +# eval: (add-hook 'before-save-hook 'time-stamp) +# time-stamp-start: "timestamp='" +# time-stamp-format: "%:y-%02m-%02d" +# time-stamp-end: "'" +# End: diff --git a/Packages/asio-1.36.0/config.sub b/Packages/asio-1.36.0/config.sub new file mode 100644 index 0000000..2c6a07a --- /dev/null +++ b/Packages/asio-1.36.0/config.sub @@ -0,0 +1,1971 @@ +#! /bin/sh +# Configuration validation subroutine script. +# Copyright 1992-2024 Free Software Foundation, Inc. + +# shellcheck disable=SC2006,SC2268 # see below for rationale + +timestamp='2024-01-01' + +# This file is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, see . +# +# As a special exception to the GNU General Public License, if you +# distribute this file as part of a program that contains a +# configuration script generated by Autoconf, you may include it under +# the same distribution terms that you use for the rest of that +# program. This Exception is an additional permission under section 7 +# of the GNU General Public License, version 3 ("GPLv3"). + + +# Please send patches to . +# +# Configuration subroutine to validate and canonicalize a configuration type. +# Supply the specified configuration type as an argument. +# If it is invalid, we print an error message on stderr and exit with code 1. +# Otherwise, we print the canonical config type on stdout and succeed. + +# You can get the latest version of this script from: +# https://git.savannah.gnu.org/cgit/config.git/plain/config.sub + +# This file is supposed to be the same for all GNU packages +# and recognize all the CPU types, system types and aliases +# that are meaningful with *any* GNU software. +# Each package is responsible for reporting which valid configurations +# it does not support. The user should be able to distinguish +# a failure to support a valid configuration from a meaningless +# configuration. + +# The goal of this file is to map all the various variations of a given +# machine specification into a single specification in the form: +# CPU_TYPE-MANUFACTURER-OPERATING_SYSTEM +# or in some cases, the newer four-part form: +# CPU_TYPE-MANUFACTURER-KERNEL-OPERATING_SYSTEM +# It is wrong to echo any other type of specification. + +# The "shellcheck disable" line above the timestamp inhibits complaints +# about features and limitations of the classic Bourne shell that were +# superseded or lifted in POSIX. However, this script identifies a wide +# variety of pre-POSIX systems that do not have POSIX shells at all, and +# even some reasonably current systems (Solaris 10 as case-in-point) still +# have a pre-POSIX /bin/sh. + +me=`echo "$0" | sed -e 's,.*/,,'` + +usage="\ +Usage: $0 [OPTION] CPU-MFR-OPSYS or ALIAS + +Canonicalize a configuration name. + +Options: + -h, --help print this help, then exit + -t, --time-stamp print date of last modification, then exit + -v, --version print version number, then exit + +Report bugs and patches to ." + +version="\ +GNU config.sub ($timestamp) + +Copyright 1992-2024 Free Software Foundation, Inc. + +This is free software; see the source for copying conditions. There is NO +warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." + +help=" +Try '$me --help' for more information." + +# Parse command line +while test $# -gt 0 ; do + case $1 in + --time-stamp | --time* | -t ) + echo "$timestamp" ; exit ;; + --version | -v ) + echo "$version" ; exit ;; + --help | --h* | -h ) + echo "$usage"; exit ;; + -- ) # Stop option processing + shift; break ;; + - ) # Use stdin as input. + break ;; + -* ) + echo "$me: invalid option $1$help" >&2 + exit 1 ;; + + *local*) + # First pass through any local machine types. + echo "$1" + exit ;; + + * ) + break ;; + esac +done + +case $# in + 0) echo "$me: missing argument$help" >&2 + exit 1;; + 1) ;; + *) echo "$me: too many arguments$help" >&2 + exit 1;; +esac + +# Split fields of configuration type +# shellcheck disable=SC2162 +saved_IFS=$IFS +IFS="-" read field1 field2 field3 field4 <&2 + exit 1 + ;; + *-*-*-*) + basic_machine=$field1-$field2 + basic_os=$field3-$field4 + ;; + *-*-*) + # Ambiguous whether COMPANY is present, or skipped and KERNEL-OS is two + # parts + maybe_os=$field2-$field3 + case $maybe_os in + nto-qnx* | linux-* | uclinux-uclibc* \ + | uclinux-gnu* | kfreebsd*-gnu* | knetbsd*-gnu* | netbsd*-gnu* \ + | netbsd*-eabi* | kopensolaris*-gnu* | cloudabi*-eabi* \ + | storm-chaos* | os2-emx* | rtmk-nova* | managarm-* \ + | windows-* ) + basic_machine=$field1 + basic_os=$maybe_os + ;; + android-linux) + basic_machine=$field1-unknown + basic_os=linux-android + ;; + *) + basic_machine=$field1-$field2 + basic_os=$field3 + ;; + esac + ;; + *-*) + # A lone config we happen to match not fitting any pattern + case $field1-$field2 in + decstation-3100) + basic_machine=mips-dec + basic_os= + ;; + *-*) + # Second component is usually, but not always the OS + case $field2 in + # Prevent following clause from handling this valid os + sun*os*) + basic_machine=$field1 + basic_os=$field2 + ;; + zephyr*) + basic_machine=$field1-unknown + basic_os=$field2 + ;; + # Manufacturers + dec* | mips* | sequent* | encore* | pc533* | sgi* | sony* \ + | att* | 7300* | 3300* | delta* | motorola* | sun[234]* \ + | unicom* | ibm* | next | hp | isi* | apollo | altos* \ + | convergent* | ncr* | news | 32* | 3600* | 3100* \ + | hitachi* | c[123]* | convex* | sun | crds | omron* | dg \ + | ultra | tti* | harris | dolphin | highlevel | gould \ + | cbm | ns | masscomp | apple | axis | knuth | cray \ + | microblaze* | sim | cisco \ + | oki | wec | wrs | winbond) + basic_machine=$field1-$field2 + basic_os= + ;; + *) + basic_machine=$field1 + basic_os=$field2 + ;; + esac + ;; + esac + ;; + *) + # Convert single-component short-hands not valid as part of + # multi-component configurations. + case $field1 in + 386bsd) + basic_machine=i386-pc + basic_os=bsd + ;; + a29khif) + basic_machine=a29k-amd + basic_os=udi + ;; + adobe68k) + basic_machine=m68010-adobe + basic_os=scout + ;; + alliant) + basic_machine=fx80-alliant + basic_os= + ;; + altos | altos3068) + basic_machine=m68k-altos + basic_os= + ;; + am29k) + basic_machine=a29k-none + basic_os=bsd + ;; + amdahl) + basic_machine=580-amdahl + basic_os=sysv + ;; + amiga) + basic_machine=m68k-unknown + basic_os= + ;; + amigaos | amigados) + basic_machine=m68k-unknown + basic_os=amigaos + ;; + amigaunix | amix) + basic_machine=m68k-unknown + basic_os=sysv4 + ;; + apollo68) + basic_machine=m68k-apollo + basic_os=sysv + ;; + apollo68bsd) + basic_machine=m68k-apollo + basic_os=bsd + ;; + aros) + basic_machine=i386-pc + basic_os=aros + ;; + aux) + basic_machine=m68k-apple + basic_os=aux + ;; + balance) + basic_machine=ns32k-sequent + basic_os=dynix + ;; + blackfin) + basic_machine=bfin-unknown + basic_os=linux + ;; + cegcc) + basic_machine=arm-unknown + basic_os=cegcc + ;; + convex-c1) + basic_machine=c1-convex + basic_os=bsd + ;; + convex-c2) + basic_machine=c2-convex + basic_os=bsd + ;; + convex-c32) + basic_machine=c32-convex + basic_os=bsd + ;; + convex-c34) + basic_machine=c34-convex + basic_os=bsd + ;; + convex-c38) + basic_machine=c38-convex + basic_os=bsd + ;; + cray) + basic_machine=j90-cray + basic_os=unicos + ;; + crds | unos) + basic_machine=m68k-crds + basic_os= + ;; + da30) + basic_machine=m68k-da30 + basic_os= + ;; + decstation | pmax | pmin | dec3100 | decstatn) + basic_machine=mips-dec + basic_os= + ;; + delta88) + basic_machine=m88k-motorola + basic_os=sysv3 + ;; + dicos) + basic_machine=i686-pc + basic_os=dicos + ;; + djgpp) + basic_machine=i586-pc + basic_os=msdosdjgpp + ;; + ebmon29k) + basic_machine=a29k-amd + basic_os=ebmon + ;; + es1800 | OSE68k | ose68k | ose | OSE) + basic_machine=m68k-ericsson + basic_os=ose + ;; + gmicro) + basic_machine=tron-gmicro + basic_os=sysv + ;; + go32) + basic_machine=i386-pc + basic_os=go32 + ;; + h8300hms) + basic_machine=h8300-hitachi + basic_os=hms + ;; + h8300xray) + basic_machine=h8300-hitachi + basic_os=xray + ;; + h8500hms) + basic_machine=h8500-hitachi + basic_os=hms + ;; + harris) + basic_machine=m88k-harris + basic_os=sysv3 + ;; + hp300 | hp300hpux) + basic_machine=m68k-hp + basic_os=hpux + ;; + hp300bsd) + basic_machine=m68k-hp + basic_os=bsd + ;; + hppaosf) + basic_machine=hppa1.1-hp + basic_os=osf + ;; + hppro) + basic_machine=hppa1.1-hp + basic_os=proelf + ;; + i386mach) + basic_machine=i386-mach + basic_os=mach + ;; + isi68 | isi) + basic_machine=m68k-isi + basic_os=sysv + ;; + m68knommu) + basic_machine=m68k-unknown + basic_os=linux + ;; + magnum | m3230) + basic_machine=mips-mips + basic_os=sysv + ;; + merlin) + basic_machine=ns32k-utek + basic_os=sysv + ;; + mingw64) + basic_machine=x86_64-pc + basic_os=mingw64 + ;; + mingw32) + basic_machine=i686-pc + basic_os=mingw32 + ;; + mingw32ce) + basic_machine=arm-unknown + basic_os=mingw32ce + ;; + monitor) + basic_machine=m68k-rom68k + basic_os=coff + ;; + morphos) + basic_machine=powerpc-unknown + basic_os=morphos + ;; + moxiebox) + basic_machine=moxie-unknown + basic_os=moxiebox + ;; + msdos) + basic_machine=i386-pc + basic_os=msdos + ;; + msys) + basic_machine=i686-pc + basic_os=msys + ;; + mvs) + basic_machine=i370-ibm + basic_os=mvs + ;; + nacl) + basic_machine=le32-unknown + basic_os=nacl + ;; + ncr3000) + basic_machine=i486-ncr + basic_os=sysv4 + ;; + netbsd386) + basic_machine=i386-pc + basic_os=netbsd + ;; + netwinder) + basic_machine=armv4l-rebel + basic_os=linux + ;; + news | news700 | news800 | news900) + basic_machine=m68k-sony + basic_os=newsos + ;; + news1000) + basic_machine=m68030-sony + basic_os=newsos + ;; + necv70) + basic_machine=v70-nec + basic_os=sysv + ;; + nh3000) + basic_machine=m68k-harris + basic_os=cxux + ;; + nh[45]000) + basic_machine=m88k-harris + basic_os=cxux + ;; + nindy960) + basic_machine=i960-intel + basic_os=nindy + ;; + mon960) + basic_machine=i960-intel + basic_os=mon960 + ;; + nonstopux) + basic_machine=mips-compaq + basic_os=nonstopux + ;; + os400) + basic_machine=powerpc-ibm + basic_os=os400 + ;; + OSE68000 | ose68000) + basic_machine=m68000-ericsson + basic_os=ose + ;; + os68k) + basic_machine=m68k-none + basic_os=os68k + ;; + paragon) + basic_machine=i860-intel + basic_os=osf + ;; + parisc) + basic_machine=hppa-unknown + basic_os=linux + ;; + psp) + basic_machine=mipsallegrexel-sony + basic_os=psp + ;; + pw32) + basic_machine=i586-unknown + basic_os=pw32 + ;; + rdos | rdos64) + basic_machine=x86_64-pc + basic_os=rdos + ;; + rdos32) + basic_machine=i386-pc + basic_os=rdos + ;; + rom68k) + basic_machine=m68k-rom68k + basic_os=coff + ;; + sa29200) + basic_machine=a29k-amd + basic_os=udi + ;; + sei) + basic_machine=mips-sei + basic_os=seiux + ;; + sequent) + basic_machine=i386-sequent + basic_os= + ;; + sps7) + basic_machine=m68k-bull + basic_os=sysv2 + ;; + st2000) + basic_machine=m68k-tandem + basic_os= + ;; + stratus) + basic_machine=i860-stratus + basic_os=sysv4 + ;; + sun2) + basic_machine=m68000-sun + basic_os= + ;; + sun2os3) + basic_machine=m68000-sun + basic_os=sunos3 + ;; + sun2os4) + basic_machine=m68000-sun + basic_os=sunos4 + ;; + sun3) + basic_machine=m68k-sun + basic_os= + ;; + sun3os3) + basic_machine=m68k-sun + basic_os=sunos3 + ;; + sun3os4) + basic_machine=m68k-sun + basic_os=sunos4 + ;; + sun4) + basic_machine=sparc-sun + basic_os= + ;; + sun4os3) + basic_machine=sparc-sun + basic_os=sunos3 + ;; + sun4os4) + basic_machine=sparc-sun + basic_os=sunos4 + ;; + sun4sol2) + basic_machine=sparc-sun + basic_os=solaris2 + ;; + sun386 | sun386i | roadrunner) + basic_machine=i386-sun + basic_os= + ;; + sv1) + basic_machine=sv1-cray + basic_os=unicos + ;; + symmetry) + basic_machine=i386-sequent + basic_os=dynix + ;; + t3e) + basic_machine=alphaev5-cray + basic_os=unicos + ;; + t90) + basic_machine=t90-cray + basic_os=unicos + ;; + toad1) + basic_machine=pdp10-xkl + basic_os=tops20 + ;; + tpf) + basic_machine=s390x-ibm + basic_os=tpf + ;; + udi29k) + basic_machine=a29k-amd + basic_os=udi + ;; + ultra3) + basic_machine=a29k-nyu + basic_os=sym1 + ;; + v810 | necv810) + basic_machine=v810-nec + basic_os=none + ;; + vaxv) + basic_machine=vax-dec + basic_os=sysv + ;; + vms) + basic_machine=vax-dec + basic_os=vms + ;; + vsta) + basic_machine=i386-pc + basic_os=vsta + ;; + vxworks960) + basic_machine=i960-wrs + basic_os=vxworks + ;; + vxworks68) + basic_machine=m68k-wrs + basic_os=vxworks + ;; + vxworks29k) + basic_machine=a29k-wrs + basic_os=vxworks + ;; + xbox) + basic_machine=i686-pc + basic_os=mingw32 + ;; + ymp) + basic_machine=ymp-cray + basic_os=unicos + ;; + *) + basic_machine=$1 + basic_os= + ;; + esac + ;; +esac + +# Decode 1-component or ad-hoc basic machines +case $basic_machine in + # Here we handle the default manufacturer of certain CPU types. It is in + # some cases the only manufacturer, in others, it is the most popular. + w89k) + cpu=hppa1.1 + vendor=winbond + ;; + op50n) + cpu=hppa1.1 + vendor=oki + ;; + op60c) + cpu=hppa1.1 + vendor=oki + ;; + ibm*) + cpu=i370 + vendor=ibm + ;; + orion105) + cpu=clipper + vendor=highlevel + ;; + mac | mpw | mac-mpw) + cpu=m68k + vendor=apple + ;; + pmac | pmac-mpw) + cpu=powerpc + vendor=apple + ;; + + # Recognize the various machine names and aliases which stand + # for a CPU type and a company and sometimes even an OS. + 3b1 | 7300 | 7300-att | att-7300 | pc7300 | safari | unixpc) + cpu=m68000 + vendor=att + ;; + 3b*) + cpu=we32k + vendor=att + ;; + bluegene*) + cpu=powerpc + vendor=ibm + basic_os=cnk + ;; + decsystem10* | dec10*) + cpu=pdp10 + vendor=dec + basic_os=tops10 + ;; + decsystem20* | dec20*) + cpu=pdp10 + vendor=dec + basic_os=tops20 + ;; + delta | 3300 | motorola-3300 | motorola-delta \ + | 3300-motorola | delta-motorola) + cpu=m68k + vendor=motorola + ;; + dpx2*) + cpu=m68k + vendor=bull + basic_os=sysv3 + ;; + encore | umax | mmax) + cpu=ns32k + vendor=encore + ;; + elxsi) + cpu=elxsi + vendor=elxsi + basic_os=${basic_os:-bsd} + ;; + fx2800) + cpu=i860 + vendor=alliant + ;; + genix) + cpu=ns32k + vendor=ns + ;; + h3050r* | hiux*) + cpu=hppa1.1 + vendor=hitachi + basic_os=hiuxwe2 + ;; + hp3k9[0-9][0-9] | hp9[0-9][0-9]) + cpu=hppa1.0 + vendor=hp + ;; + hp9k2[0-9][0-9] | hp9k31[0-9]) + cpu=m68000 + vendor=hp + ;; + hp9k3[2-9][0-9]) + cpu=m68k + vendor=hp + ;; + hp9k6[0-9][0-9] | hp6[0-9][0-9]) + cpu=hppa1.0 + vendor=hp + ;; + hp9k7[0-79][0-9] | hp7[0-79][0-9]) + cpu=hppa1.1 + vendor=hp + ;; + hp9k78[0-9] | hp78[0-9]) + # FIXME: really hppa2.0-hp + cpu=hppa1.1 + vendor=hp + ;; + hp9k8[67]1 | hp8[67]1 | hp9k80[24] | hp80[24] | hp9k8[78]9 | hp8[78]9 | hp9k893 | hp893) + # FIXME: really hppa2.0-hp + cpu=hppa1.1 + vendor=hp + ;; + hp9k8[0-9][13679] | hp8[0-9][13679]) + cpu=hppa1.1 + vendor=hp + ;; + hp9k8[0-9][0-9] | hp8[0-9][0-9]) + cpu=hppa1.0 + vendor=hp + ;; + i*86v32) + cpu=`echo "$1" | sed -e 's/86.*/86/'` + vendor=pc + basic_os=sysv32 + ;; + i*86v4*) + cpu=`echo "$1" | sed -e 's/86.*/86/'` + vendor=pc + basic_os=sysv4 + ;; + i*86v) + cpu=`echo "$1" | sed -e 's/86.*/86/'` + vendor=pc + basic_os=sysv + ;; + i*86sol2) + cpu=`echo "$1" | sed -e 's/86.*/86/'` + vendor=pc + basic_os=solaris2 + ;; + j90 | j90-cray) + cpu=j90 + vendor=cray + basic_os=${basic_os:-unicos} + ;; + iris | iris4d) + cpu=mips + vendor=sgi + case $basic_os in + irix*) + ;; + *) + basic_os=irix4 + ;; + esac + ;; + miniframe) + cpu=m68000 + vendor=convergent + ;; + *mint | mint[0-9]* | *MiNT | *MiNT[0-9]*) + cpu=m68k + vendor=atari + basic_os=mint + ;; + news-3600 | risc-news) + cpu=mips + vendor=sony + basic_os=newsos + ;; + next | m*-next) + cpu=m68k + vendor=next + case $basic_os in + openstep*) + ;; + nextstep*) + ;; + ns2*) + basic_os=nextstep2 + ;; + *) + basic_os=nextstep3 + ;; + esac + ;; + np1) + cpu=np1 + vendor=gould + ;; + op50n-* | op60c-*) + cpu=hppa1.1 + vendor=oki + basic_os=proelf + ;; + pa-hitachi) + cpu=hppa1.1 + vendor=hitachi + basic_os=hiuxwe2 + ;; + pbd) + cpu=sparc + vendor=tti + ;; + pbb) + cpu=m68k + vendor=tti + ;; + pc532) + cpu=ns32k + vendor=pc532 + ;; + pn) + cpu=pn + vendor=gould + ;; + power) + cpu=power + vendor=ibm + ;; + ps2) + cpu=i386 + vendor=ibm + ;; + rm[46]00) + cpu=mips + vendor=siemens + ;; + rtpc | rtpc-*) + cpu=romp + vendor=ibm + ;; + sde) + cpu=mipsisa32 + vendor=sde + basic_os=${basic_os:-elf} + ;; + simso-wrs) + cpu=sparclite + vendor=wrs + basic_os=vxworks + ;; + tower | tower-32) + cpu=m68k + vendor=ncr + ;; + vpp*|vx|vx-*) + cpu=f301 + vendor=fujitsu + ;; + w65) + cpu=w65 + vendor=wdc + ;; + w89k-*) + cpu=hppa1.1 + vendor=winbond + basic_os=proelf + ;; + none) + cpu=none + vendor=none + ;; + leon|leon[3-9]) + cpu=sparc + vendor=$basic_machine + ;; + leon-*|leon[3-9]-*) + cpu=sparc + vendor=`echo "$basic_machine" | sed 's/-.*//'` + ;; + + *-*) + # shellcheck disable=SC2162 + saved_IFS=$IFS + IFS="-" read cpu vendor <&2 + exit 1 + ;; + esac + ;; +esac + +# Here we canonicalize certain aliases for manufacturers. +case $vendor in + digital*) + vendor=dec + ;; + commodore*) + vendor=cbm + ;; + *) + ;; +esac + +# Decode manufacturer-specific aliases for certain operating systems. + +if test x"$basic_os" != x +then + +# First recognize some ad-hoc cases, or perhaps split kernel-os, or else just +# set os. +obj= +case $basic_os in + gnu/linux*) + kernel=linux + os=`echo "$basic_os" | sed -e 's|gnu/linux|gnu|'` + ;; + os2-emx) + kernel=os2 + os=`echo "$basic_os" | sed -e 's|os2-emx|emx|'` + ;; + nto-qnx*) + kernel=nto + os=`echo "$basic_os" | sed -e 's|nto-qnx|qnx|'` + ;; + *-*) + # shellcheck disable=SC2162 + saved_IFS=$IFS + IFS="-" read kernel os <&2 + fi + ;; + *) + echo "Invalid configuration '$1': OS '$os' not recognized" 1>&2 + exit 1 + ;; +esac + +case $obj in + aout* | coff* | elf* | pe*) + ;; + '') + # empty is fine + ;; + *) + echo "Invalid configuration '$1': Machine code format '$obj' not recognized" 1>&2 + exit 1 + ;; +esac + +# Here we handle the constraint that a (synthetic) cpu and os are +# valid only in combination with each other and nowhere else. +case $cpu-$os in + # The "javascript-unknown-ghcjs" triple is used by GHC; we + # accept it here in order to tolerate that, but reject any + # variations. + javascript-ghcjs) + ;; + javascript-* | *-ghcjs) + echo "Invalid configuration '$1': cpu '$cpu' is not valid with os '$os$obj'" 1>&2 + exit 1 + ;; +esac + +# As a final step for OS-related things, validate the OS-kernel combination +# (given a valid OS), if there is a kernel. +case $kernel-$os-$obj in + linux-gnu*- | linux-android*- | linux-dietlibc*- | linux-llvm*- \ + | linux-mlibc*- | linux-musl*- | linux-newlib*- \ + | linux-relibc*- | linux-uclibc*- ) + ;; + uclinux-uclibc*- ) + ;; + managarm-mlibc*- | managarm-kernel*- ) + ;; + windows*-msvc*-) + ;; + -dietlibc*- | -llvm*- | -mlibc*- | -musl*- | -newlib*- | -relibc*- \ + | -uclibc*- ) + # These are just libc implementations, not actual OSes, and thus + # require a kernel. + echo "Invalid configuration '$1': libc '$os' needs explicit kernel." 1>&2 + exit 1 + ;; + -kernel*- ) + echo "Invalid configuration '$1': '$os' needs explicit kernel." 1>&2 + exit 1 + ;; + *-kernel*- ) + echo "Invalid configuration '$1': '$kernel' does not support '$os'." 1>&2 + exit 1 + ;; + *-msvc*- ) + echo "Invalid configuration '$1': '$os' needs 'windows'." 1>&2 + exit 1 + ;; + kfreebsd*-gnu*- | kopensolaris*-gnu*-) + ;; + vxworks-simlinux- | vxworks-simwindows- | vxworks-spe-) + ;; + nto-qnx*-) + ;; + os2-emx-) + ;; + *-eabi*- | *-gnueabi*-) + ;; + none--*) + # None (no kernel, i.e. freestanding / bare metal), + # can be paired with an machine code file format + ;; + -*-) + # Blank kernel with real OS is always fine. + ;; + --*) + # Blank kernel and OS with real machine code file format is always fine. + ;; + *-*-*) + echo "Invalid configuration '$1': Kernel '$kernel' not known to work with OS '$os'." 1>&2 + exit 1 + ;; +esac + +# Here we handle the case where we know the os, and the CPU type, but not the +# manufacturer. We pick the logical manufacturer. +case $vendor in + unknown) + case $cpu-$os in + *-riscix*) + vendor=acorn + ;; + *-sunos*) + vendor=sun + ;; + *-cnk* | *-aix*) + vendor=ibm + ;; + *-beos*) + vendor=be + ;; + *-hpux*) + vendor=hp + ;; + *-mpeix*) + vendor=hp + ;; + *-hiux*) + vendor=hitachi + ;; + *-unos*) + vendor=crds + ;; + *-dgux*) + vendor=dg + ;; + *-luna*) + vendor=omron + ;; + *-genix*) + vendor=ns + ;; + *-clix*) + vendor=intergraph + ;; + *-mvs* | *-opened*) + vendor=ibm + ;; + *-os400*) + vendor=ibm + ;; + s390-* | s390x-*) + vendor=ibm + ;; + *-ptx*) + vendor=sequent + ;; + *-tpf*) + vendor=ibm + ;; + *-vxsim* | *-vxworks* | *-windiss*) + vendor=wrs + ;; + *-aux*) + vendor=apple + ;; + *-hms*) + vendor=hitachi + ;; + *-mpw* | *-macos*) + vendor=apple + ;; + *-*mint | *-mint[0-9]* | *-*MiNT | *-MiNT[0-9]*) + vendor=atari + ;; + *-vos*) + vendor=stratus + ;; + esac + ;; +esac + +echo "$cpu-$vendor${kernel:+-$kernel}${os:+-$os}${obj:+-$obj}" +exit + +# Local variables: +# eval: (add-hook 'before-save-hook 'time-stamp) +# time-stamp-start: "timestamp='" +# time-stamp-format: "%:y-%02m-%02d" +# time-stamp-end: "'" +# End: diff --git a/Packages/asio-1.36.0/configure b/Packages/asio-1.36.0/configure new file mode 100644 index 0000000..cbe08d2 --- /dev/null +++ b/Packages/asio-1.36.0/configure @@ -0,0 +1,7352 @@ +#! /bin/sh +# Guess values for system-dependent variables and create Makefiles. +# Generated by GNU Autoconf 2.72 for asio 1.36.0. +# +# +# Copyright (C) 1992-1996, 1998-2017, 2020-2023 Free Software Foundation, +# Inc. +# +# +# This configure script is free software; the Free Software Foundation +# gives unlimited permission to copy, distribute and modify it. +## -------------------- ## +## M4sh Initialization. ## +## -------------------- ## + +# Be more Bourne compatible +DUALCASE=1; export DUALCASE # for MKS sh +if test ${ZSH_VERSION+y} && (emulate sh) >/dev/null 2>&1 +then : + emulate sh + NULLCMD=: + # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which + # is contrary to our usage. Disable this feature. + alias -g '${1+"$@"}'='"$@"' + setopt NO_GLOB_SUBST +else case e in #( + e) case `(set -o) 2>/dev/null` in #( + *posix*) : + set -o posix ;; #( + *) : + ;; +esac ;; +esac +fi + + + +# Reset variables that may have inherited troublesome values from +# the environment. + +# IFS needs to be set, to space, tab, and newline, in precisely that order. +# (If _AS_PATH_WALK were called with IFS unset, it would have the +# side effect of setting IFS to empty, thus disabling word splitting.) +# Quoting is to prevent editors from complaining about space-tab. +as_nl=' +' +export as_nl +IFS=" "" $as_nl" + +PS1='$ ' +PS2='> ' +PS4='+ ' + +# Ensure predictable behavior from utilities with locale-dependent output. +LC_ALL=C +export LC_ALL +LANGUAGE=C +export LANGUAGE + +# We cannot yet rely on "unset" to work, but we need these variables +# to be unset--not just set to an empty or harmless value--now, to +# avoid bugs in old shells (e.g. pre-3.0 UWIN ksh). This construct +# also avoids known problems related to "unset" and subshell syntax +# in other old shells (e.g. bash 2.01 and pdksh 5.2.14). +for as_var in BASH_ENV ENV MAIL MAILPATH CDPATH +do eval test \${$as_var+y} \ + && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : +done + +# Ensure that fds 0, 1, and 2 are open. +if (exec 3>&0) 2>/dev/null; then :; else exec 0&1) 2>/dev/null; then :; else exec 1>/dev/null; fi +if (exec 3>&2) ; then :; else exec 2>/dev/null; fi + +# The user is always right. +if ${PATH_SEPARATOR+false} :; then + PATH_SEPARATOR=: + (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { + (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || + PATH_SEPARATOR=';' + } +fi + + +# Find who we are. Look in the path if we contain no directory separator. +as_myself= +case $0 in #(( + *[\\/]* ) as_myself=$0 ;; + *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + test -r "$as_dir$0" && as_myself=$as_dir$0 && break + done +IFS=$as_save_IFS + + ;; +esac +# We did not find ourselves, most probably we were run as 'sh COMMAND' +# in which case we are not to be found in the path. +if test "x$as_myself" = x; then + as_myself=$0 +fi +if test ! -f "$as_myself"; then + printf "%s\n" "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 + exit 1 +fi + + +# Use a proper internal environment variable to ensure we don't fall + # into an infinite loop, continuously re-executing ourselves. + if test x"${_as_can_reexec}" != xno && test "x$CONFIG_SHELL" != x; then + _as_can_reexec=no; export _as_can_reexec; + # We cannot yet assume a decent shell, so we have to provide a +# neutralization value for shells without unset; and this also +# works around shells that cannot unset nonexistent variables. +# Preserve -v and -x to the replacement shell. +BASH_ENV=/dev/null +ENV=/dev/null +(unset BASH_ENV) >/dev/null 2>&1 && unset BASH_ENV ENV +case $- in # (((( + *v*x* | *x*v* ) as_opts=-vx ;; + *v* ) as_opts=-v ;; + *x* ) as_opts=-x ;; + * ) as_opts= ;; +esac +exec $CONFIG_SHELL $as_opts "$as_myself" ${1+"$@"} +# Admittedly, this is quite paranoid, since all the known shells bail +# out after a failed 'exec'. +printf "%s\n" "$0: could not re-execute with $CONFIG_SHELL" >&2 +exit 255 + fi + # We don't want this to propagate to other subprocesses. + { _as_can_reexec=; unset _as_can_reexec;} +if test "x$CONFIG_SHELL" = x; then + as_bourne_compatible="if test \${ZSH_VERSION+y} && (emulate sh) >/dev/null 2>&1 +then : + emulate sh + NULLCMD=: + # Pre-4.2 versions of Zsh do word splitting on \${1+\"\$@\"}, which + # is contrary to our usage. Disable this feature. + alias -g '\${1+\"\$@\"}'='\"\$@\"' + setopt NO_GLOB_SUBST +else case e in #( + e) case \`(set -o) 2>/dev/null\` in #( + *posix*) : + set -o posix ;; #( + *) : + ;; +esac ;; +esac +fi +" + as_required="as_fn_return () { (exit \$1); } +as_fn_success () { as_fn_return 0; } +as_fn_failure () { as_fn_return 1; } +as_fn_ret_success () { return 0; } +as_fn_ret_failure () { return 1; } + +exitcode=0 +as_fn_success || { exitcode=1; echo as_fn_success failed.; } +as_fn_failure && { exitcode=1; echo as_fn_failure succeeded.; } +as_fn_ret_success || { exitcode=1; echo as_fn_ret_success failed.; } +as_fn_ret_failure && { exitcode=1; echo as_fn_ret_failure succeeded.; } +if ( set x; as_fn_ret_success y && test x = \"\$1\" ) +then : + +else case e in #( + e) exitcode=1; echo positional parameters were not saved. ;; +esac +fi +test x\$exitcode = x0 || exit 1 +blah=\$(echo \$(echo blah)) +test x\"\$blah\" = xblah || exit 1 +test -x / || exit 1" + as_suggested=" as_lineno_1=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_1a=\$LINENO + as_lineno_2=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_2a=\$LINENO + eval 'test \"x\$as_lineno_1'\$as_run'\" != \"x\$as_lineno_2'\$as_run'\" && + test \"x\`expr \$as_lineno_1'\$as_run' + 1\`\" = \"x\$as_lineno_2'\$as_run'\"' || exit 1" + if (eval "$as_required") 2>/dev/null +then : + as_have_required=yes +else case e in #( + e) as_have_required=no ;; +esac +fi + if test x$as_have_required = xyes && (eval "$as_suggested") 2>/dev/null +then : + +else case e in #( + e) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +as_found=false +for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + as_found=: + case $as_dir in #( + /*) + for as_base in sh bash ksh sh5; do + # Try only shells that exist, to save several forks. + as_shell=$as_dir$as_base + if { test -f "$as_shell" || test -f "$as_shell.exe"; } && + as_run=a "$as_shell" -c "$as_bourne_compatible""$as_required" 2>/dev/null +then : + CONFIG_SHELL=$as_shell as_have_required=yes + if as_run=a "$as_shell" -c "$as_bourne_compatible""$as_suggested" 2>/dev/null +then : + break 2 +fi +fi + done;; + esac + as_found=false +done +IFS=$as_save_IFS +if $as_found +then : + +else case e in #( + e) if { test -f "$SHELL" || test -f "$SHELL.exe"; } && + as_run=a "$SHELL" -c "$as_bourne_compatible""$as_required" 2>/dev/null +then : + CONFIG_SHELL=$SHELL as_have_required=yes +fi ;; +esac +fi + + + if test "x$CONFIG_SHELL" != x +then : + export CONFIG_SHELL + # We cannot yet assume a decent shell, so we have to provide a +# neutralization value for shells without unset; and this also +# works around shells that cannot unset nonexistent variables. +# Preserve -v and -x to the replacement shell. +BASH_ENV=/dev/null +ENV=/dev/null +(unset BASH_ENV) >/dev/null 2>&1 && unset BASH_ENV ENV +case $- in # (((( + *v*x* | *x*v* ) as_opts=-vx ;; + *v* ) as_opts=-v ;; + *x* ) as_opts=-x ;; + * ) as_opts= ;; +esac +exec $CONFIG_SHELL $as_opts "$as_myself" ${1+"$@"} +# Admittedly, this is quite paranoid, since all the known shells bail +# out after a failed 'exec'. +printf "%s\n" "$0: could not re-execute with $CONFIG_SHELL" >&2 +exit 255 +fi + + if test x$as_have_required = xno +then : + printf "%s\n" "$0: This script requires a shell more modern than all" + printf "%s\n" "$0: the shells that I found on your system." + if test ${ZSH_VERSION+y} ; then + printf "%s\n" "$0: In particular, zsh $ZSH_VERSION has bugs and should" + printf "%s\n" "$0: be upgraded to zsh 4.3.4 or later." + else + printf "%s\n" "$0: Please tell bug-autoconf@gnu.org about your system, +$0: including any error possibly output before this +$0: message. Then install a modern shell, or manually run +$0: the script under such a shell if you do have one." + fi + exit 1 +fi ;; +esac +fi +fi +SHELL=${CONFIG_SHELL-/bin/sh} +export SHELL +# Unset more variables known to interfere with behavior of common tools. +CLICOLOR_FORCE= GREP_OPTIONS= +unset CLICOLOR_FORCE GREP_OPTIONS + +## --------------------- ## +## M4sh Shell Functions. ## +## --------------------- ## +# as_fn_unset VAR +# --------------- +# Portably unset VAR. +as_fn_unset () +{ + { eval $1=; unset $1;} +} +as_unset=as_fn_unset + + +# as_fn_set_status STATUS +# ----------------------- +# Set $? to STATUS, without forking. +as_fn_set_status () +{ + return $1 +} # as_fn_set_status + +# as_fn_exit STATUS +# ----------------- +# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. +as_fn_exit () +{ + set +e + as_fn_set_status $1 + exit $1 +} # as_fn_exit + +# as_fn_mkdir_p +# ------------- +# Create "$as_dir" as a directory, including parents if necessary. +as_fn_mkdir_p () +{ + + case $as_dir in #( + -*) as_dir=./$as_dir;; + esac + test -d "$as_dir" || eval $as_mkdir_p || { + as_dirs= + while :; do + case $as_dir in #( + *\'*) as_qdir=`printf "%s\n" "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( + *) as_qdir=$as_dir;; + esac + as_dirs="'$as_qdir' $as_dirs" + as_dir=`$as_dirname -- "$as_dir" || +$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$as_dir" : 'X\(//\)[^/]' \| \ + X"$as_dir" : 'X\(//\)$' \| \ + X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X"$as_dir" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + test -d "$as_dir" && break + done + test -z "$as_dirs" || eval "mkdir $as_dirs" + } || test -d "$as_dir" || as_fn_error $? "cannot create directory $as_dir" + + +} # as_fn_mkdir_p + +# as_fn_executable_p FILE +# ----------------------- +# Test if FILE is an executable regular file. +as_fn_executable_p () +{ + test -f "$1" && test -x "$1" +} # as_fn_executable_p +# as_fn_append VAR VALUE +# ---------------------- +# Append the text in VALUE to the end of the definition contained in VAR. Take +# advantage of any shell optimizations that allow amortized linear growth over +# repeated appends, instead of the typical quadratic growth present in naive +# implementations. +if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null +then : + eval 'as_fn_append () + { + eval $1+=\$2 + }' +else case e in #( + e) as_fn_append () + { + eval $1=\$$1\$2 + } ;; +esac +fi # as_fn_append + +# as_fn_arith ARG... +# ------------------ +# Perform arithmetic evaluation on the ARGs, and store the result in the +# global $as_val. Take advantage of shells that can avoid forks. The arguments +# must be portable across $(()) and expr. +if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null +then : + eval 'as_fn_arith () + { + as_val=$(( $* )) + }' +else case e in #( + e) as_fn_arith () + { + as_val=`expr "$@" || test $? -eq 1` + } ;; +esac +fi # as_fn_arith + + +# as_fn_error STATUS ERROR [LINENO LOG_FD] +# ---------------------------------------- +# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are +# provided, also output the error to LOG_FD, referencing LINENO. Then exit the +# script with STATUS, using 1 if that was 0. +as_fn_error () +{ + as_status=$1; test $as_status -eq 0 && as_status=1 + if test "$4"; then + as_lineno=${as_lineno-"$3"} as_lineno_stack=as_lineno_stack=$as_lineno_stack + printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: $2" >&$4 + fi + printf "%s\n" "$as_me: error: $2" >&2 + as_fn_exit $as_status +} # as_fn_error + +if expr a : '\(a\)' >/dev/null 2>&1 && + test "X`expr 00001 : '.*\(...\)'`" = X001; then + as_expr=expr +else + as_expr=false +fi + +if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then + as_basename=basename +else + as_basename=false +fi + +if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then + as_dirname=dirname +else + as_dirname=false +fi + +as_me=`$as_basename -- "$0" || +$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ + X"$0" : 'X\(//\)$' \| \ + X"$0" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X/"$0" | + sed '/^.*\/\([^/][^/]*\)\/*$/{ + s//\1/ + q + } + /^X\/\(\/\/\)$/{ + s//\1/ + q + } + /^X\/\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + +# Avoid depending upon Character Ranges. +as_cr_letters='abcdefghijklmnopqrstuvwxyz' +as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' +as_cr_Letters=$as_cr_letters$as_cr_LETTERS +as_cr_digits='0123456789' +as_cr_alnum=$as_cr_Letters$as_cr_digits + + + as_lineno_1=$LINENO as_lineno_1a=$LINENO + as_lineno_2=$LINENO as_lineno_2a=$LINENO + eval 'test "x$as_lineno_1'$as_run'" != "x$as_lineno_2'$as_run'" && + test "x`expr $as_lineno_1'$as_run' + 1`" = "x$as_lineno_2'$as_run'"' || { + # Blame Lee E. McMahon (1931-1989) for sed's syntax. :-) + sed -n ' + p + /[$]LINENO/= + ' <$as_myself | + sed ' + t clear + :clear + s/[$]LINENO.*/&-/ + t lineno + b + :lineno + N + :loop + s/[$]LINENO\([^'$as_cr_alnum'_].*\n\)\(.*\)/\2\1\2/ + t loop + s/-\n.*// + ' >$as_me.lineno && + chmod +x "$as_me.lineno" || + { printf "%s\n" "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2; as_fn_exit 1; } + + # If we had to re-execute with $CONFIG_SHELL, we're ensured to have + # already done that, so ensure we don't try to do so again and fall + # in an infinite loop. This has already happened in practice. + _as_can_reexec=no; export _as_can_reexec + # Don't try to exec as it changes $[0], causing all sort of problems + # (the dirname of $[0] is not the place where we might find the + # original and so on. Autoconf is especially sensitive to this). + . "./$as_me.lineno" + # Exit status is that of the last command. + exit +} + + +# Determine whether it's possible to make 'echo' print without a newline. +# These variables are no longer used directly by Autoconf, but are AC_SUBSTed +# for compatibility with existing Makefiles. +ECHO_C= ECHO_N= ECHO_T= +case `echo -n x` in #((((( +-n*) + case `echo 'xy\c'` in + *c*) ECHO_T=' ';; # ECHO_T is single tab character. + xy) ECHO_C='\c';; + *) echo `echo ksh88 bug on AIX 6.1` > /dev/null + ECHO_T=' ';; + esac;; +*) + ECHO_N='-n';; +esac + +# For backward compatibility with old third-party macros, we provide +# the shell variables $as_echo and $as_echo_n. New code should use +# AS_ECHO(["message"]) and AS_ECHO_N(["message"]), respectively. +as_echo='printf %s\n' +as_echo_n='printf %s' + +rm -f conf$$ conf$$.exe conf$$.file +if test -d conf$$.dir; then + rm -f conf$$.dir/conf$$.file +else + rm -f conf$$.dir + mkdir conf$$.dir 2>/dev/null +fi +if (echo >conf$$.file) 2>/dev/null; then + if ln -s conf$$.file conf$$ 2>/dev/null; then + as_ln_s='ln -s' + # ... but there are two gotchas: + # 1) On MSYS, both 'ln -s file dir' and 'ln file dir' fail. + # 2) DJGPP < 2.04 has no symlinks; 'ln -s' creates a wrapper executable. + # In both cases, we have to default to 'cp -pR'. + ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || + as_ln_s='cp -pR' + elif ln conf$$.file conf$$ 2>/dev/null; then + as_ln_s=ln + else + as_ln_s='cp -pR' + fi +else + as_ln_s='cp -pR' +fi +rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file +rmdir conf$$.dir 2>/dev/null + +if mkdir -p . 2>/dev/null; then + as_mkdir_p='mkdir -p "$as_dir"' +else + test -d ./-p && rmdir ./-p + as_mkdir_p=false +fi + +as_test_x='test -x' +as_executable_p=as_fn_executable_p + +# Sed expression to map a string onto a valid CPP name. +as_sed_cpp="y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g" +as_tr_cpp="eval sed '$as_sed_cpp'" # deprecated + +# Sed expression to map a string onto a valid variable name. +as_sed_sh="y%*+%pp%;s%[^_$as_cr_alnum]%_%g" +as_tr_sh="eval sed '$as_sed_sh'" # deprecated + + +test -n "$DJDIR" || exec 7<&0 &1 + +# Name of the host. +# hostname on some systems (SVR3.2, old GNU/Linux) returns a bogus exit status, +# so uname gets run too. +ac_hostname=`(hostname || uname -n) 2>/dev/null | sed 1q` + +# +# Initializations. +# +ac_default_prefix=/usr/local +ac_clean_files= +ac_config_libobj_dir=. +LIBOBJS= +cross_compiling=no +subdirs= +MFLAGS= +MAKEFLAGS= + +# Identity of this package. +PACKAGE_NAME='asio' +PACKAGE_TARNAME='asio' +PACKAGE_VERSION='1.36.0' +PACKAGE_STRING='asio 1.36.0' +PACKAGE_BUGREPORT='' +PACKAGE_URL='' + +ac_unique_file="include/asio.hpp" +# Factoring default headers for most tests. +ac_includes_default="\ +#include +#ifdef HAVE_STDIO_H +# include +#endif +#ifdef HAVE_STDLIB_H +# include +#endif +#ifdef HAVE_STRING_H +# include +#endif +#ifdef HAVE_INTTYPES_H +# include +#endif +#ifdef HAVE_STDINT_H +# include +#endif +#ifdef HAVE_STRINGS_H +# include +#endif +#ifdef HAVE_SYS_TYPES_H +# include +#endif +#ifdef HAVE_SYS_STAT_H +# include +#endif +#ifdef HAVE_UNISTD_H +# include +#endif" + +ac_header_cxx_list= +ac_subst_vars='am__EXEEXT_FALSE +am__EXEEXT_TRUE +LTLIBOBJS +LIBOBJS +HAVE_COROUTINES_FALSE +HAVE_COROUTINES_TRUE +HAVE_CXX20_FALSE +HAVE_CXX20_TRUE +HAVE_CXX17_FALSE +HAVE_CXX17_TRUE +HAVE_CXX14_FALSE +HAVE_CXX14_TRUE +HAVE_CXX11_FALSE +HAVE_CXX11_TRUE +WINDOWS_TARGET_FALSE +WINDOWS_TARGET_TRUE +HAVE_BOOST_COROUTINE_FALSE +HAVE_BOOST_COROUTINE_TRUE +SEPARATE_COMPILATION_FALSE +SEPARATE_COMPILATION_TRUE +STANDALONE_FALSE +STANDALONE_TRUE +HAVE_OPENSSL_FALSE +HAVE_OPENSSL_TRUE +RANLIB +am__fastdepCXX_FALSE +am__fastdepCXX_TRUE +CXXDEPMODE +ac_ct_CXX +CXXFLAGS +CXX +am__fastdepCC_FALSE +am__fastdepCC_TRUE +CCDEPMODE +am__nodep +AMDEPBACKSLASH +AMDEP_FALSE +AMDEP_TRUE +am__include +DEPDIR +OBJEXT +EXEEXT +ac_ct_CC +CPPFLAGS +LDFLAGS +CFLAGS +CC +host_os +host_vendor +host_cpu +host +build_os +build_vendor +build_cpu +build +am__xargs_n +am__rm_f_notfound +AM_BACKSLASH +AM_DEFAULT_VERBOSITY +AM_DEFAULT_V +AM_V +CSCOPE +ETAGS +CTAGS +am__untar +am__tar +AMTAR +am__leading_dot +SET_MAKE +AWK +mkdir_p +MKDIR_P +INSTALL_STRIP_PROGRAM +STRIP +install_sh +MAKEINFO +AUTOHEADER +AUTOMAKE +AUTOCONF +ACLOCAL +VERSION +PACKAGE +CYGPATH_W +am__isrc +INSTALL_DATA +INSTALL_SCRIPT +INSTALL_PROGRAM +MAINT +MAINTAINER_MODE_FALSE +MAINTAINER_MODE_TRUE +target_alias +host_alias +build_alias +LIBS +ECHO_T +ECHO_N +ECHO_C +DEFS +mandir +localedir +libdir +psdir +pdfdir +dvidir +htmldir +infodir +docdir +oldincludedir +includedir +runstatedir +localstatedir +sharedstatedir +sysconfdir +datadir +datarootdir +libexecdir +sbindir +bindir +program_transform_name +prefix +exec_prefix +PACKAGE_URL +PACKAGE_BUGREPORT +PACKAGE_STRING +PACKAGE_VERSION +PACKAGE_TARNAME +PACKAGE_NAME +PATH_SEPARATOR +SHELL +am__quote' +ac_subst_files='' +ac_user_opts=' +enable_option_checking +enable_maintainer_mode +enable_silent_rules +enable_dependency_tracking +with_boost +enable_separate_compilation +enable_boost_coroutine +with_openssl +' + ac_precious_vars='build_alias +host_alias +target_alias +CC +CFLAGS +LDFLAGS +LIBS +CPPFLAGS +CXX +CXXFLAGS +CCC' + + +# Initialize some variables set by options. +ac_init_help= +ac_init_version=false +ac_unrecognized_opts= +ac_unrecognized_sep= +# The variables have the same names as the options, with +# dashes changed to underlines. +cache_file=/dev/null +exec_prefix=NONE +no_create= +no_recursion= +prefix=NONE +program_prefix=NONE +program_suffix=NONE +program_transform_name=s,x,x, +silent= +site= +srcdir= +verbose= +x_includes=NONE +x_libraries=NONE + +# Installation directory options. +# These are left unexpanded so users can "make install exec_prefix=/foo" +# and all the variables that are supposed to be based on exec_prefix +# by default will actually change. +# Use braces instead of parens because sh, perl, etc. also accept them. +# (The list follows the same order as the GNU Coding Standards.) +bindir='${exec_prefix}/bin' +sbindir='${exec_prefix}/sbin' +libexecdir='${exec_prefix}/libexec' +datarootdir='${prefix}/share' +datadir='${datarootdir}' +sysconfdir='${prefix}/etc' +sharedstatedir='${prefix}/com' +localstatedir='${prefix}/var' +runstatedir='${localstatedir}/run' +includedir='${prefix}/include' +oldincludedir='/usr/include' +docdir='${datarootdir}/doc/${PACKAGE_TARNAME}' +infodir='${datarootdir}/info' +htmldir='${docdir}' +dvidir='${docdir}' +pdfdir='${docdir}' +psdir='${docdir}' +libdir='${exec_prefix}/lib' +localedir='${datarootdir}/locale' +mandir='${datarootdir}/man' + +ac_prev= +ac_dashdash= +for ac_option +do + # If the previous option needs an argument, assign it. + if test -n "$ac_prev"; then + eval $ac_prev=\$ac_option + ac_prev= + continue + fi + + case $ac_option in + *=?*) ac_optarg=`expr "X$ac_option" : '[^=]*=\(.*\)'` ;; + *=) ac_optarg= ;; + *) ac_optarg=yes ;; + esac + + case $ac_dashdash$ac_option in + --) + ac_dashdash=yes ;; + + -bindir | --bindir | --bindi | --bind | --bin | --bi) + ac_prev=bindir ;; + -bindir=* | --bindir=* | --bindi=* | --bind=* | --bin=* | --bi=*) + bindir=$ac_optarg ;; + + -build | --build | --buil | --bui | --bu) + ac_prev=build_alias ;; + -build=* | --build=* | --buil=* | --bui=* | --bu=*) + build_alias=$ac_optarg ;; + + -cache-file | --cache-file | --cache-fil | --cache-fi \ + | --cache-f | --cache- | --cache | --cach | --cac | --ca | --c) + ac_prev=cache_file ;; + -cache-file=* | --cache-file=* | --cache-fil=* | --cache-fi=* \ + | --cache-f=* | --cache-=* | --cache=* | --cach=* | --cac=* | --ca=* | --c=*) + cache_file=$ac_optarg ;; + + --config-cache | -C) + cache_file=config.cache ;; + + -datadir | --datadir | --datadi | --datad) + ac_prev=datadir ;; + -datadir=* | --datadir=* | --datadi=* | --datad=*) + datadir=$ac_optarg ;; + + -datarootdir | --datarootdir | --datarootdi | --datarootd | --dataroot \ + | --dataroo | --dataro | --datar) + ac_prev=datarootdir ;; + -datarootdir=* | --datarootdir=* | --datarootdi=* | --datarootd=* \ + | --dataroot=* | --dataroo=* | --dataro=* | --datar=*) + datarootdir=$ac_optarg ;; + + -disable-* | --disable-*) + ac_useropt=`expr "x$ac_option" : 'x-*disable-\(.*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid feature name: '$ac_useropt'" + ac_useropt_orig=$ac_useropt + ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"enable_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--disable-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval enable_$ac_useropt=no ;; + + -docdir | --docdir | --docdi | --doc | --do) + ac_prev=docdir ;; + -docdir=* | --docdir=* | --docdi=* | --doc=* | --do=*) + docdir=$ac_optarg ;; + + -dvidir | --dvidir | --dvidi | --dvid | --dvi | --dv) + ac_prev=dvidir ;; + -dvidir=* | --dvidir=* | --dvidi=* | --dvid=* | --dvi=* | --dv=*) + dvidir=$ac_optarg ;; + + -enable-* | --enable-*) + ac_useropt=`expr "x$ac_option" : 'x-*enable-\([^=]*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid feature name: '$ac_useropt'" + ac_useropt_orig=$ac_useropt + ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"enable_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--enable-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval enable_$ac_useropt=\$ac_optarg ;; + + -exec-prefix | --exec_prefix | --exec-prefix | --exec-prefi \ + | --exec-pref | --exec-pre | --exec-pr | --exec-p | --exec- \ + | --exec | --exe | --ex) + ac_prev=exec_prefix ;; + -exec-prefix=* | --exec_prefix=* | --exec-prefix=* | --exec-prefi=* \ + | --exec-pref=* | --exec-pre=* | --exec-pr=* | --exec-p=* | --exec-=* \ + | --exec=* | --exe=* | --ex=*) + exec_prefix=$ac_optarg ;; + + -gas | --gas | --ga | --g) + # Obsolete; use --with-gas. + with_gas=yes ;; + + -help | --help | --hel | --he | -h) + ac_init_help=long ;; + -help=r* | --help=r* | --hel=r* | --he=r* | -hr*) + ac_init_help=recursive ;; + -help=s* | --help=s* | --hel=s* | --he=s* | -hs*) + ac_init_help=short ;; + + -host | --host | --hos | --ho) + ac_prev=host_alias ;; + -host=* | --host=* | --hos=* | --ho=*) + host_alias=$ac_optarg ;; + + -htmldir | --htmldir | --htmldi | --htmld | --html | --htm | --ht) + ac_prev=htmldir ;; + -htmldir=* | --htmldir=* | --htmldi=* | --htmld=* | --html=* | --htm=* \ + | --ht=*) + htmldir=$ac_optarg ;; + + -includedir | --includedir | --includedi | --included | --include \ + | --includ | --inclu | --incl | --inc) + ac_prev=includedir ;; + -includedir=* | --includedir=* | --includedi=* | --included=* | --include=* \ + | --includ=* | --inclu=* | --incl=* | --inc=*) + includedir=$ac_optarg ;; + + -infodir | --infodir | --infodi | --infod | --info | --inf) + ac_prev=infodir ;; + -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*) + infodir=$ac_optarg ;; + + -libdir | --libdir | --libdi | --libd) + ac_prev=libdir ;; + -libdir=* | --libdir=* | --libdi=* | --libd=*) + libdir=$ac_optarg ;; + + -libexecdir | --libexecdir | --libexecdi | --libexecd | --libexec \ + | --libexe | --libex | --libe) + ac_prev=libexecdir ;; + -libexecdir=* | --libexecdir=* | --libexecdi=* | --libexecd=* | --libexec=* \ + | --libexe=* | --libex=* | --libe=*) + libexecdir=$ac_optarg ;; + + -localedir | --localedir | --localedi | --localed | --locale) + ac_prev=localedir ;; + -localedir=* | --localedir=* | --localedi=* | --localed=* | --locale=*) + localedir=$ac_optarg ;; + + -localstatedir | --localstatedir | --localstatedi | --localstated \ + | --localstate | --localstat | --localsta | --localst | --locals) + ac_prev=localstatedir ;; + -localstatedir=* | --localstatedir=* | --localstatedi=* | --localstated=* \ + | --localstate=* | --localstat=* | --localsta=* | --localst=* | --locals=*) + localstatedir=$ac_optarg ;; + + -mandir | --mandir | --mandi | --mand | --man | --ma | --m) + ac_prev=mandir ;; + -mandir=* | --mandir=* | --mandi=* | --mand=* | --man=* | --ma=* | --m=*) + mandir=$ac_optarg ;; + + -nfp | --nfp | --nf) + # Obsolete; use --without-fp. + with_fp=no ;; + + -no-create | --no-create | --no-creat | --no-crea | --no-cre \ + | --no-cr | --no-c | -n) + no_create=yes ;; + + -no-recursion | --no-recursion | --no-recursio | --no-recursi \ + | --no-recurs | --no-recur | --no-recu | --no-rec | --no-re | --no-r) + no_recursion=yes ;; + + -oldincludedir | --oldincludedir | --oldincludedi | --oldincluded \ + | --oldinclude | --oldinclud | --oldinclu | --oldincl | --oldinc \ + | --oldin | --oldi | --old | --ol | --o) + ac_prev=oldincludedir ;; + -oldincludedir=* | --oldincludedir=* | --oldincludedi=* | --oldincluded=* \ + | --oldinclude=* | --oldinclud=* | --oldinclu=* | --oldincl=* | --oldinc=* \ + | --oldin=* | --oldi=* | --old=* | --ol=* | --o=*) + oldincludedir=$ac_optarg ;; + + -prefix | --prefix | --prefi | --pref | --pre | --pr | --p) + ac_prev=prefix ;; + -prefix=* | --prefix=* | --prefi=* | --pref=* | --pre=* | --pr=* | --p=*) + prefix=$ac_optarg ;; + + -program-prefix | --program-prefix | --program-prefi | --program-pref \ + | --program-pre | --program-pr | --program-p) + ac_prev=program_prefix ;; + -program-prefix=* | --program-prefix=* | --program-prefi=* \ + | --program-pref=* | --program-pre=* | --program-pr=* | --program-p=*) + program_prefix=$ac_optarg ;; + + -program-suffix | --program-suffix | --program-suffi | --program-suff \ + | --program-suf | --program-su | --program-s) + ac_prev=program_suffix ;; + -program-suffix=* | --program-suffix=* | --program-suffi=* \ + | --program-suff=* | --program-suf=* | --program-su=* | --program-s=*) + program_suffix=$ac_optarg ;; + + -program-transform-name | --program-transform-name \ + | --program-transform-nam | --program-transform-na \ + | --program-transform-n | --program-transform- \ + | --program-transform | --program-transfor \ + | --program-transfo | --program-transf \ + | --program-trans | --program-tran \ + | --progr-tra | --program-tr | --program-t) + ac_prev=program_transform_name ;; + -program-transform-name=* | --program-transform-name=* \ + | --program-transform-nam=* | --program-transform-na=* \ + | --program-transform-n=* | --program-transform-=* \ + | --program-transform=* | --program-transfor=* \ + | --program-transfo=* | --program-transf=* \ + | --program-trans=* | --program-tran=* \ + | --progr-tra=* | --program-tr=* | --program-t=*) + program_transform_name=$ac_optarg ;; + + -pdfdir | --pdfdir | --pdfdi | --pdfd | --pdf | --pd) + ac_prev=pdfdir ;; + -pdfdir=* | --pdfdir=* | --pdfdi=* | --pdfd=* | --pdf=* | --pd=*) + pdfdir=$ac_optarg ;; + + -psdir | --psdir | --psdi | --psd | --ps) + ac_prev=psdir ;; + -psdir=* | --psdir=* | --psdi=* | --psd=* | --ps=*) + psdir=$ac_optarg ;; + + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil) + silent=yes ;; + + -runstatedir | --runstatedir | --runstatedi | --runstated \ + | --runstate | --runstat | --runsta | --runst | --runs \ + | --run | --ru | --r) + ac_prev=runstatedir ;; + -runstatedir=* | --runstatedir=* | --runstatedi=* | --runstated=* \ + | --runstate=* | --runstat=* | --runsta=* | --runst=* | --runs=* \ + | --run=* | --ru=* | --r=*) + runstatedir=$ac_optarg ;; + + -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb) + ac_prev=sbindir ;; + -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \ + | --sbi=* | --sb=*) + sbindir=$ac_optarg ;; + + -sharedstatedir | --sharedstatedir | --sharedstatedi \ + | --sharedstated | --sharedstate | --sharedstat | --sharedsta \ + | --sharedst | --shareds | --shared | --share | --shar \ + | --sha | --sh) + ac_prev=sharedstatedir ;; + -sharedstatedir=* | --sharedstatedir=* | --sharedstatedi=* \ + | --sharedstated=* | --sharedstate=* | --sharedstat=* | --sharedsta=* \ + | --sharedst=* | --shareds=* | --shared=* | --share=* | --shar=* \ + | --sha=* | --sh=*) + sharedstatedir=$ac_optarg ;; + + -site | --site | --sit) + ac_prev=site ;; + -site=* | --site=* | --sit=*) + site=$ac_optarg ;; + + -srcdir | --srcdir | --srcdi | --srcd | --src | --sr) + ac_prev=srcdir ;; + -srcdir=* | --srcdir=* | --srcdi=* | --srcd=* | --src=* | --sr=*) + srcdir=$ac_optarg ;; + + -sysconfdir | --sysconfdir | --sysconfdi | --sysconfd | --sysconf \ + | --syscon | --sysco | --sysc | --sys | --sy) + ac_prev=sysconfdir ;; + -sysconfdir=* | --sysconfdir=* | --sysconfdi=* | --sysconfd=* | --sysconf=* \ + | --syscon=* | --sysco=* | --sysc=* | --sys=* | --sy=*) + sysconfdir=$ac_optarg ;; + + -target | --target | --targe | --targ | --tar | --ta | --t) + ac_prev=target_alias ;; + -target=* | --target=* | --targe=* | --targ=* | --tar=* | --ta=* | --t=*) + target_alias=$ac_optarg ;; + + -v | -verbose | --verbose | --verbos | --verbo | --verb) + verbose=yes ;; + + -version | --version | --versio | --versi | --vers | -V) + ac_init_version=: ;; + + -with-* | --with-*) + ac_useropt=`expr "x$ac_option" : 'x-*with-\([^=]*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid package name: '$ac_useropt'" + ac_useropt_orig=$ac_useropt + ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"with_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--with-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval with_$ac_useropt=\$ac_optarg ;; + + -without-* | --without-*) + ac_useropt=`expr "x$ac_option" : 'x-*without-\(.*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid package name: '$ac_useropt'" + ac_useropt_orig=$ac_useropt + ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"with_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--without-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval with_$ac_useropt=no ;; + + --x) + # Obsolete; use --with-x. + with_x=yes ;; + + -x-includes | --x-includes | --x-include | --x-includ | --x-inclu \ + | --x-incl | --x-inc | --x-in | --x-i) + ac_prev=x_includes ;; + -x-includes=* | --x-includes=* | --x-include=* | --x-includ=* | --x-inclu=* \ + | --x-incl=* | --x-inc=* | --x-in=* | --x-i=*) + x_includes=$ac_optarg ;; + + -x-libraries | --x-libraries | --x-librarie | --x-librari \ + | --x-librar | --x-libra | --x-libr | --x-lib | --x-li | --x-l) + ac_prev=x_libraries ;; + -x-libraries=* | --x-libraries=* | --x-librarie=* | --x-librari=* \ + | --x-librar=* | --x-libra=* | --x-libr=* | --x-lib=* | --x-li=* | --x-l=*) + x_libraries=$ac_optarg ;; + + -*) as_fn_error $? "unrecognized option: '$ac_option' +Try '$0 --help' for more information" + ;; + + *=*) + ac_envvar=`expr "x$ac_option" : 'x\([^=]*\)='` + # Reject names that are not valid shell variable names. + case $ac_envvar in #( + '' | [0-9]* | *[!_$as_cr_alnum]* ) + as_fn_error $? "invalid variable name: '$ac_envvar'" ;; + esac + eval $ac_envvar=\$ac_optarg + export $ac_envvar ;; + + *) + # FIXME: should be removed in autoconf 3.0. + printf "%s\n" "$as_me: WARNING: you should use --build, --host, --target" >&2 + expr "x$ac_option" : ".*[^-._$as_cr_alnum]" >/dev/null && + printf "%s\n" "$as_me: WARNING: invalid host type: $ac_option" >&2 + : "${build_alias=$ac_option} ${host_alias=$ac_option} ${target_alias=$ac_option}" + ;; + + esac +done + +if test -n "$ac_prev"; then + ac_option=--`echo $ac_prev | sed 's/_/-/g'` + as_fn_error $? "missing argument to $ac_option" +fi + +if test -n "$ac_unrecognized_opts"; then + case $enable_option_checking in + no) ;; + fatal) as_fn_error $? "unrecognized options: $ac_unrecognized_opts" ;; + *) printf "%s\n" "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2 ;; + esac +fi + +# Check all directory arguments for consistency. +for ac_var in exec_prefix prefix bindir sbindir libexecdir datarootdir \ + datadir sysconfdir sharedstatedir localstatedir includedir \ + oldincludedir docdir infodir htmldir dvidir pdfdir psdir \ + libdir localedir mandir runstatedir +do + eval ac_val=\$$ac_var + # Remove trailing slashes. + case $ac_val in + */ ) + ac_val=`expr "X$ac_val" : 'X\(.*[^/]\)' \| "X$ac_val" : 'X\(.*\)'` + eval $ac_var=\$ac_val;; + esac + # Be sure to have absolute directory names. + case $ac_val in + [\\/$]* | ?:[\\/]* ) continue;; + NONE | '' ) case $ac_var in *prefix ) continue;; esac;; + esac + as_fn_error $? "expected an absolute directory name for --$ac_var: $ac_val" +done + +# There might be people who depend on the old broken behavior: '$host' +# used to hold the argument of --host etc. +# FIXME: To remove some day. +build=$build_alias +host=$host_alias +target=$target_alias + +# FIXME: To remove some day. +if test "x$host_alias" != x; then + if test "x$build_alias" = x; then + cross_compiling=maybe + elif test "x$build_alias" != "x$host_alias"; then + cross_compiling=yes + fi +fi + +ac_tool_prefix= +test -n "$host_alias" && ac_tool_prefix=$host_alias- + +test "$silent" = yes && exec 6>/dev/null + + +ac_pwd=`pwd` && test -n "$ac_pwd" && +ac_ls_di=`ls -di .` && +ac_pwd_ls_di=`cd "$ac_pwd" && ls -di .` || + as_fn_error $? "working directory cannot be determined" +test "X$ac_ls_di" = "X$ac_pwd_ls_di" || + as_fn_error $? "pwd does not report name of working directory" + + +# Find the source files, if location was not specified. +if test -z "$srcdir"; then + ac_srcdir_defaulted=yes + # Try the directory containing this script, then the parent directory. + ac_confdir=`$as_dirname -- "$as_myself" || +$as_expr X"$as_myself" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$as_myself" : 'X\(//\)[^/]' \| \ + X"$as_myself" : 'X\(//\)$' \| \ + X"$as_myself" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X"$as_myself" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + srcdir=$ac_confdir + if test ! -r "$srcdir/$ac_unique_file"; then + srcdir=.. + fi +else + ac_srcdir_defaulted=no +fi +if test ! -r "$srcdir/$ac_unique_file"; then + test "$ac_srcdir_defaulted" = yes && srcdir="$ac_confdir or .." + as_fn_error $? "cannot find sources ($ac_unique_file) in $srcdir" +fi +ac_msg="sources are in $srcdir, but 'cd $srcdir' does not work" +ac_abs_confdir=`( + cd "$srcdir" && test -r "./$ac_unique_file" || as_fn_error $? "$ac_msg" + pwd)` +# When building in place, set srcdir=. +if test "$ac_abs_confdir" = "$ac_pwd"; then + srcdir=. +fi +# Remove unnecessary trailing slashes from srcdir. +# Double slashes in file names in object file debugging info +# mess up M-x gdb in Emacs. +case $srcdir in +*/) srcdir=`expr "X$srcdir" : 'X\(.*[^/]\)' \| "X$srcdir" : 'X\(.*\)'`;; +esac +for ac_var in $ac_precious_vars; do + eval ac_env_${ac_var}_set=\${${ac_var}+set} + eval ac_env_${ac_var}_value=\$${ac_var} + eval ac_cv_env_${ac_var}_set=\${${ac_var}+set} + eval ac_cv_env_${ac_var}_value=\$${ac_var} +done + +# +# Report the --help message. +# +if test "$ac_init_help" = "long"; then + # Omit some internal or obsolete options to make the list less imposing. + # This message is too long to be a string in the A/UX 3.1 sh. + cat <<_ACEOF +'configure' configures asio 1.36.0 to adapt to many kinds of systems. + +Usage: $0 [OPTION]... [VAR=VALUE]... + +To assign environment variables (e.g., CC, CFLAGS...), specify them as +VAR=VALUE. See below for descriptions of some of the useful variables. + +Defaults for the options are specified in brackets. + +Configuration: + -h, --help display this help and exit + --help=short display options specific to this package + --help=recursive display the short help of all the included packages + -V, --version display version information and exit + -q, --quiet, --silent do not print 'checking ...' messages + --cache-file=FILE cache test results in FILE [disabled] + -C, --config-cache alias for '--cache-file=config.cache' + -n, --no-create do not create output files + --srcdir=DIR find the sources in DIR [configure dir or '..'] + +Installation directories: + --prefix=PREFIX install architecture-independent files in PREFIX + [$ac_default_prefix] + --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX + [PREFIX] + +By default, 'make install' will install all the files in +'$ac_default_prefix/bin', '$ac_default_prefix/lib' etc. You can specify +an installation prefix other than '$ac_default_prefix' using '--prefix', +for instance '--prefix=\$HOME'. + +For better control, use the options below. + +Fine tuning of the installation directories: + --bindir=DIR user executables [EPREFIX/bin] + --sbindir=DIR system admin executables [EPREFIX/sbin] + --libexecdir=DIR program executables [EPREFIX/libexec] + --sysconfdir=DIR read-only single-machine data [PREFIX/etc] + --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] + --localstatedir=DIR modifiable single-machine data [PREFIX/var] + --runstatedir=DIR modifiable per-process data [LOCALSTATEDIR/run] + --libdir=DIR object code libraries [EPREFIX/lib] + --includedir=DIR C header files [PREFIX/include] + --oldincludedir=DIR C header files for non-gcc [/usr/include] + --datarootdir=DIR read-only arch.-independent data root [PREFIX/share] + --datadir=DIR read-only architecture-independent data [DATAROOTDIR] + --infodir=DIR info documentation [DATAROOTDIR/info] + --localedir=DIR locale-dependent data [DATAROOTDIR/locale] + --mandir=DIR man documentation [DATAROOTDIR/man] + --docdir=DIR documentation root [DATAROOTDIR/doc/asio] + --htmldir=DIR html documentation [DOCDIR] + --dvidir=DIR dvi documentation [DOCDIR] + --pdfdir=DIR pdf documentation [DOCDIR] + --psdir=DIR ps documentation [DOCDIR] +_ACEOF + + cat <<\_ACEOF + +Program names: + --program-prefix=PREFIX prepend PREFIX to installed program names + --program-suffix=SUFFIX append SUFFIX to installed program names + --program-transform-name=PROGRAM run sed PROGRAM on installed program names + +System types: + --build=BUILD configure for building on BUILD [guessed] + --host=HOST cross-compile to build programs to run on HOST [BUILD] +_ACEOF +fi + +if test -n "$ac_init_help"; then + case $ac_init_help in + short | recursive ) echo "Configuration of asio 1.36.0:";; + esac + cat <<\_ACEOF + +Optional Features: + --disable-option-checking ignore unrecognized --enable/--with options + --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no) + --enable-FEATURE[=ARG] include FEATURE [ARG=yes] + --enable-maintainer-mode + enable make rules and dependencies not useful (and + sometimes confusing) to the casual installer + --enable-silent-rules less verbose build output (undo: "make V=1") + --disable-silent-rules verbose build output (undo: "make V=0") + --enable-dependency-tracking + do not reject slow dependency extractors + --disable-dependency-tracking + speeds up one-time build + --enable-separate-compilation separate compilation of asio source + --enable-boost-coroutine use Boost.Coroutine to implement stackful coroutines + +Optional Packages: + --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] + --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) + --with-boost=DIR location of boost distribution + --with-openssl=DIR location of openssl + +Some influential environment variables: + CC C compiler command + CFLAGS C compiler flags + LDFLAGS linker flags, e.g. -L if you have libraries in a + nonstandard directory + LIBS libraries to pass to the linker, e.g. -l + CPPFLAGS (Objective) C/C++ preprocessor flags, e.g. -I if + you have headers in a nonstandard directory + CXX C++ compiler command + CXXFLAGS C++ compiler flags + +Use these variables to override the choices made by 'configure' or to help +it to find libraries and programs with nonstandard names/locations. + +Report bugs to the package provider. +_ACEOF +ac_status=$? +fi + +if test "$ac_init_help" = "recursive"; then + # If there are subdirs, report their specific --help. + for ac_dir in : $ac_subdirs_all; do test "x$ac_dir" = x: && continue + test -d "$ac_dir" || + { cd "$srcdir" && ac_pwd=`pwd` && srcdir=. && test -d "$ac_dir"; } || + continue + ac_builddir=. + +case "$ac_dir" in +.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; +*) + ac_dir_suffix=/`printf "%s\n" "$ac_dir" | sed 's|^\.[\\/]||'` + # A ".." for each directory in $ac_dir_suffix. + ac_top_builddir_sub=`printf "%s\n" "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` + case $ac_top_builddir_sub in + "") ac_top_builddir_sub=. ac_top_build_prefix= ;; + *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; + esac ;; +esac +ac_abs_top_builddir=$ac_pwd +ac_abs_builddir=$ac_pwd$ac_dir_suffix +# for backward compatibility: +ac_top_builddir=$ac_top_build_prefix + +case $srcdir in + .) # We are building in place. + ac_srcdir=. + ac_top_srcdir=$ac_top_builddir_sub + ac_abs_top_srcdir=$ac_pwd ;; + [\\/]* | ?:[\\/]* ) # Absolute name. + ac_srcdir=$srcdir$ac_dir_suffix; + ac_top_srcdir=$srcdir + ac_abs_top_srcdir=$srcdir ;; + *) # Relative name. + ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix + ac_top_srcdir=$ac_top_build_prefix$srcdir + ac_abs_top_srcdir=$ac_pwd/$srcdir ;; +esac +ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix + + cd "$ac_dir" || { ac_status=$?; continue; } + # Check for configure.gnu first; this name is used for a wrapper for + # Metaconfig's "Configure" on case-insensitive file systems. + if test -f "$ac_srcdir/configure.gnu"; then + echo && + $SHELL "$ac_srcdir/configure.gnu" --help=recursive + elif test -f "$ac_srcdir/configure"; then + echo && + $SHELL "$ac_srcdir/configure" --help=recursive + else + printf "%s\n" "$as_me: WARNING: no configuration information is in $ac_dir" >&2 + fi || ac_status=$? + cd "$ac_pwd" || { ac_status=$?; break; } + done +fi + +test -n "$ac_init_help" && exit $ac_status +if $ac_init_version; then + cat <<\_ACEOF +asio configure 1.36.0 +generated by GNU Autoconf 2.72 + +Copyright (C) 2023 Free Software Foundation, Inc. +This configure script is free software; the Free Software Foundation +gives unlimited permission to copy, distribute and modify it. +_ACEOF + exit +fi + +## ------------------------ ## +## Autoconf initialization. ## +## ------------------------ ## + +# ac_fn_c_try_compile LINENO +# -------------------------- +# Try to compile conftest.$ac_ext, and return whether this succeeded. +ac_fn_c_try_compile () +{ + as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack + rm -f conftest.$ac_objext conftest.beam + if { { ac_try="$ac_compile" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_compile") 2>conftest.err + ac_status=$? + if test -s conftest.err; then + grep -v '^ *+' conftest.err >conftest.er1 + cat conftest.er1 >&5 + mv -f conftest.er1 conftest.err + fi + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } && { + test -z "$ac_c_werror_flag" || + test ! -s conftest.err + } && test -s conftest.$ac_objext +then : + ac_retval=0 +else case e in #( + e) printf "%s\n" "$as_me: failed program was:" >&5 +sed 's/^/| /' conftest.$ac_ext >&5 + + ac_retval=1 ;; +esac +fi + eval $as_lineno_stack; ${as_lineno_stack:+:} unset as_lineno + as_fn_set_status $ac_retval + +} # ac_fn_c_try_compile + +# ac_fn_cxx_try_compile LINENO +# ---------------------------- +# Try to compile conftest.$ac_ext, and return whether this succeeded. +ac_fn_cxx_try_compile () +{ + as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack + rm -f conftest.$ac_objext conftest.beam + if { { ac_try="$ac_compile" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_compile") 2>conftest.err + ac_status=$? + if test -s conftest.err; then + grep -v '^ *+' conftest.err >conftest.er1 + cat conftest.er1 >&5 + mv -f conftest.er1 conftest.err + fi + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } && { + test -z "$ac_cxx_werror_flag" || + test ! -s conftest.err + } && test -s conftest.$ac_objext +then : + ac_retval=0 +else case e in #( + e) printf "%s\n" "$as_me: failed program was:" >&5 +sed 's/^/| /' conftest.$ac_ext >&5 + + ac_retval=1 ;; +esac +fi + eval $as_lineno_stack; ${as_lineno_stack:+:} unset as_lineno + as_fn_set_status $ac_retval + +} # ac_fn_cxx_try_compile + +# ac_fn_cxx_check_header_compile LINENO HEADER VAR INCLUDES +# --------------------------------------------------------- +# Tests whether HEADER exists and can be compiled using the include files in +# INCLUDES, setting the cache variable VAR accordingly. +ac_fn_cxx_check_header_compile () +{ + as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $2" >&5 +printf %s "checking for $2... " >&6; } +if eval test \${$3+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +$4 +#include <$2> +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + eval "$3=yes" +else case e in #( + e) eval "$3=no" ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext ;; +esac +fi +eval ac_res=\$$3 + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_res" >&5 +printf "%s\n" "$ac_res" >&6; } + eval $as_lineno_stack; ${as_lineno_stack:+:} unset as_lineno + +} # ac_fn_cxx_check_header_compile +ac_configure_args_raw= +for ac_arg +do + case $ac_arg in + *\'*) + ac_arg=`printf "%s\n" "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; + esac + as_fn_append ac_configure_args_raw " '$ac_arg'" +done + +case $ac_configure_args_raw in + *$as_nl*) + ac_safe_unquote= ;; + *) + ac_unsafe_z='|&;<>()$`\\"*?[ '' ' # This string ends in space, tab. + ac_unsafe_a="$ac_unsafe_z#~" + ac_safe_unquote="s/ '\\([^$ac_unsafe_a][^$ac_unsafe_z]*\\)'/ \\1/g" + ac_configure_args_raw=` printf "%s\n" "$ac_configure_args_raw" | sed "$ac_safe_unquote"`;; +esac + +cat >config.log <<_ACEOF +This file contains any messages produced by compilers while +running configure, to aid debugging if configure makes a mistake. + +It was created by asio $as_me 1.36.0, which was +generated by GNU Autoconf 2.72. Invocation command line was + + $ $0$ac_configure_args_raw + +_ACEOF +exec 5>>config.log +{ +cat <<_ASUNAME +## --------- ## +## Platform. ## +## --------- ## + +hostname = `(hostname || uname -n) 2>/dev/null | sed 1q` +uname -m = `(uname -m) 2>/dev/null || echo unknown` +uname -r = `(uname -r) 2>/dev/null || echo unknown` +uname -s = `(uname -s) 2>/dev/null || echo unknown` +uname -v = `(uname -v) 2>/dev/null || echo unknown` + +/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null || echo unknown` +/bin/uname -X = `(/bin/uname -X) 2>/dev/null || echo unknown` + +/bin/arch = `(/bin/arch) 2>/dev/null || echo unknown` +/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null || echo unknown` +/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null || echo unknown` +/usr/bin/hostinfo = `(/usr/bin/hostinfo) 2>/dev/null || echo unknown` +/bin/machine = `(/bin/machine) 2>/dev/null || echo unknown` +/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null || echo unknown` +/bin/universe = `(/bin/universe) 2>/dev/null || echo unknown` + +_ASUNAME + +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + printf "%s\n" "PATH: $as_dir" + done +IFS=$as_save_IFS + +} >&5 + +cat >&5 <<_ACEOF + + +## ----------- ## +## Core tests. ## +## ----------- ## + +_ACEOF + + +# Keep a trace of the command line. +# Strip out --no-create and --no-recursion so they do not pile up. +# Strip out --silent because we don't want to record it for future runs. +# Also quote any args containing shell meta-characters. +# Make two passes to allow for proper duplicate-argument suppression. +ac_configure_args= +ac_configure_args0= +ac_configure_args1= +ac_must_keep_next=false +for ac_pass in 1 2 +do + for ac_arg + do + case $ac_arg in + -no-create | --no-c* | -n | -no-recursion | --no-r*) continue ;; + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil) + continue ;; + *\'*) + ac_arg=`printf "%s\n" "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; + esac + case $ac_pass in + 1) as_fn_append ac_configure_args0 " '$ac_arg'" ;; + 2) + as_fn_append ac_configure_args1 " '$ac_arg'" + if test $ac_must_keep_next = true; then + ac_must_keep_next=false # Got value, back to normal. + else + case $ac_arg in + *=* | --config-cache | -C | -disable-* | --disable-* \ + | -enable-* | --enable-* | -gas | --g* | -nfp | --nf* \ + | -q | -quiet | --q* | -silent | --sil* | -v | -verb* \ + | -with-* | --with-* | -without-* | --without-* | --x) + case "$ac_configure_args0 " in + "$ac_configure_args1"*" '$ac_arg' "* ) continue ;; + esac + ;; + -* ) ac_must_keep_next=true ;; + esac + fi + as_fn_append ac_configure_args " '$ac_arg'" + ;; + esac + done +done +{ ac_configure_args0=; unset ac_configure_args0;} +{ ac_configure_args1=; unset ac_configure_args1;} + +# When interrupted or exit'd, cleanup temporary files, and complete +# config.log. We remove comments because anyway the quotes in there +# would cause problems or look ugly. +# WARNING: Use '\'' to represent an apostrophe within the trap. +# WARNING: Do not start the trap code with a newline, due to a FreeBSD 4.0 bug. +trap 'exit_status=$? + # Sanitize IFS. + IFS=" "" $as_nl" + # Save into config.log some information that might help in debugging. + { + echo + + printf "%s\n" "## ---------------- ## +## Cache variables. ## +## ---------------- ##" + echo + # The following way of writing the cache mishandles newlines in values, +( + for ac_var in `(set) 2>&1 | sed -n '\''s/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'\''`; do + eval ac_val=\$$ac_var + case $ac_val in #( + *${as_nl}*) + case $ac_var in #( + *_cv_*) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 +printf "%s\n" "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; + esac + case $ac_var in #( + _ | IFS | as_nl) ;; #( + BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( + *) { eval $ac_var=; unset $ac_var;} ;; + esac ;; + esac + done + (set) 2>&1 | + case $as_nl`(ac_space='\'' '\''; set) 2>&1` in #( + *${as_nl}ac_space=\ *) + sed -n \ + "s/'\''/'\''\\\\'\'''\''/g; + s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\''\\2'\''/p" + ;; #( + *) + sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" + ;; + esac | + sort +) + echo + + printf "%s\n" "## ----------------- ## +## Output variables. ## +## ----------------- ##" + echo + for ac_var in $ac_subst_vars + do + eval ac_val=\$$ac_var + case $ac_val in + *\'\''*) ac_val=`printf "%s\n" "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; + esac + printf "%s\n" "$ac_var='\''$ac_val'\''" + done | sort + echo + + if test -n "$ac_subst_files"; then + printf "%s\n" "## ------------------- ## +## File substitutions. ## +## ------------------- ##" + echo + for ac_var in $ac_subst_files + do + eval ac_val=\$$ac_var + case $ac_val in + *\'\''*) ac_val=`printf "%s\n" "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; + esac + printf "%s\n" "$ac_var='\''$ac_val'\''" + done | sort + echo + fi + + if test -s confdefs.h; then + printf "%s\n" "## ----------- ## +## confdefs.h. ## +## ----------- ##" + echo + cat confdefs.h + echo + fi + test "$ac_signal" != 0 && + printf "%s\n" "$as_me: caught signal $ac_signal" + printf "%s\n" "$as_me: exit $exit_status" + } >&5 + rm -f core *.core core.conftest.* && + rm -f -r conftest* confdefs* conf$$* $ac_clean_files && + exit $exit_status +' 0 +for ac_signal in 1 2 13 15; do + trap 'ac_signal='$ac_signal'; as_fn_exit 1' $ac_signal +done +ac_signal=0 + +# confdefs.h avoids OS command line length limits that DEFS can exceed. +rm -f -r conftest* confdefs.h + +printf "%s\n" "/* confdefs.h */" > confdefs.h + +# Predefined preprocessor variables. + +printf "%s\n" "#define PACKAGE_NAME \"$PACKAGE_NAME\"" >>confdefs.h + +printf "%s\n" "#define PACKAGE_TARNAME \"$PACKAGE_TARNAME\"" >>confdefs.h + +printf "%s\n" "#define PACKAGE_VERSION \"$PACKAGE_VERSION\"" >>confdefs.h + +printf "%s\n" "#define PACKAGE_STRING \"$PACKAGE_STRING\"" >>confdefs.h + +printf "%s\n" "#define PACKAGE_BUGREPORT \"$PACKAGE_BUGREPORT\"" >>confdefs.h + +printf "%s\n" "#define PACKAGE_URL \"$PACKAGE_URL\"" >>confdefs.h + + +# Let the site file select an alternate cache file if it wants to. +# Prefer an explicitly selected file to automatically selected ones. +if test -n "$CONFIG_SITE"; then + ac_site_files="$CONFIG_SITE" +elif test "x$prefix" != xNONE; then + ac_site_files="$prefix/share/config.site $prefix/etc/config.site" +else + ac_site_files="$ac_default_prefix/share/config.site $ac_default_prefix/etc/config.site" +fi + +for ac_site_file in $ac_site_files +do + case $ac_site_file in #( + */*) : + ;; #( + *) : + ac_site_file=./$ac_site_file ;; +esac + if test -f "$ac_site_file" && test -r "$ac_site_file"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: loading site script $ac_site_file" >&5 +printf "%s\n" "$as_me: loading site script $ac_site_file" >&6;} + sed 's/^/| /' "$ac_site_file" >&5 + . "$ac_site_file" \ + || { { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error $? "failed to load site script $ac_site_file +See 'config.log' for more details" "$LINENO" 5; } + fi +done + +if test -r "$cache_file"; then + # Some versions of bash will fail to source /dev/null (special files + # actually), so we avoid doing that. DJGPP emulates it as a regular file. + if test /dev/null != "$cache_file" && test -f "$cache_file"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: loading cache $cache_file" >&5 +printf "%s\n" "$as_me: loading cache $cache_file" >&6;} + case $cache_file in + [\\/]* | ?:[\\/]* ) . "$cache_file";; + *) . "./$cache_file";; + esac + fi +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: creating cache $cache_file" >&5 +printf "%s\n" "$as_me: creating cache $cache_file" >&6;} + >$cache_file +fi + +# Test code for whether the C compiler supports C89 (global declarations) +ac_c_conftest_c89_globals=' +/* Does the compiler advertise C89 conformance? + Do not test the value of __STDC__, because some compilers set it to 0 + while being otherwise adequately conformant. */ +#if !defined __STDC__ +# error "Compiler does not advertise C89 conformance" +#endif + +#include +#include +struct stat; +/* Most of the following tests are stolen from RCS 5.7 src/conf.sh. */ +struct buf { int x; }; +struct buf * (*rcsopen) (struct buf *, struct stat *, int); +static char *e (char **p, int i) +{ + return p[i]; +} +static char *f (char * (*g) (char **, int), char **p, ...) +{ + char *s; + va_list v; + va_start (v,p); + s = g (p, va_arg (v,int)); + va_end (v); + return s; +} + +/* C89 style stringification. */ +#define noexpand_stringify(a) #a +const char *stringified = noexpand_stringify(arbitrary+token=sequence); + +/* C89 style token pasting. Exercises some of the corner cases that + e.g. old MSVC gets wrong, but not very hard. */ +#define noexpand_concat(a,b) a##b +#define expand_concat(a,b) noexpand_concat(a,b) +extern int vA; +extern int vbee; +#define aye A +#define bee B +int *pvA = &expand_concat(v,aye); +int *pvbee = &noexpand_concat(v,bee); + +/* OSF 4.0 Compaq cc is some sort of almost-ANSI by default. It has + function prototypes and stuff, but not \xHH hex character constants. + These do not provoke an error unfortunately, instead are silently treated + as an "x". The following induces an error, until -std is added to get + proper ANSI mode. Curiously \x00 != x always comes out true, for an + array size at least. It is necessary to write \x00 == 0 to get something + that is true only with -std. */ +int osf4_cc_array ['\''\x00'\'' == 0 ? 1 : -1]; + +/* IBM C 6 for AIX is almost-ANSI by default, but it replaces macro parameters + inside strings and character constants. */ +#define FOO(x) '\''x'\'' +int xlc6_cc_array[FOO(a) == '\''x'\'' ? 1 : -1]; + +int test (int i, double x); +struct s1 {int (*f) (int a);}; +struct s2 {int (*f) (double a);}; +int pairnames (int, char **, int *(*)(struct buf *, struct stat *, int), + int, int);' + +# Test code for whether the C compiler supports C89 (body of main). +ac_c_conftest_c89_main=' +ok |= (argc == 0 || f (e, argv, 0) != argv[0] || f (e, argv, 1) != argv[1]); +' + +# Test code for whether the C compiler supports C99 (global declarations) +ac_c_conftest_c99_globals=' +/* Does the compiler advertise C99 conformance? */ +#if !defined __STDC_VERSION__ || __STDC_VERSION__ < 199901L +# error "Compiler does not advertise C99 conformance" +#endif + +// See if C++-style comments work. + +#include +extern int puts (const char *); +extern int printf (const char *, ...); +extern int dprintf (int, const char *, ...); +extern void *malloc (size_t); +extern void free (void *); + +// Check varargs macros. These examples are taken from C99 6.10.3.5. +// dprintf is used instead of fprintf to avoid needing to declare +// FILE and stderr. +#define debug(...) dprintf (2, __VA_ARGS__) +#define showlist(...) puts (#__VA_ARGS__) +#define report(test,...) ((test) ? puts (#test) : printf (__VA_ARGS__)) +static void +test_varargs_macros (void) +{ + int x = 1234; + int y = 5678; + debug ("Flag"); + debug ("X = %d\n", x); + showlist (The first, second, and third items.); + report (x>y, "x is %d but y is %d", x, y); +} + +// Check long long types. +#define BIG64 18446744073709551615ull +#define BIG32 4294967295ul +#define BIG_OK (BIG64 / BIG32 == 4294967297ull && BIG64 % BIG32 == 0) +#if !BIG_OK + #error "your preprocessor is broken" +#endif +#if BIG_OK +#else + #error "your preprocessor is broken" +#endif +static long long int bignum = -9223372036854775807LL; +static unsigned long long int ubignum = BIG64; + +struct incomplete_array +{ + int datasize; + double data[]; +}; + +struct named_init { + int number; + const wchar_t *name; + double average; +}; + +typedef const char *ccp; + +static inline int +test_restrict (ccp restrict text) +{ + // Iterate through items via the restricted pointer. + // Also check for declarations in for loops. + for (unsigned int i = 0; *(text+i) != '\''\0'\''; ++i) + continue; + return 0; +} + +// Check varargs and va_copy. +static bool +test_varargs (const char *format, ...) +{ + va_list args; + va_start (args, format); + va_list args_copy; + va_copy (args_copy, args); + + const char *str = ""; + int number = 0; + float fnumber = 0; + + while (*format) + { + switch (*format++) + { + case '\''s'\'': // string + str = va_arg (args_copy, const char *); + break; + case '\''d'\'': // int + number = va_arg (args_copy, int); + break; + case '\''f'\'': // float + fnumber = va_arg (args_copy, double); + break; + default: + break; + } + } + va_end (args_copy); + va_end (args); + + return *str && number && fnumber; +} +' + +# Test code for whether the C compiler supports C99 (body of main). +ac_c_conftest_c99_main=' + // Check bool. + _Bool success = false; + success |= (argc != 0); + + // Check restrict. + if (test_restrict ("String literal") == 0) + success = true; + char *restrict newvar = "Another string"; + + // Check varargs. + success &= test_varargs ("s, d'\'' f .", "string", 65, 34.234); + test_varargs_macros (); + + // Check flexible array members. + struct incomplete_array *ia = + malloc (sizeof (struct incomplete_array) + (sizeof (double) * 10)); + ia->datasize = 10; + for (int i = 0; i < ia->datasize; ++i) + ia->data[i] = i * 1.234; + // Work around memory leak warnings. + free (ia); + + // Check named initializers. + struct named_init ni = { + .number = 34, + .name = L"Test wide string", + .average = 543.34343, + }; + + ni.number = 58; + + int dynamic_array[ni.number]; + dynamic_array[0] = argv[0][0]; + dynamic_array[ni.number - 1] = 543; + + // work around unused variable warnings + ok |= (!success || bignum == 0LL || ubignum == 0uLL || newvar[0] == '\''x'\'' + || dynamic_array[ni.number - 1] != 543); +' + +# Test code for whether the C compiler supports C11 (global declarations) +ac_c_conftest_c11_globals=' +/* Does the compiler advertise C11 conformance? */ +#if !defined __STDC_VERSION__ || __STDC_VERSION__ < 201112L +# error "Compiler does not advertise C11 conformance" +#endif + +// Check _Alignas. +char _Alignas (double) aligned_as_double; +char _Alignas (0) no_special_alignment; +extern char aligned_as_int; +char _Alignas (0) _Alignas (int) aligned_as_int; + +// Check _Alignof. +enum +{ + int_alignment = _Alignof (int), + int_array_alignment = _Alignof (int[100]), + char_alignment = _Alignof (char) +}; +_Static_assert (0 < -_Alignof (int), "_Alignof is signed"); + +// Check _Noreturn. +int _Noreturn does_not_return (void) { for (;;) continue; } + +// Check _Static_assert. +struct test_static_assert +{ + int x; + _Static_assert (sizeof (int) <= sizeof (long int), + "_Static_assert does not work in struct"); + long int y; +}; + +// Check UTF-8 literals. +#define u8 syntax error! +char const utf8_literal[] = u8"happens to be ASCII" "another string"; + +// Check duplicate typedefs. +typedef long *long_ptr; +typedef long int *long_ptr; +typedef long_ptr long_ptr; + +// Anonymous structures and unions -- taken from C11 6.7.2.1 Example 1. +struct anonymous +{ + union { + struct { int i; int j; }; + struct { int k; long int l; } w; + }; + int m; +} v1; +' + +# Test code for whether the C compiler supports C11 (body of main). +ac_c_conftest_c11_main=' + _Static_assert ((offsetof (struct anonymous, i) + == offsetof (struct anonymous, w.k)), + "Anonymous union alignment botch"); + v1.i = 2; + v1.w.k = 5; + ok |= v1.i != 5; +' + +# Test code for whether the C compiler supports C11 (complete). +ac_c_conftest_c11_program="${ac_c_conftest_c89_globals} +${ac_c_conftest_c99_globals} +${ac_c_conftest_c11_globals} + +int +main (int argc, char **argv) +{ + int ok = 0; + ${ac_c_conftest_c89_main} + ${ac_c_conftest_c99_main} + ${ac_c_conftest_c11_main} + return ok; +} +" + +# Test code for whether the C compiler supports C99 (complete). +ac_c_conftest_c99_program="${ac_c_conftest_c89_globals} +${ac_c_conftest_c99_globals} + +int +main (int argc, char **argv) +{ + int ok = 0; + ${ac_c_conftest_c89_main} + ${ac_c_conftest_c99_main} + return ok; +} +" + +# Test code for whether the C compiler supports C89 (complete). +ac_c_conftest_c89_program="${ac_c_conftest_c89_globals} + +int +main (int argc, char **argv) +{ + int ok = 0; + ${ac_c_conftest_c89_main} + return ok; +} +" + +# Test code for whether the C++ compiler supports C++98 (global declarations) +ac_cxx_conftest_cxx98_globals=' +// Does the compiler advertise C++98 conformance? +#if !defined __cplusplus || __cplusplus < 199711L +# error "Compiler does not advertise C++98 conformance" +#endif + +// These inclusions are to reject old compilers that +// lack the unsuffixed header files. +#include +#include + +// and are *not* freestanding headers in C++98. +extern void assert (int); +namespace std { + extern int strcmp (const char *, const char *); +} + +// Namespaces, exceptions, and templates were all added after "C++ 2.0". +using std::exception; +using std::strcmp; + +namespace { + +void test_exception_syntax() +{ + try { + throw "test"; + } catch (const char *s) { + // Extra parentheses suppress a warning when building autoconf itself, + // due to lint rules shared with more typical C programs. + assert (!(strcmp) (s, "test")); + } +} + +template struct test_template +{ + T const val; + explicit test_template(T t) : val(t) {} + template T add(U u) { return static_cast(u) + val; } +}; + +} // anonymous namespace +' + +# Test code for whether the C++ compiler supports C++98 (body of main) +ac_cxx_conftest_cxx98_main=' + assert (argc); + assert (! argv[0]); +{ + test_exception_syntax (); + test_template tt (2.0); + assert (tt.add (4) == 6.0); + assert (true && !false); +} +' + +# Test code for whether the C++ compiler supports C++11 (global declarations) +ac_cxx_conftest_cxx11_globals=' +// Does the compiler advertise C++ 2011 conformance? +#if !defined __cplusplus || __cplusplus < 201103L +# error "Compiler does not advertise C++11 conformance" +#endif + +namespace cxx11test +{ + constexpr int get_val() { return 20; } + + struct testinit + { + int i; + double d; + }; + + class delegate + { + public: + delegate(int n) : n(n) {} + delegate(): delegate(2354) {} + + virtual int getval() { return this->n; }; + protected: + int n; + }; + + class overridden : public delegate + { + public: + overridden(int n): delegate(n) {} + virtual int getval() override final { return this->n * 2; } + }; + + class nocopy + { + public: + nocopy(int i): i(i) {} + nocopy() = default; + nocopy(const nocopy&) = delete; + nocopy & operator=(const nocopy&) = delete; + private: + int i; + }; + + // for testing lambda expressions + template Ret eval(Fn f, Ret v) + { + return f(v); + } + + // for testing variadic templates and trailing return types + template auto sum(V first) -> V + { + return first; + } + template auto sum(V first, Args... rest) -> V + { + return first + sum(rest...); + } +} +' + +# Test code for whether the C++ compiler supports C++11 (body of main) +ac_cxx_conftest_cxx11_main=' +{ + // Test auto and decltype + auto a1 = 6538; + auto a2 = 48573953.4; + auto a3 = "String literal"; + + int total = 0; + for (auto i = a3; *i; ++i) { total += *i; } + + decltype(a2) a4 = 34895.034; +} +{ + // Test constexpr + short sa[cxx11test::get_val()] = { 0 }; +} +{ + // Test initializer lists + cxx11test::testinit il = { 4323, 435234.23544 }; +} +{ + // Test range-based for + int array[] = {9, 7, 13, 15, 4, 18, 12, 10, 5, 3, + 14, 19, 17, 8, 6, 20, 16, 2, 11, 1}; + for (auto &x : array) { x += 23; } +} +{ + // Test lambda expressions + using cxx11test::eval; + assert (eval ([](int x) { return x*2; }, 21) == 42); + double d = 2.0; + assert (eval ([&](double x) { return d += x; }, 3.0) == 5.0); + assert (d == 5.0); + assert (eval ([=](double x) mutable { return d += x; }, 4.0) == 9.0); + assert (d == 5.0); +} +{ + // Test use of variadic templates + using cxx11test::sum; + auto a = sum(1); + auto b = sum(1, 2); + auto c = sum(1.0, 2.0, 3.0); +} +{ + // Test constructor delegation + cxx11test::delegate d1; + cxx11test::delegate d2(); + cxx11test::delegate d3(45); +} +{ + // Test override and final + cxx11test::overridden o1(55464); +} +{ + // Test nullptr + char *c = nullptr; +} +{ + // Test template brackets + test_template<::test_template> v(test_template(12)); +} +{ + // Unicode literals + char const *utf8 = u8"UTF-8 string \u2500"; + char16_t const *utf16 = u"UTF-8 string \u2500"; + char32_t const *utf32 = U"UTF-32 string \u2500"; +} +' + +# Test code for whether the C compiler supports C++11 (complete). +ac_cxx_conftest_cxx11_program="${ac_cxx_conftest_cxx98_globals} +${ac_cxx_conftest_cxx11_globals} + +int +main (int argc, char **argv) +{ + int ok = 0; + ${ac_cxx_conftest_cxx98_main} + ${ac_cxx_conftest_cxx11_main} + return ok; +} +" + +# Test code for whether the C compiler supports C++98 (complete). +ac_cxx_conftest_cxx98_program="${ac_cxx_conftest_cxx98_globals} +int +main (int argc, char **argv) +{ + int ok = 0; + ${ac_cxx_conftest_cxx98_main} + return ok; +} +" + +as_fn_append ac_header_cxx_list " stdio.h stdio_h HAVE_STDIO_H" +as_fn_append ac_header_cxx_list " stdlib.h stdlib_h HAVE_STDLIB_H" +as_fn_append ac_header_cxx_list " string.h string_h HAVE_STRING_H" +as_fn_append ac_header_cxx_list " inttypes.h inttypes_h HAVE_INTTYPES_H" +as_fn_append ac_header_cxx_list " stdint.h stdint_h HAVE_STDINT_H" +as_fn_append ac_header_cxx_list " strings.h strings_h HAVE_STRINGS_H" +as_fn_append ac_header_cxx_list " sys/stat.h sys_stat_h HAVE_SYS_STAT_H" +as_fn_append ac_header_cxx_list " sys/types.h sys_types_h HAVE_SYS_TYPES_H" +as_fn_append ac_header_cxx_list " unistd.h unistd_h HAVE_UNISTD_H" + +# Auxiliary files required by this configure script. +ac_aux_files="compile config.guess config.sub missing install-sh" + +# Locations in which to look for auxiliary files. +ac_aux_dir_candidates="${srcdir}${PATH_SEPARATOR}${srcdir}/..${PATH_SEPARATOR}${srcdir}/../.." + +# Search for a directory containing all of the required auxiliary files, +# $ac_aux_files, from the $PATH-style list $ac_aux_dir_candidates. +# If we don't find one directory that contains all the files we need, +# we report the set of missing files from the *first* directory in +# $ac_aux_dir_candidates and give up. +ac_missing_aux_files="" +ac_first_candidate=: +printf "%s\n" "$as_me:${as_lineno-$LINENO}: looking for aux files: $ac_aux_files" >&5 +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +as_found=false +for as_dir in $ac_aux_dir_candidates +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + as_found=: + + printf "%s\n" "$as_me:${as_lineno-$LINENO}: trying $as_dir" >&5 + ac_aux_dir_found=yes + ac_install_sh= + for ac_aux in $ac_aux_files + do + # As a special case, if "install-sh" is required, that requirement + # can be satisfied by any of "install-sh", "install.sh", or "shtool", + # and $ac_install_sh is set appropriately for whichever one is found. + if test x"$ac_aux" = x"install-sh" + then + if test -f "${as_dir}install-sh"; then + printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}install-sh found" >&5 + ac_install_sh="${as_dir}install-sh -c" + elif test -f "${as_dir}install.sh"; then + printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}install.sh found" >&5 + ac_install_sh="${as_dir}install.sh -c" + elif test -f "${as_dir}shtool"; then + printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}shtool found" >&5 + ac_install_sh="${as_dir}shtool install -c" + else + ac_aux_dir_found=no + if $ac_first_candidate; then + ac_missing_aux_files="${ac_missing_aux_files} install-sh" + else + break + fi + fi + else + if test -f "${as_dir}${ac_aux}"; then + printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}${ac_aux} found" >&5 + else + ac_aux_dir_found=no + if $ac_first_candidate; then + ac_missing_aux_files="${ac_missing_aux_files} ${ac_aux}" + else + break + fi + fi + fi + done + if test "$ac_aux_dir_found" = yes; then + ac_aux_dir="$as_dir" + break + fi + ac_first_candidate=false + + as_found=false +done +IFS=$as_save_IFS +if $as_found +then : + +else case e in #( + e) as_fn_error $? "cannot find required auxiliary files:$ac_missing_aux_files" "$LINENO" 5 ;; +esac +fi + + +# These three variables are undocumented and unsupported, +# and are intended to be withdrawn in a future Autoconf release. +# They can cause serious problems if a builder's source tree is in a directory +# whose full name contains unusual characters. +if test -f "${ac_aux_dir}config.guess"; then + ac_config_guess="$SHELL ${ac_aux_dir}config.guess" +fi +if test -f "${ac_aux_dir}config.sub"; then + ac_config_sub="$SHELL ${ac_aux_dir}config.sub" +fi +if test -f "$ac_aux_dir/configure"; then + ac_configure="$SHELL ${ac_aux_dir}configure" +fi + +# Check that the precious variables saved in the cache have kept the same +# value. +ac_cache_corrupted=false +for ac_var in $ac_precious_vars; do + eval ac_old_set=\$ac_cv_env_${ac_var}_set + eval ac_new_set=\$ac_env_${ac_var}_set + eval ac_old_val=\$ac_cv_env_${ac_var}_value + eval ac_new_val=\$ac_env_${ac_var}_value + case $ac_old_set,$ac_new_set in + set,) + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: '$ac_var' was set to '$ac_old_val' in the previous run" >&5 +printf "%s\n" "$as_me: error: '$ac_var' was set to '$ac_old_val' in the previous run" >&2;} + ac_cache_corrupted=: ;; + ,set) + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: '$ac_var' was not set in the previous run" >&5 +printf "%s\n" "$as_me: error: '$ac_var' was not set in the previous run" >&2;} + ac_cache_corrupted=: ;; + ,);; + *) + if test "x$ac_old_val" != "x$ac_new_val"; then + # differences in whitespace do not lead to failure. + ac_old_val_w=`echo x $ac_old_val` + ac_new_val_w=`echo x $ac_new_val` + if test "$ac_old_val_w" != "$ac_new_val_w"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: '$ac_var' has changed since the previous run:" >&5 +printf "%s\n" "$as_me: error: '$ac_var' has changed since the previous run:" >&2;} + ac_cache_corrupted=: + else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: warning: ignoring whitespace changes in '$ac_var' since the previous run:" >&5 +printf "%s\n" "$as_me: warning: ignoring whitespace changes in '$ac_var' since the previous run:" >&2;} + eval $ac_var=\$ac_old_val + fi + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: former value: '$ac_old_val'" >&5 +printf "%s\n" "$as_me: former value: '$ac_old_val'" >&2;} + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: current value: '$ac_new_val'" >&5 +printf "%s\n" "$as_me: current value: '$ac_new_val'" >&2;} + fi;; + esac + # Pass precious variables to config.status. + if test "$ac_new_set" = set; then + case $ac_new_val in + *\'*) ac_arg=$ac_var=`printf "%s\n" "$ac_new_val" | sed "s/'/'\\\\\\\\''/g"` ;; + *) ac_arg=$ac_var=$ac_new_val ;; + esac + case " $ac_configure_args " in + *" '$ac_arg' "*) ;; # Avoid dups. Use of quotes ensures accuracy. + *) as_fn_append ac_configure_args " '$ac_arg'" ;; + esac + fi +done +if $ac_cache_corrupted; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: changes in the environment can compromise the build" >&5 +printf "%s\n" "$as_me: error: changes in the environment can compromise the build" >&2;} + as_fn_error $? "run '${MAKE-make} distclean' and/or 'rm $cache_file' + and start over" "$LINENO" 5 +fi +## -------------------- ## +## Main body of script. ## +## -------------------- ## + +ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu + + + + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether to enable maintainer-specific portions of Makefiles" >&5 +printf %s "checking whether to enable maintainer-specific portions of Makefiles... " >&6; } + # Check whether --enable-maintainer-mode was given. +if test ${enable_maintainer_mode+y} +then : + enableval=$enable_maintainer_mode; USE_MAINTAINER_MODE=$enableval +else case e in #( + e) USE_MAINTAINER_MODE=no ;; +esac +fi + + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $USE_MAINTAINER_MODE" >&5 +printf "%s\n" "$USE_MAINTAINER_MODE" >&6; } + if test $USE_MAINTAINER_MODE = yes; then + MAINTAINER_MODE_TRUE= + MAINTAINER_MODE_FALSE='#' +else + MAINTAINER_MODE_TRUE='#' + MAINTAINER_MODE_FALSE= +fi + + MAINT=$MAINTAINER_MODE_TRUE + + +am__api_version='1.17' + + + + # Find a good install program. We prefer a C program (faster), +# so one script is as good as another. But avoid the broken or +# incompatible versions: +# SysV /etc/install, /usr/sbin/install +# SunOS /usr/etc/install +# IRIX /sbin/install +# AIX /bin/install +# AmigaOS /C/install, which installs bootblocks on floppy discs +# AIX 4 /usr/bin/installbsd, which doesn't work without a -g flag +# AFS /usr/afsws/bin/install, which mishandles nonexistent args +# SVR4 /usr/ucb/install, which tries to use the nonexistent group "staff" +# OS/2's system install, which has a completely different semantic +# ./install, which can be erroneously created by make from ./install.sh. +# Reject install programs that cannot install multiple files. +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for a BSD-compatible install" >&5 +printf %s "checking for a BSD-compatible install... " >&6; } +if test -z "$INSTALL"; then +if test ${ac_cv_path_install+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + # Account for fact that we put trailing slashes in our PATH walk. +case $as_dir in #(( + ./ | /[cC]/* | \ + /etc/* | /usr/sbin/* | /usr/etc/* | /sbin/* | /usr/afsws/bin/* | \ + ?:[\\/]os2[\\/]install[\\/]* | ?:[\\/]OS2[\\/]INSTALL[\\/]* | \ + /usr/ucb/* ) ;; + *) + # OSF1 and SCO ODT 3.0 have their own names for install. + # Don't use installbsd from OSF since it installs stuff as root + # by default. + for ac_prog in ginstall scoinst install; do + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_prog$ac_exec_ext"; then + if test $ac_prog = install && + grep dspmsg "$as_dir$ac_prog$ac_exec_ext" >/dev/null 2>&1; then + # AIX install. It has an incompatible calling convention. + : + elif test $ac_prog = install && + grep pwplus "$as_dir$ac_prog$ac_exec_ext" >/dev/null 2>&1; then + # program-specific install script used by HP pwplus--don't use. + : + else + rm -rf conftest.one conftest.two conftest.dir + echo one > conftest.one + echo two > conftest.two + mkdir conftest.dir + if "$as_dir$ac_prog$ac_exec_ext" -c conftest.one conftest.two "`pwd`/conftest.dir/" && + test -s conftest.one && test -s conftest.two && + test -s conftest.dir/conftest.one && + test -s conftest.dir/conftest.two + then + ac_cv_path_install="$as_dir$ac_prog$ac_exec_ext -c" + break 3 + fi + fi + fi + done + done + ;; +esac + + done +IFS=$as_save_IFS + +rm -rf conftest.one conftest.two conftest.dir + ;; +esac +fi + if test ${ac_cv_path_install+y}; then + INSTALL=$ac_cv_path_install + else + # As a last resort, use the slow shell script. Don't cache a + # value for INSTALL within a source directory, because that will + # break other packages using the cache if that directory is + # removed, or if the value is a relative name. + INSTALL=$ac_install_sh + fi +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $INSTALL" >&5 +printf "%s\n" "$INSTALL" >&6; } + +# Use test -z because SunOS4 sh mishandles braces in ${var-val}. +# It thinks the first close brace ends the variable substitution. +test -z "$INSTALL_PROGRAM" && INSTALL_PROGRAM='${INSTALL}' + +test -z "$INSTALL_SCRIPT" && INSTALL_SCRIPT='${INSTALL}' + +test -z "$INSTALL_DATA" && INSTALL_DATA='${INSTALL} -m 644' + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether sleep supports fractional seconds" >&5 +printf %s "checking whether sleep supports fractional seconds... " >&6; } +if test ${am_cv_sleep_fractional_seconds+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if sleep 0.001 2>/dev/null +then : + am_cv_sleep_fractional_seconds=yes +else case e in #( + e) am_cv_sleep_fractional_seconds=no ;; +esac +fi + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_sleep_fractional_seconds" >&5 +printf "%s\n" "$am_cv_sleep_fractional_seconds" >&6; } + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking filesystem timestamp resolution" >&5 +printf %s "checking filesystem timestamp resolution... " >&6; } +if test ${am_cv_filesystem_timestamp_resolution+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) # Default to the worst case. +am_cv_filesystem_timestamp_resolution=2 + +# Only try to go finer than 1 sec if sleep can do it. +# Don't try 1 sec, because if 0.01 sec and 0.1 sec don't work, +# - 1 sec is not much of a win compared to 2 sec, and +# - it takes 2 seconds to perform the test whether 1 sec works. +# +# Instead, just use the default 2s on platforms that have 1s resolution, +# accept the extra 1s delay when using $sleep in the Automake tests, in +# exchange for not incurring the 2s delay for running the test for all +# packages. +# +am_try_resolutions= +if test "$am_cv_sleep_fractional_seconds" = yes; then + # Even a millisecond often causes a bunch of false positives, + # so just try a hundredth of a second. The time saved between .001 and + # .01 is not terribly consequential. + am_try_resolutions="0.01 0.1 $am_try_resolutions" +fi + +# In order to catch current-generation FAT out, we must *modify* files +# that already exist; the *creation* timestamp is finer. Use names +# that make ls -t sort them differently when they have equal +# timestamps than when they have distinct timestamps, keeping +# in mind that ls -t prints the *newest* file first. +rm -f conftest.ts? +: > conftest.ts1 +: > conftest.ts2 +: > conftest.ts3 + +# Make sure ls -t actually works. Do 'set' in a subshell so we don't +# clobber the current shell's arguments. (Outer-level square brackets +# are removed by m4; they're present so that m4 does not expand +# ; be careful, easy to get confused.) +if ( + set X `ls -t conftest.ts[12]` && + { + test "$*" != "X conftest.ts1 conftest.ts2" || + test "$*" != "X conftest.ts2 conftest.ts1"; + } +); then :; else + # If neither matched, then we have a broken ls. This can happen + # if, for instance, CONFIG_SHELL is bash and it inherits a + # broken ls alias from the environment. This has actually + # happened. Such a system could not be considered "sane". + printf "%s\n" ""Bad output from ls -t: \"`ls -t conftest.ts[12]`\""" >&5 + { { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error $? "ls -t produces unexpected output. +Make sure there is not a broken ls alias in your environment. +See 'config.log' for more details" "$LINENO" 5; } +fi + +for am_try_res in $am_try_resolutions; do + # Any one fine-grained sleep might happen to cross the boundary + # between two values of a coarser actual resolution, but if we do + # two fine-grained sleeps in a row, at least one of them will fall + # entirely within a coarse interval. + echo alpha > conftest.ts1 + sleep $am_try_res + echo beta > conftest.ts2 + sleep $am_try_res + echo gamma > conftest.ts3 + + # We assume that 'ls -t' will make use of high-resolution + # timestamps if the operating system supports them at all. + if (set X `ls -t conftest.ts?` && + test "$2" = conftest.ts3 && + test "$3" = conftest.ts2 && + test "$4" = conftest.ts1); then + # + # Ok, ls -t worked. If we're at a resolution of 1 second, we're done, + # because we don't need to test make. + make_ok=true + if test $am_try_res != 1; then + # But if we've succeeded so far with a subsecond resolution, we + # have one more thing to check: make. It can happen that + # everything else supports the subsecond mtimes, but make doesn't; + # notably on macOS, which ships make 3.81 from 2006 (the last one + # released under GPLv2). https://bugs.gnu.org/68808 + # + # We test $MAKE if it is defined in the environment, else "make". + # It might get overridden later, but our hope is that in practice + # it does not matter: it is the system "make" which is (by far) + # the most likely to be broken, whereas if the user overrides it, + # probably they did so with a better, or at least not worse, make. + # https://lists.gnu.org/archive/html/automake/2024-06/msg00051.html + # + # Create a Makefile (real tab character here): + rm -f conftest.mk + echo 'conftest.ts1: conftest.ts2' >conftest.mk + echo ' touch conftest.ts2' >>conftest.mk + # + # Now, running + # touch conftest.ts1; touch conftest.ts2; make + # should touch ts1 because ts2 is newer. This could happen by luck, + # but most often, it will fail if make's support is insufficient. So + # test for several consecutive successes. + # + # (We reuse conftest.ts[12] because we still want to modify existing + # files, not create new ones, per above.) + n=0 + make=${MAKE-make} + until test $n -eq 3; do + echo one > conftest.ts1 + sleep $am_try_res + echo two > conftest.ts2 # ts2 should now be newer than ts1 + if $make -f conftest.mk | grep 'up to date' >/dev/null; then + make_ok=false + break # out of $n loop + fi + n=`expr $n + 1` + done + fi + # + if $make_ok; then + # Everything we know to check worked out, so call this resolution good. + am_cv_filesystem_timestamp_resolution=$am_try_res + break # out of $am_try_res loop + fi + # Otherwise, we'll go on to check the next resolution. + fi +done +rm -f conftest.ts? +# (end _am_filesystem_timestamp_resolution) + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_filesystem_timestamp_resolution" >&5 +printf "%s\n" "$am_cv_filesystem_timestamp_resolution" >&6; } + +# This check should not be cached, as it may vary across builds of +# different projects. +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether build environment is sane" >&5 +printf %s "checking whether build environment is sane... " >&6; } +# Reject unsafe characters in $srcdir or the absolute working directory +# name. Accept space and tab only in the latter. +am_lf=' +' +case `pwd` in + *[\\\"\#\$\&\'\`$am_lf]*) + as_fn_error $? "unsafe absolute working directory name" "$LINENO" 5;; +esac +case $srcdir in + *[\\\"\#\$\&\'\`$am_lf\ \ ]*) + as_fn_error $? "unsafe srcdir value: '$srcdir'" "$LINENO" 5;; +esac + +# Do 'set' in a subshell so we don't clobber the current shell's +# arguments. Must try -L first in case configure is actually a +# symlink; some systems play weird games with the mod time of symlinks +# (eg FreeBSD returns the mod time of the symlink's containing +# directory). +am_build_env_is_sane=no +am_has_slept=no +rm -f conftest.file +for am_try in 1 2; do + echo "timestamp, slept: $am_has_slept" > conftest.file + if ( + set X `ls -Lt "$srcdir/configure" conftest.file 2> /dev/null` + if test "$*" = "X"; then + # -L didn't work. + set X `ls -t "$srcdir/configure" conftest.file` + fi + test "$2" = conftest.file + ); then + am_build_env_is_sane=yes + break + fi + # Just in case. + sleep "$am_cv_filesystem_timestamp_resolution" + am_has_slept=yes +done + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_build_env_is_sane" >&5 +printf "%s\n" "$am_build_env_is_sane" >&6; } +if test "$am_build_env_is_sane" = no; then + as_fn_error $? "newly created file is older than distributed files! +Check your system clock" "$LINENO" 5 +fi + +# If we didn't sleep, we still need to ensure time stamps of config.status and +# generated files are strictly newer. +am_sleep_pid= +if test -e conftest.file || grep 'slept: no' conftest.file >/dev/null 2>&1 +then : + +else case e in #( + e) ( sleep "$am_cv_filesystem_timestamp_resolution" ) & + am_sleep_pid=$! + ;; +esac +fi + +rm -f conftest.file + +test "$program_prefix" != NONE && + program_transform_name="s&^&$program_prefix&;$program_transform_name" +# Use a double $ so make ignores it. +test "$program_suffix" != NONE && + program_transform_name="s&\$&$program_suffix&;$program_transform_name" +# Double any \ or $. +# By default was 's,x,x', remove it if useless. +ac_script='s/[\\$]/&&/g;s/;s,x,x,$//' +program_transform_name=`printf "%s\n" "$program_transform_name" | sed "$ac_script"` + + +# Expand $ac_aux_dir to an absolute path. +am_aux_dir=`cd "$ac_aux_dir" && pwd` + + + if test x"${MISSING+set}" != xset; then + MISSING="\${SHELL} '$am_aux_dir/missing'" +fi +# Use eval to expand $SHELL +if eval "$MISSING --is-lightweight"; then + am_missing_run="$MISSING " +else + am_missing_run= + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: 'missing' script is too old or missing" >&5 +printf "%s\n" "$as_me: WARNING: 'missing' script is too old or missing" >&2;} +fi + +if test x"${install_sh+set}" != xset; then + case $am_aux_dir in + *\ * | *\ *) + install_sh="\${SHELL} '$am_aux_dir/install-sh'" ;; + *) + install_sh="\${SHELL} $am_aux_dir/install-sh" + esac +fi + +# Installed binaries are usually stripped using 'strip' when the user +# run "make install-strip". However 'strip' might not be the right +# tool to use in cross-compilation environments, therefore Automake +# will honor the 'STRIP' environment variable to overrule this program. +if test "$cross_compiling" != no; then + if test -n "$ac_tool_prefix"; then + # Extract the first word of "${ac_tool_prefix}strip", so it can be a program name with args. +set dummy ${ac_tool_prefix}strip; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_STRIP+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$STRIP"; then + ac_cv_prog_STRIP="$STRIP" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_STRIP="${ac_tool_prefix}strip" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +STRIP=$ac_cv_prog_STRIP +if test -n "$STRIP"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $STRIP" >&5 +printf "%s\n" "$STRIP" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + +fi +if test -z "$ac_cv_prog_STRIP"; then + ac_ct_STRIP=$STRIP + # Extract the first word of "strip", so it can be a program name with args. +set dummy strip; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_ac_ct_STRIP+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$ac_ct_STRIP"; then + ac_cv_prog_ac_ct_STRIP="$ac_ct_STRIP" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_ac_ct_STRIP="strip" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +ac_ct_STRIP=$ac_cv_prog_ac_ct_STRIP +if test -n "$ac_ct_STRIP"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_ct_STRIP" >&5 +printf "%s\n" "$ac_ct_STRIP" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + if test "x$ac_ct_STRIP" = x; then + STRIP=":" + else + case $cross_compiling:$ac_tool_warned in +yes:) +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 +printf "%s\n" "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} +ac_tool_warned=yes ;; +esac + STRIP=$ac_ct_STRIP + fi +else + STRIP="$ac_cv_prog_STRIP" +fi + +fi +INSTALL_STRIP_PROGRAM="\$(install_sh) -c -s" + + + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for a race-free mkdir -p" >&5 +printf %s "checking for a race-free mkdir -p... " >&6; } +if test -z "$MKDIR_P"; then + if test ${ac_cv_path_mkdir+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH$PATH_SEPARATOR/opt/sfw/bin +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_prog in mkdir gmkdir; do + for ac_exec_ext in '' $ac_executable_extensions; do + as_fn_executable_p "$as_dir$ac_prog$ac_exec_ext" || continue + case `"$as_dir$ac_prog$ac_exec_ext" --version 2>&1` in #( + 'mkdir ('*'coreutils) '* | \ + *'BusyBox '* | \ + 'mkdir (fileutils) '4.1*) + ac_cv_path_mkdir=$as_dir$ac_prog$ac_exec_ext + break 3;; + esac + done + done + done +IFS=$as_save_IFS + ;; +esac +fi + + test -d ./--version && rmdir ./--version + if test ${ac_cv_path_mkdir+y}; then + MKDIR_P="$ac_cv_path_mkdir -p" + else + # As a last resort, use plain mkdir -p, + # in the hope it doesn't have the bugs of ancient mkdir. + MKDIR_P='mkdir -p' + fi +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $MKDIR_P" >&5 +printf "%s\n" "$MKDIR_P" >&6; } + +for ac_prog in gawk mawk nawk awk +do + # Extract the first word of "$ac_prog", so it can be a program name with args. +set dummy $ac_prog; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_AWK+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$AWK"; then + ac_cv_prog_AWK="$AWK" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_AWK="$ac_prog" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +AWK=$ac_cv_prog_AWK +if test -n "$AWK"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $AWK" >&5 +printf "%s\n" "$AWK" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + + test -n "$AWK" && break +done + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether ${MAKE-make} sets \$(MAKE)" >&5 +printf %s "checking whether ${MAKE-make} sets \$(MAKE)... " >&6; } +set x ${MAKE-make} +ac_make=`printf "%s\n" "$2" | sed 's/+/p/g; s/[^a-zA-Z0-9_]/_/g'` +if eval test \${ac_cv_prog_make_${ac_make}_set+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) cat >conftest.make <<\_ACEOF +SHELL = /bin/sh +all: + @echo '@@@%%%=$(MAKE)=@@@%%%' +_ACEOF +# GNU make sometimes prints "make[1]: Entering ...", which would confuse us. +case `${MAKE-make} -f conftest.make 2>/dev/null` in + *@@@%%%=?*=@@@%%%*) + eval ac_cv_prog_make_${ac_make}_set=yes;; + *) + eval ac_cv_prog_make_${ac_make}_set=no;; +esac +rm -f conftest.make ;; +esac +fi +if eval test \$ac_cv_prog_make_${ac_make}_set = yes; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +printf "%s\n" "yes" >&6; } + SET_MAKE= +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } + SET_MAKE="MAKE=${MAKE-make}" +fi + +rm -rf .tst 2>/dev/null +mkdir .tst 2>/dev/null +if test -d .tst; then + am__leading_dot=. +else + am__leading_dot=_ +fi +rmdir .tst 2>/dev/null + +AM_DEFAULT_VERBOSITY=1 +# Check whether --enable-silent-rules was given. +if test ${enable_silent_rules+y} +then : + enableval=$enable_silent_rules; +fi + +am_make=${MAKE-make} +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether $am_make supports nested variables" >&5 +printf %s "checking whether $am_make supports nested variables... " >&6; } +if test ${am_cv_make_support_nested_variables+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if printf "%s\n" 'TRUE=$(BAR$(V)) +BAR0=false +BAR1=true +V=1 +am__doit: + @$(TRUE) +.PHONY: am__doit' | $am_make -f - >/dev/null 2>&1; then + am_cv_make_support_nested_variables=yes +else + am_cv_make_support_nested_variables=no +fi ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_make_support_nested_variables" >&5 +printf "%s\n" "$am_cv_make_support_nested_variables" >&6; } +AM_BACKSLASH='\' + +am__rm_f_notfound= +if (rm -f && rm -fr && rm -rf) 2>/dev/null +then : + +else case e in #( + e) am__rm_f_notfound='""' ;; +esac +fi + + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking xargs -n works" >&5 +printf %s "checking xargs -n works... " >&6; } +if test ${am_cv_xargs_n_works+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test "`echo 1 2 3 | xargs -n2 echo`" = "1 2 +3" +then : + am_cv_xargs_n_works=yes +else case e in #( + e) am_cv_xargs_n_works=no ;; +esac +fi ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_xargs_n_works" >&5 +printf "%s\n" "$am_cv_xargs_n_works" >&6; } +if test "$am_cv_xargs_n_works" = yes +then : + am__xargs_n='xargs -n' +else case e in #( + e) am__xargs_n='am__xargs_n () { shift; sed "s/ /\\n/g" | while read am__xargs_n_arg; do "" "$am__xargs_n_arg"; done; }' + ;; +esac +fi + +if test "`cd $srcdir && pwd`" != "`pwd`"; then + # Use -I$(srcdir) only when $(srcdir) != ., so that make's output + # is not polluted with repeated "-I." + am__isrc=' -I$(srcdir)' + # test to see if srcdir already configured + if test -f $srcdir/config.status; then + as_fn_error $? "source directory already configured; run \"make distclean\" there first" "$LINENO" 5 + fi +fi + +# test whether we have cygpath +if test -z "$CYGPATH_W"; then + if (cygpath --version) >/dev/null 2>/dev/null; then + CYGPATH_W='cygpath -w' + else + CYGPATH_W=echo + fi +fi + + +# Define the identity of the package. + PACKAGE='asio' + VERSION='1.36.0' + + +printf "%s\n" "#define PACKAGE \"$PACKAGE\"" >>confdefs.h + + +printf "%s\n" "#define VERSION \"$VERSION\"" >>confdefs.h + +# Some tools Automake needs. + +ACLOCAL=${ACLOCAL-"${am_missing_run}aclocal-${am__api_version}"} + + +AUTOCONF=${AUTOCONF-"${am_missing_run}autoconf"} + + +AUTOMAKE=${AUTOMAKE-"${am_missing_run}automake-${am__api_version}"} + + +AUTOHEADER=${AUTOHEADER-"${am_missing_run}autoheader"} + + +MAKEINFO=${MAKEINFO-"${am_missing_run}makeinfo"} + +# For better backward compatibility. To be removed once Automake 1.9.x +# dies out for good. For more background, see: +# +# +mkdir_p='$(MKDIR_P)' + +# We need awk for the "check" target (and possibly the TAP driver). The +# system "awk" is bad on some platforms. +# Always define AMTAR for backward compatibility. Yes, it's still used +# in the wild :-( We should find a proper way to deprecate it ... +AMTAR='$${TAR-tar}' + + +# We'll loop over all known methods to create a tar archive until one works. +_am_tools='gnutar pax cpio none' + + + + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking how to create a pax tar archive" >&5 +printf %s "checking how to create a pax tar archive... " >&6; } + + # Go ahead even if we have the value already cached. We do so because we + # need to set the values for the 'am__tar' and 'am__untar' variables. + _am_tools=${am_cv_prog_tar_pax-$_am_tools} + + for _am_tool in $_am_tools; do + case $_am_tool in + gnutar) + for _am_tar in tar gnutar gtar; do + { echo "$as_me:$LINENO: $_am_tar --version" >&5 + ($_am_tar --version) >&5 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } && break + done + am__tar="$_am_tar --format=posix -chf - "'"$$tardir"' + am__tar_="$_am_tar --format=posix -chf - "'"$tardir"' + am__untar="$_am_tar -xf -" + ;; + plaintar) + # Must skip GNU tar: if it does not support --format= it doesn't create + # ustar tarball either. + (tar --version) >/dev/null 2>&1 && continue + am__tar='tar chf - "$$tardir"' + am__tar_='tar chf - "$tardir"' + am__untar='tar xf -' + ;; + pax) + am__tar='pax -L -x pax -w "$$tardir"' + am__tar_='pax -L -x pax -w "$tardir"' + am__untar='pax -r' + ;; + cpio) + am__tar='find "$$tardir" -print | cpio -o -H pax -L' + am__tar_='find "$tardir" -print | cpio -o -H pax -L' + am__untar='cpio -i -H pax -d' + ;; + none) + am__tar=false + am__tar_=false + am__untar=false + ;; + esac + + # If the value was cached, stop now. We just wanted to have am__tar + # and am__untar set. + test -n "${am_cv_prog_tar_pax}" && break + + # tar/untar a dummy directory, and stop if the command works. + rm -rf conftest.dir + mkdir conftest.dir + echo GrepMe > conftest.dir/file + { echo "$as_me:$LINENO: tardir=conftest.dir && eval $am__tar_ >conftest.tar" >&5 + (tardir=conftest.dir && eval $am__tar_ >conftest.tar) >&5 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } + rm -rf conftest.dir + if test -s conftest.tar; then + { echo "$as_me:$LINENO: $am__untar &5 + ($am__untar &5 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } + { echo "$as_me:$LINENO: cat conftest.dir/file" >&5 + (cat conftest.dir/file) >&5 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } + grep GrepMe conftest.dir/file >/dev/null 2>&1 && break + fi + done + rm -rf conftest.dir + + if test ${am_cv_prog_tar_pax+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) am_cv_prog_tar_pax=$_am_tool ;; +esac +fi + + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_prog_tar_pax" >&5 +printf "%s\n" "$am_cv_prog_tar_pax" >&6; } + + + + + +# Variables for tags utilities; see am/tags.am +if test -z "$CTAGS"; then + CTAGS=ctags +fi + +if test -z "$ETAGS"; then + ETAGS=etags +fi + +if test -z "$CSCOPE"; then + CSCOPE=cscope +fi + + + + + + + + + + + # Make sure we can run config.sub. +$SHELL "${ac_aux_dir}config.sub" sun4 >/dev/null 2>&1 || + as_fn_error $? "cannot run $SHELL ${ac_aux_dir}config.sub" "$LINENO" 5 + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking build system type" >&5 +printf %s "checking build system type... " >&6; } +if test ${ac_cv_build+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_build_alias=$build_alias +test "x$ac_build_alias" = x && + ac_build_alias=`$SHELL "${ac_aux_dir}config.guess"` +test "x$ac_build_alias" = x && + as_fn_error $? "cannot guess build type; you must specify one" "$LINENO" 5 +ac_cv_build=`$SHELL "${ac_aux_dir}config.sub" $ac_build_alias` || + as_fn_error $? "$SHELL ${ac_aux_dir}config.sub $ac_build_alias failed" "$LINENO" 5 + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_build" >&5 +printf "%s\n" "$ac_cv_build" >&6; } +case $ac_cv_build in +*-*-*) ;; +*) as_fn_error $? "invalid value of canonical build" "$LINENO" 5;; +esac +build=$ac_cv_build +ac_save_IFS=$IFS; IFS='-' +set x $ac_cv_build +shift +build_cpu=$1 +build_vendor=$2 +shift; shift +# Remember, the first character of IFS is used to create $*, +# except with old shells: +build_os=$* +IFS=$ac_save_IFS +case $build_os in *\ *) build_os=`echo "$build_os" | sed 's/ /-/g'`;; esac + + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking host system type" >&5 +printf %s "checking host system type... " >&6; } +if test ${ac_cv_host+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test "x$host_alias" = x; then + ac_cv_host=$ac_cv_build +else + ac_cv_host=`$SHELL "${ac_aux_dir}config.sub" $host_alias` || + as_fn_error $? "$SHELL ${ac_aux_dir}config.sub $host_alias failed" "$LINENO" 5 +fi + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_host" >&5 +printf "%s\n" "$ac_cv_host" >&6; } +case $ac_cv_host in +*-*-*) ;; +*) as_fn_error $? "invalid value of canonical host" "$LINENO" 5;; +esac +host=$ac_cv_host +ac_save_IFS=$IFS; IFS='-' +set x $ac_cv_host +shift +host_cpu=$1 +host_vendor=$2 +shift; shift +# Remember, the first character of IFS is used to create $*, +# except with old shells: +host_os=$* +IFS=$ac_save_IFS +case $host_os in *\ *) host_os=`echo "$host_os" | sed 's/ /-/g'`;; esac + + + + + + + + + + + +DEPDIR="${am__leading_dot}deps" + +ac_config_commands="$ac_config_commands depfiles" + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether ${MAKE-make} supports the include directive" >&5 +printf %s "checking whether ${MAKE-make} supports the include directive... " >&6; } +cat > confinc.mk << 'END' +am__doit: + @echo this is the am__doit target >confinc.out +.PHONY: am__doit +END +am__include="#" +am__quote= +# BSD make does it like this. +echo '.include "confinc.mk" # ignored' > confmf.BSD +# Other make implementations (GNU, Solaris 10, AIX) do it like this. +echo 'include confinc.mk # ignored' > confmf.GNU +_am_result=no +for s in GNU BSD; do + { echo "$as_me:$LINENO: ${MAKE-make} -f confmf.$s && cat confinc.out" >&5 + (${MAKE-make} -f confmf.$s && cat confinc.out) >&5 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } + case $?:`cat confinc.out 2>/dev/null` in #( + '0:this is the am__doit target') : + case $s in #( + BSD) : + am__include='.include' am__quote='"' ;; #( + *) : + am__include='include' am__quote='' ;; +esac ;; #( + *) : + ;; +esac + if test "$am__include" != "#"; then + _am_result="yes ($s style)" + break + fi +done +rm -f confinc.* confmf.* +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: ${_am_result}" >&5 +printf "%s\n" "${_am_result}" >&6; } + +# Check whether --enable-dependency-tracking was given. +if test ${enable_dependency_tracking+y} +then : + enableval=$enable_dependency_tracking; +fi + +if test "x$enable_dependency_tracking" != xno; then + am_depcomp="$ac_aux_dir/depcomp" + AMDEPBACKSLASH='\' + am__nodep='_no' +fi + if test "x$enable_dependency_tracking" != xno; then + AMDEP_TRUE= + AMDEP_FALSE='#' +else + AMDEP_TRUE='#' + AMDEP_FALSE= +fi + + +ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu +if test -n "$ac_tool_prefix"; then + # Extract the first word of "${ac_tool_prefix}gcc", so it can be a program name with args. +set dummy ${ac_tool_prefix}gcc; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$CC"; then + ac_cv_prog_CC="$CC" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_CC="${ac_tool_prefix}gcc" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +CC=$ac_cv_prog_CC +if test -n "$CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 +printf "%s\n" "$CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + +fi +if test -z "$ac_cv_prog_CC"; then + ac_ct_CC=$CC + # Extract the first word of "gcc", so it can be a program name with args. +set dummy gcc; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_ac_ct_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$ac_ct_CC"; then + ac_cv_prog_ac_ct_CC="$ac_ct_CC" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_ac_ct_CC="gcc" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +ac_ct_CC=$ac_cv_prog_ac_ct_CC +if test -n "$ac_ct_CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CC" >&5 +printf "%s\n" "$ac_ct_CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + if test "x$ac_ct_CC" = x; then + CC="" + else + case $cross_compiling:$ac_tool_warned in +yes:) +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 +printf "%s\n" "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} +ac_tool_warned=yes ;; +esac + CC=$ac_ct_CC + fi +else + CC="$ac_cv_prog_CC" +fi + +if test -z "$CC"; then + if test -n "$ac_tool_prefix"; then + # Extract the first word of "${ac_tool_prefix}cc", so it can be a program name with args. +set dummy ${ac_tool_prefix}cc; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$CC"; then + ac_cv_prog_CC="$CC" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_CC="${ac_tool_prefix}cc" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +CC=$ac_cv_prog_CC +if test -n "$CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 +printf "%s\n" "$CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + + fi +fi +if test -z "$CC"; then + # Extract the first word of "cc", so it can be a program name with args. +set dummy cc; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$CC"; then + ac_cv_prog_CC="$CC" # Let the user override the test. +else + ac_prog_rejected=no +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + if test "$as_dir$ac_word$ac_exec_ext" = "/usr/ucb/cc"; then + ac_prog_rejected=yes + continue + fi + ac_cv_prog_CC="cc" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +if test $ac_prog_rejected = yes; then + # We found a bogon in the path, so make sure we never use it. + set dummy $ac_cv_prog_CC + shift + if test $# != 0; then + # We chose a different compiler from the bogus one. + # However, it has the same basename, so the bogon will be chosen + # first if we set CC to just the basename; use the full file name. + shift + ac_cv_prog_CC="$as_dir$ac_word${1+' '}$@" + fi +fi +fi ;; +esac +fi +CC=$ac_cv_prog_CC +if test -n "$CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 +printf "%s\n" "$CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + +fi +if test -z "$CC"; then + if test -n "$ac_tool_prefix"; then + for ac_prog in cl.exe + do + # Extract the first word of "$ac_tool_prefix$ac_prog", so it can be a program name with args. +set dummy $ac_tool_prefix$ac_prog; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$CC"; then + ac_cv_prog_CC="$CC" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_CC="$ac_tool_prefix$ac_prog" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +CC=$ac_cv_prog_CC +if test -n "$CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 +printf "%s\n" "$CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + + test -n "$CC" && break + done +fi +if test -z "$CC"; then + ac_ct_CC=$CC + for ac_prog in cl.exe +do + # Extract the first word of "$ac_prog", so it can be a program name with args. +set dummy $ac_prog; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_ac_ct_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$ac_ct_CC"; then + ac_cv_prog_ac_ct_CC="$ac_ct_CC" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_ac_ct_CC="$ac_prog" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +ac_ct_CC=$ac_cv_prog_ac_ct_CC +if test -n "$ac_ct_CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CC" >&5 +printf "%s\n" "$ac_ct_CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + + test -n "$ac_ct_CC" && break +done + + if test "x$ac_ct_CC" = x; then + CC="" + else + case $cross_compiling:$ac_tool_warned in +yes:) +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 +printf "%s\n" "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} +ac_tool_warned=yes ;; +esac + CC=$ac_ct_CC + fi +fi + +fi +if test -z "$CC"; then + if test -n "$ac_tool_prefix"; then + # Extract the first word of "${ac_tool_prefix}clang", so it can be a program name with args. +set dummy ${ac_tool_prefix}clang; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$CC"; then + ac_cv_prog_CC="$CC" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_CC="${ac_tool_prefix}clang" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +CC=$ac_cv_prog_CC +if test -n "$CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 +printf "%s\n" "$CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + +fi +if test -z "$ac_cv_prog_CC"; then + ac_ct_CC=$CC + # Extract the first word of "clang", so it can be a program name with args. +set dummy clang; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_ac_ct_CC+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$ac_ct_CC"; then + ac_cv_prog_ac_ct_CC="$ac_ct_CC" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_ac_ct_CC="clang" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +ac_ct_CC=$ac_cv_prog_ac_ct_CC +if test -n "$ac_ct_CC"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CC" >&5 +printf "%s\n" "$ac_ct_CC" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + if test "x$ac_ct_CC" = x; then + CC="" + else + case $cross_compiling:$ac_tool_warned in +yes:) +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 +printf "%s\n" "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} +ac_tool_warned=yes ;; +esac + CC=$ac_ct_CC + fi +else + CC="$ac_cv_prog_CC" +fi + +fi + + +test -z "$CC" && { { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error $? "no acceptable C compiler found in \$PATH +See 'config.log' for more details" "$LINENO" 5; } + +# Provide some information about the compiler. +printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for C compiler version" >&5 +set X $ac_compile +ac_compiler=$2 +for ac_option in --version -v -V -qversion -version; do + { { ac_try="$ac_compiler $ac_option >&5" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_compiler $ac_option >&5") 2>conftest.err + ac_status=$? + if test -s conftest.err; then + sed '10a\ +... rest of stderr output deleted ... + 10q' conftest.err >conftest.er1 + cat conftest.er1 >&5 + fi + rm -f conftest.er1 conftest.err + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } +done + +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +ac_clean_files_save=$ac_clean_files +ac_clean_files="$ac_clean_files a.out a.out.dSYM a.exe b.out" +# Try to create an executable without -o first, disregard a.out. +# It will help us diagnose broken compilers, and finding out an intuition +# of exeext. +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether the C compiler works" >&5 +printf %s "checking whether the C compiler works... " >&6; } +ac_link_default=`printf "%s\n" "$ac_link" | sed 's/ -o *conftest[^ ]*//'` + +# The possible output files: +ac_files="a.out conftest.exe conftest a.exe a_out.exe b.out conftest.*" + +ac_rmfiles= +for ac_file in $ac_files +do + case $ac_file in + *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) ;; + * ) ac_rmfiles="$ac_rmfiles $ac_file";; + esac +done +rm -f $ac_rmfiles + +if { { ac_try="$ac_link_default" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_link_default") 2>&5 + ac_status=$? + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } +then : + # Autoconf-2.13 could set the ac_cv_exeext variable to 'no'. +# So ignore a value of 'no', otherwise this would lead to 'EXEEXT = no' +# in a Makefile. We should not override ac_cv_exeext if it was cached, +# so that the user can short-circuit this test for compilers unknown to +# Autoconf. +for ac_file in $ac_files '' +do + test -f "$ac_file" || continue + case $ac_file in + *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) + ;; + [ab].out ) + # We found the default executable, but exeext='' is most + # certainly right. + break;; + *.* ) + if test ${ac_cv_exeext+y} && test "$ac_cv_exeext" != no; + then :; else + ac_cv_exeext=`expr "$ac_file" : '[^.]*\(\..*\)'` + fi + # We set ac_cv_exeext here because the later test for it is not + # safe: cross compilers may not add the suffix if given an '-o' + # argument, so we may need to know it at that point already. + # Even if this section looks crufty: it has the advantage of + # actually working. + break;; + * ) + break;; + esac +done +test "$ac_cv_exeext" = no && ac_cv_exeext= + +else case e in #( + e) ac_file='' ;; +esac +fi +if test -z "$ac_file" +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +printf "%s\n" "$as_me: failed program was:" >&5 +sed 's/^/| /' conftest.$ac_ext >&5 + +{ { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error 77 "C compiler cannot create executables +See 'config.log' for more details" "$LINENO" 5; } +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +printf "%s\n" "yes" >&6; } ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for C compiler default output file name" >&5 +printf %s "checking for C compiler default output file name... " >&6; } +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_file" >&5 +printf "%s\n" "$ac_file" >&6; } +ac_exeext=$ac_cv_exeext + +rm -f -r a.out a.out.dSYM a.exe conftest$ac_cv_exeext b.out +ac_clean_files=$ac_clean_files_save +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for suffix of executables" >&5 +printf %s "checking for suffix of executables... " >&6; } +if { { ac_try="$ac_link" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_link") 2>&5 + ac_status=$? + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } +then : + # If both 'conftest.exe' and 'conftest' are 'present' (well, observable) +# catch 'conftest.exe'. For instance with Cygwin, 'ls conftest' will +# work properly (i.e., refer to 'conftest.exe'), while it won't with +# 'rm'. +for ac_file in conftest.exe conftest conftest.*; do + test -f "$ac_file" || continue + case $ac_file in + *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) ;; + *.* ) ac_cv_exeext=`expr "$ac_file" : '[^.]*\(\..*\)'` + break;; + * ) break;; + esac +done +else case e in #( + e) { { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error $? "cannot compute suffix of executables: cannot compile and link +See 'config.log' for more details" "$LINENO" 5; } ;; +esac +fi +rm -f conftest conftest$ac_cv_exeext +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_exeext" >&5 +printf "%s\n" "$ac_cv_exeext" >&6; } + +rm -f conftest.$ac_ext +EXEEXT=$ac_cv_exeext +ac_exeext=$EXEEXT +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +#include +int +main (void) +{ +FILE *f = fopen ("conftest.out", "w"); + if (!f) + return 1; + return ferror (f) || fclose (f) != 0; + + ; + return 0; +} +_ACEOF +ac_clean_files="$ac_clean_files conftest.out" +# Check that the compiler produces executables we can run. If not, either +# the compiler is broken, or we cross compile. +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether we are cross compiling" >&5 +printf %s "checking whether we are cross compiling... " >&6; } +if test "$cross_compiling" != yes; then + { { ac_try="$ac_link" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_link") 2>&5 + ac_status=$? + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } + if { ac_try='./conftest$ac_cv_exeext' + { { case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_try") 2>&5 + ac_status=$? + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; }; }; then + cross_compiling=no + else + if test "$cross_compiling" = maybe; then + cross_compiling=yes + else + { { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error 77 "cannot run C compiled programs. +If you meant to cross compile, use '--host'. +See 'config.log' for more details" "$LINENO" 5; } + fi + fi +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $cross_compiling" >&5 +printf "%s\n" "$cross_compiling" >&6; } + +rm -f conftest.$ac_ext conftest$ac_cv_exeext \ + conftest.o conftest.obj conftest.out +ac_clean_files=$ac_clean_files_save +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for suffix of object files" >&5 +printf %s "checking for suffix of object files... " >&6; } +if test ${ac_cv_objext+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +rm -f conftest.o conftest.obj +if { { ac_try="$ac_compile" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_compile") 2>&5 + ac_status=$? + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } +then : + for ac_file in conftest.o conftest.obj conftest.*; do + test -f "$ac_file" || continue; + case $ac_file in + *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM ) ;; + *) ac_cv_objext=`expr "$ac_file" : '.*\.\(.*\)'` + break;; + esac +done +else case e in #( + e) printf "%s\n" "$as_me: failed program was:" >&5 +sed 's/^/| /' conftest.$ac_ext >&5 + +{ { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error $? "cannot compute suffix of object files: cannot compile +See 'config.log' for more details" "$LINENO" 5; } ;; +esac +fi +rm -f conftest.$ac_cv_objext conftest.$ac_ext ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_objext" >&5 +printf "%s\n" "$ac_cv_objext" >&6; } +OBJEXT=$ac_cv_objext +ac_objext=$OBJEXT +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether the compiler supports GNU C" >&5 +printf %s "checking whether the compiler supports GNU C... " >&6; } +if test ${ac_cv_c_compiler_gnu+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ +#ifndef __GNUC__ + choke me +#endif + + ; + return 0; +} +_ACEOF +if ac_fn_c_try_compile "$LINENO" +then : + ac_compiler_gnu=yes +else case e in #( + e) ac_compiler_gnu=no ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext +ac_cv_c_compiler_gnu=$ac_compiler_gnu + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_c_compiler_gnu" >&5 +printf "%s\n" "$ac_cv_c_compiler_gnu" >&6; } +ac_compiler_gnu=$ac_cv_c_compiler_gnu + +if test $ac_compiler_gnu = yes; then + GCC=yes +else + GCC= +fi +ac_test_CFLAGS=${CFLAGS+y} +ac_save_CFLAGS=$CFLAGS +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether $CC accepts -g" >&5 +printf %s "checking whether $CC accepts -g... " >&6; } +if test ${ac_cv_prog_cc_g+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_save_c_werror_flag=$ac_c_werror_flag + ac_c_werror_flag=yes + ac_cv_prog_cc_g=no + CFLAGS="-g" + cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_c_try_compile "$LINENO" +then : + ac_cv_prog_cc_g=yes +else case e in #( + e) CFLAGS="" + cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_c_try_compile "$LINENO" +then : + +else case e in #( + e) ac_c_werror_flag=$ac_save_c_werror_flag + CFLAGS="-g" + cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_c_try_compile "$LINENO" +then : + ac_cv_prog_cc_g=yes +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext + ac_c_werror_flag=$ac_save_c_werror_flag ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_g" >&5 +printf "%s\n" "$ac_cv_prog_cc_g" >&6; } +if test $ac_test_CFLAGS; then + CFLAGS=$ac_save_CFLAGS +elif test $ac_cv_prog_cc_g = yes; then + if test "$GCC" = yes; then + CFLAGS="-g -O2" + else + CFLAGS="-g" + fi +else + if test "$GCC" = yes; then + CFLAGS="-O2" + else + CFLAGS= + fi +fi +ac_prog_cc_stdc=no +if test x$ac_prog_cc_stdc = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $CC option to enable C11 features" >&5 +printf %s "checking for $CC option to enable C11 features... " >&6; } +if test ${ac_cv_prog_cc_c11+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_cv_prog_cc_c11=no +ac_save_CC=$CC +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +$ac_c_conftest_c11_program +_ACEOF +for ac_arg in '' -std=gnu11 +do + CC="$ac_save_CC $ac_arg" + if ac_fn_c_try_compile "$LINENO" +then : + ac_cv_prog_cc_c11=$ac_arg +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam + test "x$ac_cv_prog_cc_c11" != "xno" && break +done +rm -f conftest.$ac_ext +CC=$ac_save_CC ;; +esac +fi + +if test "x$ac_cv_prog_cc_c11" = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: unsupported" >&5 +printf "%s\n" "unsupported" >&6; } +else case e in #( + e) if test "x$ac_cv_prog_cc_c11" = x +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: none needed" >&5 +printf "%s\n" "none needed" >&6; } +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_c11" >&5 +printf "%s\n" "$ac_cv_prog_cc_c11" >&6; } + CC="$CC $ac_cv_prog_cc_c11" ;; +esac +fi + ac_cv_prog_cc_stdc=$ac_cv_prog_cc_c11 + ac_prog_cc_stdc=c11 ;; +esac +fi +fi +if test x$ac_prog_cc_stdc = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $CC option to enable C99 features" >&5 +printf %s "checking for $CC option to enable C99 features... " >&6; } +if test ${ac_cv_prog_cc_c99+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_cv_prog_cc_c99=no +ac_save_CC=$CC +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +$ac_c_conftest_c99_program +_ACEOF +for ac_arg in '' -std=gnu99 -std=c99 -c99 -qlanglvl=extc1x -qlanglvl=extc99 -AC99 -D_STDC_C99= +do + CC="$ac_save_CC $ac_arg" + if ac_fn_c_try_compile "$LINENO" +then : + ac_cv_prog_cc_c99=$ac_arg +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam + test "x$ac_cv_prog_cc_c99" != "xno" && break +done +rm -f conftest.$ac_ext +CC=$ac_save_CC ;; +esac +fi + +if test "x$ac_cv_prog_cc_c99" = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: unsupported" >&5 +printf "%s\n" "unsupported" >&6; } +else case e in #( + e) if test "x$ac_cv_prog_cc_c99" = x +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: none needed" >&5 +printf "%s\n" "none needed" >&6; } +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_c99" >&5 +printf "%s\n" "$ac_cv_prog_cc_c99" >&6; } + CC="$CC $ac_cv_prog_cc_c99" ;; +esac +fi + ac_cv_prog_cc_stdc=$ac_cv_prog_cc_c99 + ac_prog_cc_stdc=c99 ;; +esac +fi +fi +if test x$ac_prog_cc_stdc = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $CC option to enable C89 features" >&5 +printf %s "checking for $CC option to enable C89 features... " >&6; } +if test ${ac_cv_prog_cc_c89+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_cv_prog_cc_c89=no +ac_save_CC=$CC +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +$ac_c_conftest_c89_program +_ACEOF +for ac_arg in '' -qlanglvl=extc89 -qlanglvl=ansi -std -Ae "-Aa -D_HPUX_SOURCE" "-Xc -D__EXTENSIONS__" +do + CC="$ac_save_CC $ac_arg" + if ac_fn_c_try_compile "$LINENO" +then : + ac_cv_prog_cc_c89=$ac_arg +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam + test "x$ac_cv_prog_cc_c89" != "xno" && break +done +rm -f conftest.$ac_ext +CC=$ac_save_CC ;; +esac +fi + +if test "x$ac_cv_prog_cc_c89" = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: unsupported" >&5 +printf "%s\n" "unsupported" >&6; } +else case e in #( + e) if test "x$ac_cv_prog_cc_c89" = x +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: none needed" >&5 +printf "%s\n" "none needed" >&6; } +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_c89" >&5 +printf "%s\n" "$ac_cv_prog_cc_c89" >&6; } + CC="$CC $ac_cv_prog_cc_c89" ;; +esac +fi + ac_cv_prog_cc_stdc=$ac_cv_prog_cc_c89 + ac_prog_cc_stdc=c89 ;; +esac +fi +fi + +ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu + + + ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether $CC understands -c and -o together" >&5 +printf %s "checking whether $CC understands -c and -o together... " >&6; } +if test ${am_cv_prog_cc_c_o+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF + # Make sure it works both with $CC and with simple cc. + # Following AC_PROG_CC_C_O, we do the test twice because some + # compilers refuse to overwrite an existing .o file with -o, + # though they will create one. + am_cv_prog_cc_c_o=yes + for am_i in 1 2; do + if { echo "$as_me:$LINENO: $CC -c conftest.$ac_ext -o conftest2.$ac_objext" >&5 + ($CC -c conftest.$ac_ext -o conftest2.$ac_objext) >&5 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } \ + && test -f conftest2.$ac_objext; then + : OK + else + am_cv_prog_cc_c_o=no + break + fi + done + rm -f core conftest* + unset am_i ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_prog_cc_c_o" >&5 +printf "%s\n" "$am_cv_prog_cc_c_o" >&6; } +if test "$am_cv_prog_cc_c_o" != yes; then + # Losing compiler, so override with the script. + # FIXME: It is wrong to rewrite CC. + # But if we don't then we get into trouble of one sort or another. + # A longer-term fix would be to have automake use am__CC in this case, + # and then we could set am__CC="\$(top_srcdir)/compile \$(CC)" + CC="$am_aux_dir/compile $CC" +fi +ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu + + +depcc="$CC" am_compiler_list= + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking dependency style of $depcc" >&5 +printf %s "checking dependency style of $depcc... " >&6; } +if test ${am_cv_CC_dependencies_compiler_type+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -z "$AMDEP_TRUE" && test -f "$am_depcomp"; then + # We make a subdir and do the tests there. Otherwise we can end up + # making bogus files that we don't know about and never remove. For + # instance it was reported that on HP-UX the gcc test will end up + # making a dummy file named 'D' -- because '-MD' means "put the output + # in D". + rm -rf conftest.dir + mkdir conftest.dir + # Copy depcomp to subdir because otherwise we won't find it if we're + # using a relative directory. + cp "$am_depcomp" conftest.dir + cd conftest.dir + # We will build objects and dependencies in a subdirectory because + # it helps to detect inapplicable dependency modes. For instance + # both Tru64's cc and ICC support -MD to output dependencies as a + # side effect of compilation, but ICC will put the dependencies in + # the current directory while Tru64 will put them in the object + # directory. + mkdir sub + + am_cv_CC_dependencies_compiler_type=none + if test "$am_compiler_list" = ""; then + am_compiler_list=`sed -n 's/^#*\([a-zA-Z0-9]*\))$/\1/p' < ./depcomp` + fi + am__universal=false + case " $depcc " in #( + *\ -arch\ *\ -arch\ *) am__universal=true ;; + esac + + for depmode in $am_compiler_list; do + # Setup a source with many dependencies, because some compilers + # like to wrap large dependency lists on column 80 (with \), and + # we should not choose a depcomp mode which is confused by this. + # + # We need to recreate these files for each test, as the compiler may + # overwrite some of them when testing with obscure command lines. + # This happens at least with the AIX C compiler. + : > sub/conftest.c + for i in 1 2 3 4 5 6; do + echo '#include "conftst'$i'.h"' >> sub/conftest.c + # Using ": > sub/conftst$i.h" creates only sub/conftst1.h with + # Solaris 10 /bin/sh. + echo '/* dummy */' > sub/conftst$i.h + done + echo "${am__include} ${am__quote}sub/conftest.Po${am__quote}" > confmf + + # We check with '-c' and '-o' for the sake of the "dashmstdout" + # mode. It turns out that the SunPro C++ compiler does not properly + # handle '-M -o', and we need to detect this. Also, some Intel + # versions had trouble with output in subdirs. + am__obj=sub/conftest.${OBJEXT-o} + am__minus_obj="-o $am__obj" + case $depmode in + gcc) + # This depmode causes a compiler race in universal mode. + test "$am__universal" = false || continue + ;; + nosideeffect) + # After this tag, mechanisms are not by side-effect, so they'll + # only be used when explicitly requested. + if test "x$enable_dependency_tracking" = xyes; then + continue + else + break + fi + ;; + msvc7 | msvc7msys | msvisualcpp | msvcmsys) + # This compiler won't grok '-c -o', but also, the minuso test has + # not run yet. These depmodes are late enough in the game, and + # so weak that their functioning should not be impacted. + am__obj=conftest.${OBJEXT-o} + am__minus_obj= + ;; + none) break ;; + esac + if depmode=$depmode \ + source=sub/conftest.c object=$am__obj \ + depfile=sub/conftest.Po tmpdepfile=sub/conftest.TPo \ + $SHELL ./depcomp $depcc -c $am__minus_obj sub/conftest.c \ + >/dev/null 2>conftest.err && + grep sub/conftst1.h sub/conftest.Po > /dev/null 2>&1 && + grep sub/conftst6.h sub/conftest.Po > /dev/null 2>&1 && + grep $am__obj sub/conftest.Po > /dev/null 2>&1 && + ${MAKE-make} -s -f confmf > /dev/null 2>&1; then + # icc doesn't choke on unknown options, it will just issue warnings + # or remarks (even with -Werror). So we grep stderr for any message + # that says an option was ignored or not supported. + # When given -MP, icc 7.0 and 7.1 complain thus: + # icc: Command line warning: ignoring option '-M'; no argument required + # The diagnosis changed in icc 8.0: + # icc: Command line remark: option '-MP' not supported + if (grep 'ignoring option' conftest.err || + grep 'not supported' conftest.err) >/dev/null 2>&1; then :; else + am_cv_CC_dependencies_compiler_type=$depmode + break + fi + fi + done + + cd .. + rm -rf conftest.dir +else + am_cv_CC_dependencies_compiler_type=none +fi + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_CC_dependencies_compiler_type" >&5 +printf "%s\n" "$am_cv_CC_dependencies_compiler_type" >&6; } +CCDEPMODE=depmode=$am_cv_CC_dependencies_compiler_type + + if + test "x$enable_dependency_tracking" != xno \ + && test "$am_cv_CC_dependencies_compiler_type" = gcc3; then + am__fastdepCC_TRUE= + am__fastdepCC_FALSE='#' +else + am__fastdepCC_TRUE='#' + am__fastdepCC_FALSE= +fi + + + + + + + + + +ac_ext=cpp +ac_cpp='$CXXCPP $CPPFLAGS' +ac_compile='$CXX -c $CXXFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CXX -o conftest$ac_exeext $CXXFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_cxx_compiler_gnu +if test -z "$CXX"; then + if test -n "$CCC"; then + CXX=$CCC + else + if test -n "$ac_tool_prefix"; then + for ac_prog in g++ c++ gpp aCC CC cxx cc++ cl.exe FCC KCC RCC xlC_r xlC clang++ + do + # Extract the first word of "$ac_tool_prefix$ac_prog", so it can be a program name with args. +set dummy $ac_tool_prefix$ac_prog; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_CXX+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$CXX"; then + ac_cv_prog_CXX="$CXX" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_CXX="$ac_tool_prefix$ac_prog" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +CXX=$ac_cv_prog_CXX +if test -n "$CXX"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $CXX" >&5 +printf "%s\n" "$CXX" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + + test -n "$CXX" && break + done +fi +if test -z "$CXX"; then + ac_ct_CXX=$CXX + for ac_prog in g++ c++ gpp aCC CC cxx cc++ cl.exe FCC KCC RCC xlC_r xlC clang++ +do + # Extract the first word of "$ac_prog", so it can be a program name with args. +set dummy $ac_prog; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_ac_ct_CXX+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$ac_ct_CXX"; then + ac_cv_prog_ac_ct_CXX="$ac_ct_CXX" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_ac_ct_CXX="$ac_prog" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +ac_ct_CXX=$ac_cv_prog_ac_ct_CXX +if test -n "$ac_ct_CXX"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CXX" >&5 +printf "%s\n" "$ac_ct_CXX" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + + test -n "$ac_ct_CXX" && break +done + + if test "x$ac_ct_CXX" = x; then + CXX="g++" + else + case $cross_compiling:$ac_tool_warned in +yes:) +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 +printf "%s\n" "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} +ac_tool_warned=yes ;; +esac + CXX=$ac_ct_CXX + fi +fi + + fi +fi +# Provide some information about the compiler. +printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for C++ compiler version" >&5 +set X $ac_compile +ac_compiler=$2 +for ac_option in --version -v -V -qversion; do + { { ac_try="$ac_compiler $ac_option >&5" +case "(($ac_try" in + *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; + *) ac_try_echo=$ac_try;; +esac +eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" +printf "%s\n" "$ac_try_echo"; } >&5 + (eval "$ac_compiler $ac_option >&5") 2>conftest.err + ac_status=$? + if test -s conftest.err; then + sed '10a\ +... rest of stderr output deleted ... + 10q' conftest.err >conftest.er1 + cat conftest.er1 >&5 + fi + rm -f conftest.er1 conftest.err + printf "%s\n" "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 + test $ac_status = 0; } +done + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether the compiler supports GNU C++" >&5 +printf %s "checking whether the compiler supports GNU C++... " >&6; } +if test ${ac_cv_cxx_compiler_gnu+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ +#ifndef __GNUC__ + choke me +#endif + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + ac_compiler_gnu=yes +else case e in #( + e) ac_compiler_gnu=no ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext +ac_cv_cxx_compiler_gnu=$ac_compiler_gnu + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_cxx_compiler_gnu" >&5 +printf "%s\n" "$ac_cv_cxx_compiler_gnu" >&6; } +ac_compiler_gnu=$ac_cv_cxx_compiler_gnu + +if test $ac_compiler_gnu = yes; then + GXX=yes +else + GXX= +fi +ac_test_CXXFLAGS=${CXXFLAGS+y} +ac_save_CXXFLAGS=$CXXFLAGS +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether $CXX accepts -g" >&5 +printf %s "checking whether $CXX accepts -g... " >&6; } +if test ${ac_cv_prog_cxx_g+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_save_cxx_werror_flag=$ac_cxx_werror_flag + ac_cxx_werror_flag=yes + ac_cv_prog_cxx_g=no + CXXFLAGS="-g" + cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + ac_cv_prog_cxx_g=yes +else case e in #( + e) CXXFLAGS="" + cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + +else case e in #( + e) ac_cxx_werror_flag=$ac_save_cxx_werror_flag + CXXFLAGS="-g" + cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + ac_cv_prog_cxx_g=yes +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext + ac_cxx_werror_flag=$ac_save_cxx_werror_flag ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cxx_g" >&5 +printf "%s\n" "$ac_cv_prog_cxx_g" >&6; } +if test $ac_test_CXXFLAGS; then + CXXFLAGS=$ac_save_CXXFLAGS +elif test $ac_cv_prog_cxx_g = yes; then + if test "$GXX" = yes; then + CXXFLAGS="-g -O2" + else + CXXFLAGS="-g" + fi +else + if test "$GXX" = yes; then + CXXFLAGS="-O2" + else + CXXFLAGS= + fi +fi +ac_prog_cxx_stdcxx=no +if test x$ac_prog_cxx_stdcxx = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $CXX option to enable C++11 features" >&5 +printf %s "checking for $CXX option to enable C++11 features... " >&6; } +if test ${ac_cv_prog_cxx_cxx11+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_cv_prog_cxx_cxx11=no +ac_save_CXX=$CXX +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +$ac_cxx_conftest_cxx11_program +_ACEOF +for ac_arg in '' -std=gnu++11 -std=gnu++0x -std=c++11 -std=c++0x -qlanglvl=extended0x -AA +do + CXX="$ac_save_CXX $ac_arg" + if ac_fn_cxx_try_compile "$LINENO" +then : + ac_cv_prog_cxx_cxx11=$ac_arg +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam + test "x$ac_cv_prog_cxx_cxx11" != "xno" && break +done +rm -f conftest.$ac_ext +CXX=$ac_save_CXX ;; +esac +fi + +if test "x$ac_cv_prog_cxx_cxx11" = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: unsupported" >&5 +printf "%s\n" "unsupported" >&6; } +else case e in #( + e) if test "x$ac_cv_prog_cxx_cxx11" = x +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: none needed" >&5 +printf "%s\n" "none needed" >&6; } +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cxx_cxx11" >&5 +printf "%s\n" "$ac_cv_prog_cxx_cxx11" >&6; } + CXX="$CXX $ac_cv_prog_cxx_cxx11" ;; +esac +fi + ac_cv_prog_cxx_stdcxx=$ac_cv_prog_cxx_cxx11 + ac_prog_cxx_stdcxx=cxx11 ;; +esac +fi +fi +if test x$ac_prog_cxx_stdcxx = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $CXX option to enable C++98 features" >&5 +printf %s "checking for $CXX option to enable C++98 features... " >&6; } +if test ${ac_cv_prog_cxx_cxx98+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) ac_cv_prog_cxx_cxx98=no +ac_save_CXX=$CXX +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +$ac_cxx_conftest_cxx98_program +_ACEOF +for ac_arg in '' -std=gnu++98 -std=c++98 -qlanglvl=extended -AA +do + CXX="$ac_save_CXX $ac_arg" + if ac_fn_cxx_try_compile "$LINENO" +then : + ac_cv_prog_cxx_cxx98=$ac_arg +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam + test "x$ac_cv_prog_cxx_cxx98" != "xno" && break +done +rm -f conftest.$ac_ext +CXX=$ac_save_CXX ;; +esac +fi + +if test "x$ac_cv_prog_cxx_cxx98" = xno +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: unsupported" >&5 +printf "%s\n" "unsupported" >&6; } +else case e in #( + e) if test "x$ac_cv_prog_cxx_cxx98" = x +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: none needed" >&5 +printf "%s\n" "none needed" >&6; } +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cxx_cxx98" >&5 +printf "%s\n" "$ac_cv_prog_cxx_cxx98" >&6; } + CXX="$CXX $ac_cv_prog_cxx_cxx98" ;; +esac +fi + ac_cv_prog_cxx_stdcxx=$ac_cv_prog_cxx_cxx98 + ac_prog_cxx_stdcxx=cxx98 ;; +esac +fi +fi + +ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu + +depcc="$CXX" am_compiler_list= + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking dependency style of $depcc" >&5 +printf %s "checking dependency style of $depcc... " >&6; } +if test ${am_cv_CXX_dependencies_compiler_type+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -z "$AMDEP_TRUE" && test -f "$am_depcomp"; then + # We make a subdir and do the tests there. Otherwise we can end up + # making bogus files that we don't know about and never remove. For + # instance it was reported that on HP-UX the gcc test will end up + # making a dummy file named 'D' -- because '-MD' means "put the output + # in D". + rm -rf conftest.dir + mkdir conftest.dir + # Copy depcomp to subdir because otherwise we won't find it if we're + # using a relative directory. + cp "$am_depcomp" conftest.dir + cd conftest.dir + # We will build objects and dependencies in a subdirectory because + # it helps to detect inapplicable dependency modes. For instance + # both Tru64's cc and ICC support -MD to output dependencies as a + # side effect of compilation, but ICC will put the dependencies in + # the current directory while Tru64 will put them in the object + # directory. + mkdir sub + + am_cv_CXX_dependencies_compiler_type=none + if test "$am_compiler_list" = ""; then + am_compiler_list=`sed -n 's/^#*\([a-zA-Z0-9]*\))$/\1/p' < ./depcomp` + fi + am__universal=false + case " $depcc " in #( + *\ -arch\ *\ -arch\ *) am__universal=true ;; + esac + + for depmode in $am_compiler_list; do + # Setup a source with many dependencies, because some compilers + # like to wrap large dependency lists on column 80 (with \), and + # we should not choose a depcomp mode which is confused by this. + # + # We need to recreate these files for each test, as the compiler may + # overwrite some of them when testing with obscure command lines. + # This happens at least with the AIX C compiler. + : > sub/conftest.c + for i in 1 2 3 4 5 6; do + echo '#include "conftst'$i'.h"' >> sub/conftest.c + # Using ": > sub/conftst$i.h" creates only sub/conftst1.h with + # Solaris 10 /bin/sh. + echo '/* dummy */' > sub/conftst$i.h + done + echo "${am__include} ${am__quote}sub/conftest.Po${am__quote}" > confmf + + # We check with '-c' and '-o' for the sake of the "dashmstdout" + # mode. It turns out that the SunPro C++ compiler does not properly + # handle '-M -o', and we need to detect this. Also, some Intel + # versions had trouble with output in subdirs. + am__obj=sub/conftest.${OBJEXT-o} + am__minus_obj="-o $am__obj" + case $depmode in + gcc) + # This depmode causes a compiler race in universal mode. + test "$am__universal" = false || continue + ;; + nosideeffect) + # After this tag, mechanisms are not by side-effect, so they'll + # only be used when explicitly requested. + if test "x$enable_dependency_tracking" = xyes; then + continue + else + break + fi + ;; + msvc7 | msvc7msys | msvisualcpp | msvcmsys) + # This compiler won't grok '-c -o', but also, the minuso test has + # not run yet. These depmodes are late enough in the game, and + # so weak that their functioning should not be impacted. + am__obj=conftest.${OBJEXT-o} + am__minus_obj= + ;; + none) break ;; + esac + if depmode=$depmode \ + source=sub/conftest.c object=$am__obj \ + depfile=sub/conftest.Po tmpdepfile=sub/conftest.TPo \ + $SHELL ./depcomp $depcc -c $am__minus_obj sub/conftest.c \ + >/dev/null 2>conftest.err && + grep sub/conftst1.h sub/conftest.Po > /dev/null 2>&1 && + grep sub/conftst6.h sub/conftest.Po > /dev/null 2>&1 && + grep $am__obj sub/conftest.Po > /dev/null 2>&1 && + ${MAKE-make} -s -f confmf > /dev/null 2>&1; then + # icc doesn't choke on unknown options, it will just issue warnings + # or remarks (even with -Werror). So we grep stderr for any message + # that says an option was ignored or not supported. + # When given -MP, icc 7.0 and 7.1 complain thus: + # icc: Command line warning: ignoring option '-M'; no argument required + # The diagnosis changed in icc 8.0: + # icc: Command line remark: option '-MP' not supported + if (grep 'ignoring option' conftest.err || + grep 'not supported' conftest.err) >/dev/null 2>&1; then :; else + am_cv_CXX_dependencies_compiler_type=$depmode + break + fi + fi + done + + cd .. + rm -rf conftest.dir +else + am_cv_CXX_dependencies_compiler_type=none +fi + ;; +esac +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_CXX_dependencies_compiler_type" >&5 +printf "%s\n" "$am_cv_CXX_dependencies_compiler_type" >&6; } +CXXDEPMODE=depmode=$am_cv_CXX_dependencies_compiler_type + + if + test "x$enable_dependency_tracking" != xno \ + && test "$am_cv_CXX_dependencies_compiler_type" = gcc3; then + am__fastdepCXX_TRUE= + am__fastdepCXX_FALSE='#' +else + am__fastdepCXX_TRUE='#' + am__fastdepCXX_FALSE= +fi + + +ac_ext=cpp +ac_cpp='$CXXCPP $CPPFLAGS' +ac_compile='$CXX -c $CXXFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CXX -o conftest$ac_exeext $CXXFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_cxx_compiler_gnu + +if test -n "$ac_tool_prefix"; then + # Extract the first word of "${ac_tool_prefix}ranlib", so it can be a program name with args. +set dummy ${ac_tool_prefix}ranlib; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_RANLIB+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$RANLIB"; then + ac_cv_prog_RANLIB="$RANLIB" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_RANLIB="${ac_tool_prefix}ranlib" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +RANLIB=$ac_cv_prog_RANLIB +if test -n "$RANLIB"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $RANLIB" >&5 +printf "%s\n" "$RANLIB" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + +fi +if test -z "$ac_cv_prog_RANLIB"; then + ac_ct_RANLIB=$RANLIB + # Extract the first word of "ranlib", so it can be a program name with args. +set dummy ranlib; ac_word=$2 +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +printf %s "checking for $ac_word... " >&6; } +if test ${ac_cv_prog_ac_ct_RANLIB+y} +then : + printf %s "(cached) " >&6 +else case e in #( + e) if test -n "$ac_ct_RANLIB"; then + ac_cv_prog_ac_ct_RANLIB="$ac_ct_RANLIB" # Let the user override the test. +else +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + for ac_exec_ext in '' $ac_executable_extensions; do + if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then + ac_cv_prog_ac_ct_RANLIB="ranlib" + printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + +fi ;; +esac +fi +ac_ct_RANLIB=$ac_cv_prog_ac_ct_RANLIB +if test -n "$ac_ct_RANLIB"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_ct_RANLIB" >&5 +printf "%s\n" "$ac_ct_RANLIB" >&6; } +else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } +fi + + if test "x$ac_ct_RANLIB" = x; then + RANLIB=":" + else + case $cross_compiling:$ac_tool_warned in +yes:) +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 +printf "%s\n" "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} +ac_tool_warned=yes ;; +esac + RANLIB=$ac_ct_RANLIB + fi +else + RANLIB="$ac_cv_prog_RANLIB" +fi + +PKG_NOARCH_INSTALLDIR + + +printf "%s\n" "#define _REENTRANT 1" >>confdefs.h + + + +# Check whether --with-boost was given. +if test ${with_boost+y} +then : + withval=$with_boost; + if test "${withval}" = no; then + STANDALONE="yes" + else + if test "${withval}" != system; then + CPPFLAGS="$CPPFLAGS -I${withval}" + LIBS="$LIBS -L${withval}/stage/lib" + fi + CPPFLAGS="$CPPFLAGS -DASIO_ENABLE_BOOST -DBOOST_CHRONO_HEADER_ONLY -DBOOST_CHRONO_DONT_PROVIDE_HYBRID_ERROR_HANDLING" + fi + +else case e in #( + e) + STANDALONE="yes" + ;; +esac +fi + + +# Check whether --enable-separate-compilation was given. +if test ${enable_separate_compilation+y} +then : + enableval=$enable_separate_compilation; + SEPARATE_COMPILATION=yes + +fi + + +# Check whether --enable-boost-coroutine was given. +if test ${enable_boost_coroutine+y} +then : + enableval=$enable_boost_coroutine; + HAVE_BOOST_COROUTINE=yes + +fi + + +if test "$STANDALONE" != yes; then + +ac_header= ac_cache= +for ac_item in $ac_header_cxx_list +do + if test $ac_cache; then + ac_fn_cxx_check_header_compile "$LINENO" $ac_header ac_cv_header_$ac_cache "$ac_includes_default" + if eval test \"x\$ac_cv_header_$ac_cache\" = xyes; then + printf "%s\n" "#define $ac_item 1" >> confdefs.h + fi + ac_header= ac_cache= + elif test $ac_header; then + ac_cache=$ac_item + else + ac_header=$ac_item + fi +done + + + + + + + + +if test $ac_cv_header_stdlib_h = yes && test $ac_cv_header_string_h = yes +then : + +printf "%s\n" "#define STDC_HEADERS 1" >>confdefs.h + +fi +ac_fn_cxx_check_header_compile "$LINENO" "boost/noncopyable.hpp" "ac_cv_header_boost_noncopyable_hpp" "$ac_includes_default" +if test "x$ac_cv_header_boost_noncopyable_hpp" = xyes +then : + +else case e in #( + e) + echo "Can't find boost headers. Please check the location of the boost" + echo "distribution and rerun configure using the --with-boost=DIR option." + echo "Alternatively, run with --without-boost to enable standalone build." + exit 1 + ;; +esac +fi + +fi + + +# Check whether --with-openssl was given. +if test ${with_openssl+y} +then : + withval=$with_openssl; + CPPFLAGS="$CPPFLAGS -I${withval}/include" + LIBS="$LIBS -L${withval}/lib" + +fi + + +ac_fn_cxx_check_header_compile "$LINENO" "openssl/ssl.h" "ac_cv_header_openssl_ssl_h" "$ac_includes_default" +if test "x$ac_cv_header_openssl_ssl_h" = xyes +then : + +else case e in #( + e) + OPENSSL_FOUND=no + ;; +esac +fi + + +if test x$OPENSSL_FOUND != xno; then + LIBS="$LIBS -lssl -lcrypto" +fi + + if test x$OPENSSL_FOUND != xno; then + HAVE_OPENSSL_TRUE= + HAVE_OPENSSL_FALSE='#' +else + HAVE_OPENSSL_TRUE='#' + HAVE_OPENSSL_FALSE= +fi + + +WINDOWS=no +case $host in + *-*-linux*) + CXXFLAGS="$CXXFLAGS -pthread" + LDFLAGS="$LDFLAGS -pthread" + LIBS="$LIBS -lrt" + ;; + *-*-solaris*) + if test "$GXX" = yes; then + CXXFLAGS="$CXXFLAGS -D_PTHREADS" + else + # We'll assume Sun's CC. + CXXFLAGS="$CXXFLAGS -mt" + fi + LIBS="$LIBS -lsocket -lnsl -lpthread" + ;; + *-*-mingw32*) + CXXFLAGS="$CXXFLAGS -mthreads" + LDFLAGS="$LDFLAGS -mthreads" + LIBS="$LIBS -lws2_32 -lmswsock" + WINDOWS=yes + ;; + *-*-mingw64*) + CXXFLAGS="$CXXFLAGS -mthreads" + LDFLAGS="$LDFLAGS -mthreads" + LIBS="$LIBS -lws2_32 -lmswsock" + WINDOWS=yes + ;; + *-pc-cygwin*) + CXXFLAGS="$CXXFLAGS -D__USE_W32_SOCKETS -D_WIN32_WINNT=0x0601" + LIBS="$LIBS -lws2_32 -lmswsock" + WINDOWS=yes + ;; + *-apple-darwin*) + CXXFLAGS="$CXXFLAGS" + LDFLAGS="$LDFLAGS" + ;; + *-*-freebsd*) + CXXFLAGS="$CXXFLAGS -pthread" + LDFLAGS="$LDFLAGS -pthread" + ;; + *-*-netbsd*) + CXXFLAGS="$CXXFLAGS -pthread" + LDFLAGS="$LDFLAGS -pthread" + ;; + *-*-haiku*) + CXXFLAGS="$CXXFLAGS -lnetwork" + LDFLAGS="$LDFLAGS -lnetwork" + +esac + +if test "$GXX" = yes; then + CXXFLAGS="$CXXFLAGS -ftemplate-depth-256" +fi + +if test "$STANDALONE" = yes; then + CPPFLAGS="$CPPFLAGS -DASIO_STANDALONE" +fi + +if test "$SEPARATE_COMPILATION" = yes; then + CPPFLAGS="$CPPFLAGS -DASIO_SEPARATE_COMPILATION" +fi + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether C++11 is enabled" >&5 +printf %s "checking whether C++11 is enabled... " >&6; } +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +#if __cplusplus < 201103L + #error C++11 not available + #endif +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +printf "%s\n" "yes" >&6; } + HAVE_CXX11=yes; +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } + HAVE_CXX11=no; ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether C++14 is enabled" >&5 +printf %s "checking whether C++14 is enabled... " >&6; } +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +#if defined(__GNUC__) && !defined(__clang__) + # if (__GNUC__ <= 6) + # error C++14 support on this compiler not sufficiently compliant + # endif + #endif + #if __cplusplus < 201402L + #error C++14 not available + #endif +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +printf "%s\n" "yes" >&6; } + HAVE_CXX14=yes; +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } + HAVE_CXX14=no; ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether C++17 is enabled" >&5 +printf %s "checking whether C++17 is enabled... " >&6; } +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +#if __cplusplus < 201703L + #error C++17 not available + #endif +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +printf "%s\n" "yes" >&6; } + HAVE_CXX17=yes; +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } + HAVE_CXX17=no; ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether C++20 is enabled" >&5 +printf %s "checking whether C++20 is enabled... " >&6; } +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +#if __cplusplus < 202002L + #error C++20 not available + #endif +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +printf "%s\n" "yes" >&6; } + HAVE_CXX20=yes; +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } + HAVE_CXX20=no; ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext + +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether coroutines are enabled" >&5 +printf %s "checking whether coroutines are enabled... " >&6; } +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ +#if defined(__clang__) + # if (__clang_major__ >= 14) + # if (__cplusplus >= 202002) && (__cpp_impl_coroutine >= 201902) + # if __has_include() + # define ASIO_HAS_CO_AWAIT 1 + # endif + # elif (__cplusplus >= 201703) && (__cpp_coroutines >= 201703) + # if __has_include() + # define ASIO_HAS_CO_AWAIT 1 + # endif + # endif + # else + # if (__cplusplus >= 201703) && (__cpp_coroutines >= 201703) + # if __has_include() + # define ASIO_HAS_CO_AWAIT 1 + # endif + # endif + # endif + #elif defined(__GNUC__) + # if (__cplusplus >= 201709) && (__cpp_impl_coroutine >= 201902) + # if __has_include() + # define ASIO_HAS_CO_AWAIT 1 + # endif + # endif + #endif + #ifndef ASIO_HAS_CO_AWAIT + # error coroutines not available + #endif +int +main (void) +{ + + ; + return 0; +} +_ACEOF +if ac_fn_cxx_try_compile "$LINENO" +then : + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +printf "%s\n" "yes" >&6; } + HAVE_COROUTINES=yes; +else case e in #( + e) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 +printf "%s\n" "no" >&6; } + HAVE_COROUTINES=no; ;; +esac +fi +rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext + +if test "$GXX" = yes; then + if test "$STANDALONE" = yes; then + if test "$HAVE_CXX11" = no; then + HAVE_CXX11=yes + CPPFLAGS="-std=c++0x $CPPFLAGS" + fi + fi +fi + + if test x$STANDALONE = xyes; then + STANDALONE_TRUE= + STANDALONE_FALSE='#' +else + STANDALONE_TRUE='#' + STANDALONE_FALSE= +fi + + + if test x$SEPARATE_COMPILATION = xyes; then + SEPARATE_COMPILATION_TRUE= + SEPARATE_COMPILATION_FALSE='#' +else + SEPARATE_COMPILATION_TRUE='#' + SEPARATE_COMPILATION_FALSE= +fi + + + if test x$HAVE_BOOST_COROUTINE = xyes; then + HAVE_BOOST_COROUTINE_TRUE= + HAVE_BOOST_COROUTINE_FALSE='#' +else + HAVE_BOOST_COROUTINE_TRUE='#' + HAVE_BOOST_COROUTINE_FALSE= +fi + + + if test x$WINDOWS != xno; then + WINDOWS_TARGET_TRUE= + WINDOWS_TARGET_FALSE='#' +else + WINDOWS_TARGET_TRUE='#' + WINDOWS_TARGET_FALSE= +fi + + + if test x$HAVE_CXX11 = xyes; then + HAVE_CXX11_TRUE= + HAVE_CXX11_FALSE='#' +else + HAVE_CXX11_TRUE='#' + HAVE_CXX11_FALSE= +fi + + + if test x$HAVE_CXX14 = xyes; then + HAVE_CXX14_TRUE= + HAVE_CXX14_FALSE='#' +else + HAVE_CXX14_TRUE='#' + HAVE_CXX14_FALSE= +fi + + + if test x$HAVE_CXX17 = xyes; then + HAVE_CXX17_TRUE= + HAVE_CXX17_FALSE='#' +else + HAVE_CXX17_TRUE='#' + HAVE_CXX17_FALSE= +fi + + + if test x$HAVE_CXX20 = xyes; then + HAVE_CXX20_TRUE= + HAVE_CXX20_FALSE='#' +else + HAVE_CXX20_TRUE='#' + HAVE_CXX20_FALSE= +fi + + + if test x$HAVE_COROUTINES = xyes; then + HAVE_COROUTINES_TRUE= + HAVE_COROUTINES_FALSE='#' +else + HAVE_COROUTINES_TRUE='#' + HAVE_COROUTINES_FALSE= +fi + + +ac_config_files="$ac_config_files asio.pc" + + +ac_config_files="$ac_config_files Makefile include/Makefile src/Makefile src/tests/Makefile src/tests/properties/Makefile src/examples/cpp11/Makefile src/examples/cpp14/Makefile src/examples/cpp17/Makefile src/examples/cpp20/Makefile" + +cat >confcache <<\_ACEOF +# This file is a shell script that caches the results of configure +# tests run on this system so they can be shared between configure +# scripts and configure runs, see configure's option --config-cache. +# It is not useful on other systems. If it contains results you don't +# want to keep, you may remove or edit it. +# +# config.status only pays attention to the cache file if you give it +# the --recheck option to rerun configure. +# +# 'ac_cv_env_foo' variables (set or unset) will be overridden when +# loading this file, other *unset* 'ac_cv_foo' will be assigned the +# following values. + +_ACEOF + +# The following way of writing the cache mishandles newlines in values, +# but we know of no workaround that is simple, portable, and efficient. +# So, we kill variables containing newlines. +# Ultrix sh set writes to stderr and can't be redirected directly, +# and sets the high bit in the cache file unless we assign to the vars. +( + for ac_var in `(set) 2>&1 | sed -n 's/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'`; do + eval ac_val=\$$ac_var + case $ac_val in #( + *${as_nl}*) + case $ac_var in #( + *_cv_*) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 +printf "%s\n" "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; + esac + case $ac_var in #( + _ | IFS | as_nl) ;; #( + BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( + *) { eval $ac_var=; unset $ac_var;} ;; + esac ;; + esac + done + + (set) 2>&1 | + case $as_nl`(ac_space=' '; set) 2>&1` in #( + *${as_nl}ac_space=\ *) + # 'set' does not quote correctly, so add quotes: double-quote + # substitution turns \\\\ into \\, and sed turns \\ into \. + sed -n \ + "s/'/'\\\\''/g; + s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\\2'/p" + ;; #( + *) + # 'set' quotes correctly as required by POSIX, so do not add quotes. + sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" + ;; + esac | + sort +) | + sed ' + /^ac_cv_env_/b end + t clear + :clear + s/^\([^=]*\)=\(.*[{}].*\)$/test ${\1+y} || &/ + t end + s/^\([^=]*\)=\(.*\)$/\1=${\1=\2}/ + :end' >>confcache +if diff "$cache_file" confcache >/dev/null 2>&1; then :; else + if test -w "$cache_file"; then + if test "x$cache_file" != "x/dev/null"; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: updating cache $cache_file" >&5 +printf "%s\n" "$as_me: updating cache $cache_file" >&6;} + if test ! -f "$cache_file" || test -h "$cache_file"; then + cat confcache >"$cache_file" + else + case $cache_file in #( + */* | ?:*) + mv -f confcache "$cache_file"$$ && + mv -f "$cache_file"$$ "$cache_file" ;; #( + *) + mv -f confcache "$cache_file" ;; + esac + fi + fi + else + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: not updating unwritable cache $cache_file" >&5 +printf "%s\n" "$as_me: not updating unwritable cache $cache_file" >&6;} + fi +fi +rm -f confcache + +test "x$prefix" = xNONE && prefix=$ac_default_prefix +# Let make expand exec_prefix. +test "x$exec_prefix" = xNONE && exec_prefix='${prefix}' + +# Transform confdefs.h into DEFS. +# Protect against shell expansion while executing Makefile rules. +# Protect against Makefile macro expansion. +# +# If the first sed substitution is executed (which looks for macros that +# take arguments), then branch to the quote section. Otherwise, +# look for a macro that doesn't take arguments. +ac_script=' +:mline +/\\$/{ + N + s,\\\n,, + b mline +} +t clear +:clear +s/^[ ]*#[ ]*define[ ][ ]*\([^ (][^ (]*([^)]*)\)[ ]*\(.*\)/-D\1=\2/g +t quote +s/^[ ]*#[ ]*define[ ][ ]*\([^ ][^ ]*\)[ ]*\(.*\)/-D\1=\2/g +t quote +b any +:quote +s/[][ `~#$^&*(){}\\|;'\''"<>?]/\\&/g +s/\$/$$/g +H +:any +${ + g + s/^\n// + s/\n/ /g + p +} +' +DEFS=`sed -n "$ac_script" confdefs.h` + + +ac_libobjs= +ac_ltlibobjs= +U= +for ac_i in : $LIBOBJS; do test "x$ac_i" = x: && continue + # 1. Remove the extension, and $U if already installed. + ac_script='s/\$U\././;s/\.o$//;s/\.obj$//' + ac_i=`printf "%s\n" "$ac_i" | sed "$ac_script"` + # 2. Prepend LIBOBJDIR. When used with automake>=1.10 LIBOBJDIR + # will be set to the directory where LIBOBJS objects are built. + as_fn_append ac_libobjs " \${LIBOBJDIR}$ac_i\$U.$ac_objext" + as_fn_append ac_ltlibobjs " \${LIBOBJDIR}$ac_i"'$U.lo' +done +LIBOBJS=$ac_libobjs + +LTLIBOBJS=$ac_ltlibobjs + + +if test -z "${MAINTAINER_MODE_TRUE}" && test -z "${MAINTAINER_MODE_FALSE}"; then + as_fn_error $? "conditional \"MAINTAINER_MODE\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking that generated files are newer than configure" >&5 +printf %s "checking that generated files are newer than configure... " >&6; } + if test -n "$am_sleep_pid"; then + # Hide warnings about reused PIDs. + wait $am_sleep_pid 2>/dev/null + fi + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: done" >&5 +printf "%s\n" "done" >&6; } +case $enable_silent_rules in # ((( + yes) AM_DEFAULT_VERBOSITY=0;; + no) AM_DEFAULT_VERBOSITY=1;; +esac +if test $am_cv_make_support_nested_variables = yes; then + AM_V='$(V)' + AM_DEFAULT_V='$(AM_DEFAULT_VERBOSITY)' +else + AM_V=$AM_DEFAULT_VERBOSITY + AM_DEFAULT_V=$AM_DEFAULT_VERBOSITY +fi + + if test -n "$EXEEXT"; then + am__EXEEXT_TRUE= + am__EXEEXT_FALSE='#' +else + am__EXEEXT_TRUE='#' + am__EXEEXT_FALSE= +fi + +if test -z "${AMDEP_TRUE}" && test -z "${AMDEP_FALSE}"; then + as_fn_error $? "conditional \"AMDEP\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${am__fastdepCC_TRUE}" && test -z "${am__fastdepCC_FALSE}"; then + as_fn_error $? "conditional \"am__fastdepCC\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${am__fastdepCXX_TRUE}" && test -z "${am__fastdepCXX_FALSE}"; then + as_fn_error $? "conditional \"am__fastdepCXX\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${HAVE_OPENSSL_TRUE}" && test -z "${HAVE_OPENSSL_FALSE}"; then + as_fn_error $? "conditional \"HAVE_OPENSSL\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${STANDALONE_TRUE}" && test -z "${STANDALONE_FALSE}"; then + as_fn_error $? "conditional \"STANDALONE\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${SEPARATE_COMPILATION_TRUE}" && test -z "${SEPARATE_COMPILATION_FALSE}"; then + as_fn_error $? "conditional \"SEPARATE_COMPILATION\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${HAVE_BOOST_COROUTINE_TRUE}" && test -z "${HAVE_BOOST_COROUTINE_FALSE}"; then + as_fn_error $? "conditional \"HAVE_BOOST_COROUTINE\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${WINDOWS_TARGET_TRUE}" && test -z "${WINDOWS_TARGET_FALSE}"; then + as_fn_error $? "conditional \"WINDOWS_TARGET\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${HAVE_CXX11_TRUE}" && test -z "${HAVE_CXX11_FALSE}"; then + as_fn_error $? "conditional \"HAVE_CXX11\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${HAVE_CXX14_TRUE}" && test -z "${HAVE_CXX14_FALSE}"; then + as_fn_error $? "conditional \"HAVE_CXX14\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${HAVE_CXX17_TRUE}" && test -z "${HAVE_CXX17_FALSE}"; then + as_fn_error $? "conditional \"HAVE_CXX17\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${HAVE_CXX20_TRUE}" && test -z "${HAVE_CXX20_FALSE}"; then + as_fn_error $? "conditional \"HAVE_CXX20\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${HAVE_COROUTINES_TRUE}" && test -z "${HAVE_COROUTINES_FALSE}"; then + as_fn_error $? "conditional \"HAVE_COROUTINES\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi + +: "${CONFIG_STATUS=./config.status}" +ac_write_fail=0 +ac_clean_files_save=$ac_clean_files +ac_clean_files="$ac_clean_files $CONFIG_STATUS" +{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: creating $CONFIG_STATUS" >&5 +printf "%s\n" "$as_me: creating $CONFIG_STATUS" >&6;} +as_write_fail=0 +cat >$CONFIG_STATUS <<_ASEOF || as_write_fail=1 +#! $SHELL +# Generated by $as_me. +# Run this file to recreate the current configuration. +# Compiler output produced by configure, useful for debugging +# configure, is in config.log if it exists. + +debug=false +ac_cs_recheck=false +ac_cs_silent=false + +SHELL=\${CONFIG_SHELL-$SHELL} +export SHELL +_ASEOF +cat >>$CONFIG_STATUS <<\_ASEOF || as_write_fail=1 +## -------------------- ## +## M4sh Initialization. ## +## -------------------- ## + +# Be more Bourne compatible +DUALCASE=1; export DUALCASE # for MKS sh +if test ${ZSH_VERSION+y} && (emulate sh) >/dev/null 2>&1 +then : + emulate sh + NULLCMD=: + # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which + # is contrary to our usage. Disable this feature. + alias -g '${1+"$@"}'='"$@"' + setopt NO_GLOB_SUBST +else case e in #( + e) case `(set -o) 2>/dev/null` in #( + *posix*) : + set -o posix ;; #( + *) : + ;; +esac ;; +esac +fi + + + +# Reset variables that may have inherited troublesome values from +# the environment. + +# IFS needs to be set, to space, tab, and newline, in precisely that order. +# (If _AS_PATH_WALK were called with IFS unset, it would have the +# side effect of setting IFS to empty, thus disabling word splitting.) +# Quoting is to prevent editors from complaining about space-tab. +as_nl=' +' +export as_nl +IFS=" "" $as_nl" + +PS1='$ ' +PS2='> ' +PS4='+ ' + +# Ensure predictable behavior from utilities with locale-dependent output. +LC_ALL=C +export LC_ALL +LANGUAGE=C +export LANGUAGE + +# We cannot yet rely on "unset" to work, but we need these variables +# to be unset--not just set to an empty or harmless value--now, to +# avoid bugs in old shells (e.g. pre-3.0 UWIN ksh). This construct +# also avoids known problems related to "unset" and subshell syntax +# in other old shells (e.g. bash 2.01 and pdksh 5.2.14). +for as_var in BASH_ENV ENV MAIL MAILPATH CDPATH +do eval test \${$as_var+y} \ + && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : +done + +# Ensure that fds 0, 1, and 2 are open. +if (exec 3>&0) 2>/dev/null; then :; else exec 0&1) 2>/dev/null; then :; else exec 1>/dev/null; fi +if (exec 3>&2) ; then :; else exec 2>/dev/null; fi + +# The user is always right. +if ${PATH_SEPARATOR+false} :; then + PATH_SEPARATOR=: + (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { + (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || + PATH_SEPARATOR=';' + } +fi + + +# Find who we are. Look in the path if we contain no directory separator. +as_myself= +case $0 in #(( + *[\\/]* ) as_myself=$0 ;; + *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + case $as_dir in #((( + '') as_dir=./ ;; + */) ;; + *) as_dir=$as_dir/ ;; + esac + test -r "$as_dir$0" && as_myself=$as_dir$0 && break + done +IFS=$as_save_IFS + + ;; +esac +# We did not find ourselves, most probably we were run as 'sh COMMAND' +# in which case we are not to be found in the path. +if test "x$as_myself" = x; then + as_myself=$0 +fi +if test ! -f "$as_myself"; then + printf "%s\n" "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 + exit 1 +fi + + + +# as_fn_error STATUS ERROR [LINENO LOG_FD] +# ---------------------------------------- +# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are +# provided, also output the error to LOG_FD, referencing LINENO. Then exit the +# script with STATUS, using 1 if that was 0. +as_fn_error () +{ + as_status=$1; test $as_status -eq 0 && as_status=1 + if test "$4"; then + as_lineno=${as_lineno-"$3"} as_lineno_stack=as_lineno_stack=$as_lineno_stack + printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: $2" >&$4 + fi + printf "%s\n" "$as_me: error: $2" >&2 + as_fn_exit $as_status +} # as_fn_error + + +# as_fn_set_status STATUS +# ----------------------- +# Set $? to STATUS, without forking. +as_fn_set_status () +{ + return $1 +} # as_fn_set_status + +# as_fn_exit STATUS +# ----------------- +# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. +as_fn_exit () +{ + set +e + as_fn_set_status $1 + exit $1 +} # as_fn_exit + +# as_fn_unset VAR +# --------------- +# Portably unset VAR. +as_fn_unset () +{ + { eval $1=; unset $1;} +} +as_unset=as_fn_unset + +# as_fn_append VAR VALUE +# ---------------------- +# Append the text in VALUE to the end of the definition contained in VAR. Take +# advantage of any shell optimizations that allow amortized linear growth over +# repeated appends, instead of the typical quadratic growth present in naive +# implementations. +if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null +then : + eval 'as_fn_append () + { + eval $1+=\$2 + }' +else case e in #( + e) as_fn_append () + { + eval $1=\$$1\$2 + } ;; +esac +fi # as_fn_append + +# as_fn_arith ARG... +# ------------------ +# Perform arithmetic evaluation on the ARGs, and store the result in the +# global $as_val. Take advantage of shells that can avoid forks. The arguments +# must be portable across $(()) and expr. +if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null +then : + eval 'as_fn_arith () + { + as_val=$(( $* )) + }' +else case e in #( + e) as_fn_arith () + { + as_val=`expr "$@" || test $? -eq 1` + } ;; +esac +fi # as_fn_arith + + +if expr a : '\(a\)' >/dev/null 2>&1 && + test "X`expr 00001 : '.*\(...\)'`" = X001; then + as_expr=expr +else + as_expr=false +fi + +if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then + as_basename=basename +else + as_basename=false +fi + +if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then + as_dirname=dirname +else + as_dirname=false +fi + +as_me=`$as_basename -- "$0" || +$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ + X"$0" : 'X\(//\)$' \| \ + X"$0" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X/"$0" | + sed '/^.*\/\([^/][^/]*\)\/*$/{ + s//\1/ + q + } + /^X\/\(\/\/\)$/{ + s//\1/ + q + } + /^X\/\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + +# Avoid depending upon Character Ranges. +as_cr_letters='abcdefghijklmnopqrstuvwxyz' +as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' +as_cr_Letters=$as_cr_letters$as_cr_LETTERS +as_cr_digits='0123456789' +as_cr_alnum=$as_cr_Letters$as_cr_digits + + +# Determine whether it's possible to make 'echo' print without a newline. +# These variables are no longer used directly by Autoconf, but are AC_SUBSTed +# for compatibility with existing Makefiles. +ECHO_C= ECHO_N= ECHO_T= +case `echo -n x` in #((((( +-n*) + case `echo 'xy\c'` in + *c*) ECHO_T=' ';; # ECHO_T is single tab character. + xy) ECHO_C='\c';; + *) echo `echo ksh88 bug on AIX 6.1` > /dev/null + ECHO_T=' ';; + esac;; +*) + ECHO_N='-n';; +esac + +# For backward compatibility with old third-party macros, we provide +# the shell variables $as_echo and $as_echo_n. New code should use +# AS_ECHO(["message"]) and AS_ECHO_N(["message"]), respectively. +as_echo='printf %s\n' +as_echo_n='printf %s' + +rm -f conf$$ conf$$.exe conf$$.file +if test -d conf$$.dir; then + rm -f conf$$.dir/conf$$.file +else + rm -f conf$$.dir + mkdir conf$$.dir 2>/dev/null +fi +if (echo >conf$$.file) 2>/dev/null; then + if ln -s conf$$.file conf$$ 2>/dev/null; then + as_ln_s='ln -s' + # ... but there are two gotchas: + # 1) On MSYS, both 'ln -s file dir' and 'ln file dir' fail. + # 2) DJGPP < 2.04 has no symlinks; 'ln -s' creates a wrapper executable. + # In both cases, we have to default to 'cp -pR'. + ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || + as_ln_s='cp -pR' + elif ln conf$$.file conf$$ 2>/dev/null; then + as_ln_s=ln + else + as_ln_s='cp -pR' + fi +else + as_ln_s='cp -pR' +fi +rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file +rmdir conf$$.dir 2>/dev/null + + +# as_fn_mkdir_p +# ------------- +# Create "$as_dir" as a directory, including parents if necessary. +as_fn_mkdir_p () +{ + + case $as_dir in #( + -*) as_dir=./$as_dir;; + esac + test -d "$as_dir" || eval $as_mkdir_p || { + as_dirs= + while :; do + case $as_dir in #( + *\'*) as_qdir=`printf "%s\n" "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( + *) as_qdir=$as_dir;; + esac + as_dirs="'$as_qdir' $as_dirs" + as_dir=`$as_dirname -- "$as_dir" || +$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$as_dir" : 'X\(//\)[^/]' \| \ + X"$as_dir" : 'X\(//\)$' \| \ + X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X"$as_dir" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + test -d "$as_dir" && break + done + test -z "$as_dirs" || eval "mkdir $as_dirs" + } || test -d "$as_dir" || as_fn_error $? "cannot create directory $as_dir" + + +} # as_fn_mkdir_p +if mkdir -p . 2>/dev/null; then + as_mkdir_p='mkdir -p "$as_dir"' +else + test -d ./-p && rmdir ./-p + as_mkdir_p=false +fi + + +# as_fn_executable_p FILE +# ----------------------- +# Test if FILE is an executable regular file. +as_fn_executable_p () +{ + test -f "$1" && test -x "$1" +} # as_fn_executable_p +as_test_x='test -x' +as_executable_p=as_fn_executable_p + +# Sed expression to map a string onto a valid CPP name. +as_sed_cpp="y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g" +as_tr_cpp="eval sed '$as_sed_cpp'" # deprecated + +# Sed expression to map a string onto a valid variable name. +as_sed_sh="y%*+%pp%;s%[^_$as_cr_alnum]%_%g" +as_tr_sh="eval sed '$as_sed_sh'" # deprecated + + +exec 6>&1 +## ----------------------------------- ## +## Main body of $CONFIG_STATUS script. ## +## ----------------------------------- ## +_ASEOF +test $as_write_fail = 0 && chmod +x $CONFIG_STATUS || ac_write_fail=1 + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +# Save the log message, to keep $0 and so on meaningful, and to +# report actual input values of CONFIG_FILES etc. instead of their +# values after options handling. +ac_log=" +This file was extended by asio $as_me 1.36.0, which was +generated by GNU Autoconf 2.72. Invocation command line was + + CONFIG_FILES = $CONFIG_FILES + CONFIG_HEADERS = $CONFIG_HEADERS + CONFIG_LINKS = $CONFIG_LINKS + CONFIG_COMMANDS = $CONFIG_COMMANDS + $ $0 $@ + +on `(hostname || uname -n) 2>/dev/null | sed 1q` +" + +_ACEOF + +case $ac_config_files in *" +"*) set x $ac_config_files; shift; ac_config_files=$*;; +esac + + + +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +# Files that config.status was made for. +config_files="$ac_config_files" +config_commands="$ac_config_commands" + +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +ac_cs_usage="\ +'$as_me' instantiates files and other configuration actions +from templates according to the current configuration. Unless the files +and actions are specified as TAGs, all are instantiated by default. + +Usage: $0 [OPTION]... [TAG]... + + -h, --help print this help, then exit + -V, --version print version number and configuration settings, then exit + --config print configuration, then exit + -q, --quiet, --silent + do not print progress messages + -d, --debug don't remove temporary files + --recheck update $as_me by reconfiguring in the same conditions + --file=FILE[:TEMPLATE] + instantiate the configuration file FILE + +Configuration files: +$config_files + +Configuration commands: +$config_commands + +Report bugs to the package provider." + +_ACEOF +ac_cs_config=`printf "%s\n" "$ac_configure_args" | sed "$ac_safe_unquote"` +ac_cs_config_escaped=`printf "%s\n" "$ac_cs_config" | sed "s/^ //; s/'/'\\\\\\\\''/g"` +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +ac_cs_config='$ac_cs_config_escaped' +ac_cs_version="\\ +asio config.status 1.36.0 +configured by $0, generated by GNU Autoconf 2.72, + with options \\"\$ac_cs_config\\" + +Copyright (C) 2023 Free Software Foundation, Inc. +This config.status script is free software; the Free Software Foundation +gives unlimited permission to copy, distribute and modify it." + +ac_pwd='$ac_pwd' +srcdir='$srcdir' +INSTALL='$INSTALL' +MKDIR_P='$MKDIR_P' +AWK='$AWK' +test -n "\$AWK" || AWK=awk +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +# The default lists apply if the user does not specify any file. +ac_need_defaults=: +while test $# != 0 +do + case $1 in + --*=?*) + ac_option=`expr "X$1" : 'X\([^=]*\)='` + ac_optarg=`expr "X$1" : 'X[^=]*=\(.*\)'` + ac_shift=: + ;; + --*=) + ac_option=`expr "X$1" : 'X\([^=]*\)='` + ac_optarg= + ac_shift=: + ;; + *) + ac_option=$1 + ac_optarg=$2 + ac_shift=shift + ;; + esac + + case $ac_option in + # Handling of the options. + -recheck | --recheck | --rechec | --reche | --rech | --rec | --re | --r) + ac_cs_recheck=: ;; + --version | --versio | --versi | --vers | --ver | --ve | --v | -V ) + printf "%s\n" "$ac_cs_version"; exit ;; + --config | --confi | --conf | --con | --co | --c ) + printf "%s\n" "$ac_cs_config"; exit ;; + --debug | --debu | --deb | --de | --d | -d ) + debug=: ;; + --file | --fil | --fi | --f ) + $ac_shift + case $ac_optarg in + *\'*) ac_optarg=`printf "%s\n" "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"` ;; + '') as_fn_error $? "missing file argument" ;; + esac + as_fn_append CONFIG_FILES " '$ac_optarg'" + ac_need_defaults=false;; + --he | --h | --help | --hel | -h ) + printf "%s\n" "$ac_cs_usage"; exit ;; + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil | --si | --s) + ac_cs_silent=: ;; + + # This is an error. + -*) as_fn_error $? "unrecognized option: '$1' +Try '$0 --help' for more information." ;; + + *) as_fn_append ac_config_targets " $1" + ac_need_defaults=false ;; + + esac + shift +done + +ac_configure_extra_args= + +if $ac_cs_silent; then + exec 6>/dev/null + ac_configure_extra_args="$ac_configure_extra_args --silent" +fi + +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +if \$ac_cs_recheck; then + set X $SHELL '$0' $ac_configure_args \$ac_configure_extra_args --no-create --no-recursion + shift + \printf "%s\n" "running CONFIG_SHELL=$SHELL \$*" >&6 + CONFIG_SHELL='$SHELL' + export CONFIG_SHELL + exec "\$@" +fi + +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +exec 5>>config.log +{ + echo + sed 'h;s/./-/g;s/^.../## /;s/...$/ ##/;p;x;p;x' <<_ASBOX +## Running $as_me. ## +_ASBOX + printf "%s\n" "$ac_log" +} >&5 + +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +# +# INIT-COMMANDS +# +AMDEP_TRUE="$AMDEP_TRUE" MAKE="${MAKE-make}" + +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 + +# Handling of arguments. +for ac_config_target in $ac_config_targets +do + case $ac_config_target in + "depfiles") CONFIG_COMMANDS="$CONFIG_COMMANDS depfiles" ;; + "asio.pc") CONFIG_FILES="$CONFIG_FILES asio.pc" ;; + "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;; + "include/Makefile") CONFIG_FILES="$CONFIG_FILES include/Makefile" ;; + "src/Makefile") CONFIG_FILES="$CONFIG_FILES src/Makefile" ;; + "src/tests/Makefile") CONFIG_FILES="$CONFIG_FILES src/tests/Makefile" ;; + "src/tests/properties/Makefile") CONFIG_FILES="$CONFIG_FILES src/tests/properties/Makefile" ;; + "src/examples/cpp11/Makefile") CONFIG_FILES="$CONFIG_FILES src/examples/cpp11/Makefile" ;; + "src/examples/cpp14/Makefile") CONFIG_FILES="$CONFIG_FILES src/examples/cpp14/Makefile" ;; + "src/examples/cpp17/Makefile") CONFIG_FILES="$CONFIG_FILES src/examples/cpp17/Makefile" ;; + "src/examples/cpp20/Makefile") CONFIG_FILES="$CONFIG_FILES src/examples/cpp20/Makefile" ;; + + *) as_fn_error $? "invalid argument: '$ac_config_target'" "$LINENO" 5;; + esac +done + + +# If the user did not use the arguments to specify the items to instantiate, +# then the envvar interface is used. Set only those that are not. +# We use the long form for the default assignment because of an extremely +# bizarre bug on SunOS 4.1.3. +if $ac_need_defaults; then + test ${CONFIG_FILES+y} || CONFIG_FILES=$config_files + test ${CONFIG_COMMANDS+y} || CONFIG_COMMANDS=$config_commands +fi + +# Have a temporary directory for convenience. Make it in the build tree +# simply because there is no reason against having it here, and in addition, +# creating and moving files from /tmp can sometimes cause problems. +# Hook for its removal unless debugging. +# Note that there is a small window in which the directory will not be cleaned: +# after its creation but before its name has been assigned to '$tmp'. +$debug || +{ + tmp= ac_tmp= + trap 'exit_status=$? + : "${ac_tmp:=$tmp}" + { test ! -d "$ac_tmp" || rm -fr "$ac_tmp"; } && exit $exit_status +' 0 + trap 'as_fn_exit 1' 1 2 13 15 +} +# Create a (secure) tmp directory for tmp files. + +{ + tmp=`(umask 077 && mktemp -d "./confXXXXXX") 2>/dev/null` && + test -d "$tmp" +} || +{ + tmp=./conf$$-$RANDOM + (umask 077 && mkdir "$tmp") +} || as_fn_error $? "cannot create a temporary directory in ." "$LINENO" 5 +ac_tmp=$tmp + +# Set up the scripts for CONFIG_FILES section. +# No need to generate them if there are no CONFIG_FILES. +# This happens for instance with './config.status config.h'. +if test -n "$CONFIG_FILES"; then + + +ac_cr=`echo X | tr X '\015'` +# On cygwin, bash can eat \r inside `` if the user requested igncr. +# But we know of no other shell where ac_cr would be empty at this +# point, so we can use a bashism as a fallback. +if test "x$ac_cr" = x; then + eval ac_cr=\$\'\\r\' +fi +ac_cs_awk_cr=`$AWK 'BEGIN { print "a\rb" }' /dev/null` +if test "$ac_cs_awk_cr" = "a${ac_cr}b"; then + ac_cs_awk_cr='\\r' +else + ac_cs_awk_cr=$ac_cr +fi + +echo 'BEGIN {' >"$ac_tmp/subs1.awk" && +_ACEOF + + +{ + echo "cat >conf$$subs.awk <<_ACEOF" && + echo "$ac_subst_vars" | sed 's/.*/&!$&$ac_delim/' && + echo "_ACEOF" +} >conf$$subs.sh || + as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 +ac_delim_num=`echo "$ac_subst_vars" | grep -c '^'` +ac_delim='%!_!# ' +for ac_last_try in false false false false false :; do + . ./conf$$subs.sh || + as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 + + ac_delim_n=`sed -n "s/.*$ac_delim\$/X/p" conf$$subs.awk | grep -c X` + if test $ac_delim_n = $ac_delim_num; then + break + elif $ac_last_try; then + as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 + else + ac_delim="$ac_delim!$ac_delim _$ac_delim!! " + fi +done +rm -f conf$$subs.sh + +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +cat >>"\$ac_tmp/subs1.awk" <<\\_ACAWK && +_ACEOF +sed -n ' +h +s/^/S["/; s/!.*/"]=/ +p +g +s/^[^!]*!// +:repl +t repl +s/'"$ac_delim"'$// +t delim +:nl +h +s/\(.\{148\}\)..*/\1/ +t more1 +s/["\\]/\\&/g; s/^/"/; s/$/\\n"\\/ +p +n +b repl +:more1 +s/["\\]/\\&/g; s/^/"/; s/$/"\\/ +p +g +s/.\{148\}// +t nl +:delim +h +s/\(.\{148\}\)..*/\1/ +t more2 +s/["\\]/\\&/g; s/^/"/; s/$/"/ +p +b +:more2 +s/["\\]/\\&/g; s/^/"/; s/$/"\\/ +p +g +s/.\{148\}// +t delim +' >$CONFIG_STATUS || ac_write_fail=1 +rm -f conf$$subs.awk +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +_ACAWK +cat >>"\$ac_tmp/subs1.awk" <<_ACAWK && + for (key in S) S_is_set[key] = 1 + FS = "" + +} +{ + line = $ 0 + nfields = split(line, field, "@") + substed = 0 + len = length(field[1]) + for (i = 2; i < nfields; i++) { + key = field[i] + keylen = length(key) + if (S_is_set[key]) { + value = S[key] + line = substr(line, 1, len) "" value "" substr(line, len + keylen + 3) + len += length(value) + length(field[++i]) + substed = 1 + } else + len += 1 + keylen + } + + print line +} + +_ACAWK +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +if sed "s/$ac_cr//" < /dev/null > /dev/null 2>&1; then + sed "s/$ac_cr\$//; s/$ac_cr/$ac_cs_awk_cr/g" +else + cat +fi < "$ac_tmp/subs1.awk" > "$ac_tmp/subs.awk" \ + || as_fn_error $? "could not setup config files machinery" "$LINENO" 5 +_ACEOF + +# VPATH may cause trouble with some makes, so we remove sole $(srcdir), +# ${srcdir} and @srcdir@ entries from VPATH if srcdir is ".", strip leading and +# trailing colons and then remove the whole line if VPATH becomes empty +# (actually we leave an empty line to preserve line numbers). +if test "x$srcdir" = x.; then + ac_vpsub='/^[ ]*VPATH[ ]*=[ ]*/{ +h +s/// +s/^/:/ +s/[ ]*$/:/ +s/:\$(srcdir):/:/g +s/:\${srcdir}:/:/g +s/:@srcdir@:/:/g +s/^:*// +s/:*$// +x +s/\(=[ ]*\).*/\1/ +G +s/\n// +s/^[^=]*=[ ]*$// +}' +fi + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +fi # test -n "$CONFIG_FILES" + + +eval set X " :F $CONFIG_FILES :C $CONFIG_COMMANDS" +shift +for ac_tag +do + case $ac_tag in + :[FHLC]) ac_mode=$ac_tag; continue;; + esac + case $ac_mode$ac_tag in + :[FHL]*:*);; + :L* | :C*:*) as_fn_error $? "invalid tag '$ac_tag'" "$LINENO" 5;; + :[FH]-) ac_tag=-:-;; + :[FH]*) ac_tag=$ac_tag:$ac_tag.in;; + esac + ac_save_IFS=$IFS + IFS=: + set x $ac_tag + IFS=$ac_save_IFS + shift + ac_file=$1 + shift + + case $ac_mode in + :L) ac_source=$1;; + :[FH]) + ac_file_inputs= + for ac_f + do + case $ac_f in + -) ac_f="$ac_tmp/stdin";; + *) # Look for the file first in the build tree, then in the source tree + # (if the path is not absolute). The absolute path cannot be DOS-style, + # because $ac_f cannot contain ':'. + test -f "$ac_f" || + case $ac_f in + [\\/$]*) false;; + *) test -f "$srcdir/$ac_f" && ac_f="$srcdir/$ac_f";; + esac || + as_fn_error 1 "cannot find input file: '$ac_f'" "$LINENO" 5;; + esac + case $ac_f in *\'*) ac_f=`printf "%s\n" "$ac_f" | sed "s/'/'\\\\\\\\''/g"`;; esac + as_fn_append ac_file_inputs " '$ac_f'" + done + + # Let's still pretend it is 'configure' which instantiates (i.e., don't + # use $as_me), people would be surprised to read: + # /* config.h. Generated by config.status. */ + configure_input='Generated from '` + printf "%s\n" "$*" | sed 's|^[^:]*/||;s|:[^:]*/|, |g' + `' by configure.' + if test x"$ac_file" != x-; then + configure_input="$ac_file. $configure_input" + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: creating $ac_file" >&5 +printf "%s\n" "$as_me: creating $ac_file" >&6;} + fi + # Neutralize special characters interpreted by sed in replacement strings. + case $configure_input in #( + *\&* | *\|* | *\\* ) + ac_sed_conf_input=`printf "%s\n" "$configure_input" | + sed 's/[\\\\&|]/\\\\&/g'`;; #( + *) ac_sed_conf_input=$configure_input;; + esac + + case $ac_tag in + *:-:* | *:-) cat >"$ac_tmp/stdin" \ + || as_fn_error $? "could not create $ac_file" "$LINENO" 5 ;; + esac + ;; + esac + + ac_dir=`$as_dirname -- "$ac_file" || +$as_expr X"$ac_file" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$ac_file" : 'X\(//\)[^/]' \| \ + X"$ac_file" : 'X\(//\)$' \| \ + X"$ac_file" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X"$ac_file" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + as_dir="$ac_dir"; as_fn_mkdir_p + ac_builddir=. + +case "$ac_dir" in +.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; +*) + ac_dir_suffix=/`printf "%s\n" "$ac_dir" | sed 's|^\.[\\/]||'` + # A ".." for each directory in $ac_dir_suffix. + ac_top_builddir_sub=`printf "%s\n" "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` + case $ac_top_builddir_sub in + "") ac_top_builddir_sub=. ac_top_build_prefix= ;; + *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; + esac ;; +esac +ac_abs_top_builddir=$ac_pwd +ac_abs_builddir=$ac_pwd$ac_dir_suffix +# for backward compatibility: +ac_top_builddir=$ac_top_build_prefix + +case $srcdir in + .) # We are building in place. + ac_srcdir=. + ac_top_srcdir=$ac_top_builddir_sub + ac_abs_top_srcdir=$ac_pwd ;; + [\\/]* | ?:[\\/]* ) # Absolute name. + ac_srcdir=$srcdir$ac_dir_suffix; + ac_top_srcdir=$srcdir + ac_abs_top_srcdir=$srcdir ;; + *) # Relative name. + ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix + ac_top_srcdir=$ac_top_build_prefix$srcdir + ac_abs_top_srcdir=$ac_pwd/$srcdir ;; +esac +ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix + + + case $ac_mode in + :F) + # + # CONFIG_FILE + # + + case $INSTALL in + [\\/$]* | ?:[\\/]* ) ac_INSTALL=$INSTALL ;; + *) ac_INSTALL=$ac_top_build_prefix$INSTALL ;; + esac + ac_MKDIR_P=$MKDIR_P + case $MKDIR_P in + [\\/$]* | ?:[\\/]* ) ;; + */*) ac_MKDIR_P=$ac_top_build_prefix$MKDIR_P ;; + esac +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +# If the template does not know about datarootdir, expand it. +# FIXME: This hack should be removed a few years after 2.60. +ac_datarootdir_hack=; ac_datarootdir_seen= +ac_sed_dataroot=' +/datarootdir/ { + p + q +} +/@datadir@/p +/@docdir@/p +/@infodir@/p +/@localedir@/p +/@mandir@/p' +case `eval "sed -n \"\$ac_sed_dataroot\" $ac_file_inputs"` in +*datarootdir*) ac_datarootdir_seen=yes;; +*@datadir@*|*@docdir@*|*@infodir@*|*@localedir@*|*@mandir@*) + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&5 +printf "%s\n" "$as_me: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&2;} +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 + ac_datarootdir_hack=' + s&@datadir@&$datadir&g + s&@docdir@&$docdir&g + s&@infodir@&$infodir&g + s&@localedir@&$localedir&g + s&@mandir@&$mandir&g + s&\\\${datarootdir}&$datarootdir&g' ;; +esac +_ACEOF + +# Neutralize VPATH when '$srcdir' = '.'. +# Shell code in configure.ac might set extrasub. +# FIXME: do we really want to maintain this feature? +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +ac_sed_extra="$ac_vpsub +$extrasub +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +:t +/@[a-zA-Z_][a-zA-Z_0-9]*@/!b +s|@configure_input@|$ac_sed_conf_input|;t t +s&@top_builddir@&$ac_top_builddir_sub&;t t +s&@top_build_prefix@&$ac_top_build_prefix&;t t +s&@srcdir@&$ac_srcdir&;t t +s&@abs_srcdir@&$ac_abs_srcdir&;t t +s&@top_srcdir@&$ac_top_srcdir&;t t +s&@abs_top_srcdir@&$ac_abs_top_srcdir&;t t +s&@builddir@&$ac_builddir&;t t +s&@abs_builddir@&$ac_abs_builddir&;t t +s&@abs_top_builddir@&$ac_abs_top_builddir&;t t +s&@INSTALL@&$ac_INSTALL&;t t +s&@MKDIR_P@&$ac_MKDIR_P&;t t +$ac_datarootdir_hack +" +eval sed \"\$ac_sed_extra\" "$ac_file_inputs" | $AWK -f "$ac_tmp/subs.awk" \ + >$ac_tmp/out || as_fn_error $? "could not create $ac_file" "$LINENO" 5 + +test -z "$ac_datarootdir_hack$ac_datarootdir_seen" && + { ac_out=`sed -n '/\${datarootdir}/p' "$ac_tmp/out"`; test -n "$ac_out"; } && + { ac_out=`sed -n '/^[ ]*datarootdir[ ]*:*=/p' \ + "$ac_tmp/out"`; test -z "$ac_out"; } && + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file contains a reference to the variable 'datarootdir' +which seems to be undefined. Please make sure it is defined" >&5 +printf "%s\n" "$as_me: WARNING: $ac_file contains a reference to the variable 'datarootdir' +which seems to be undefined. Please make sure it is defined" >&2;} + + rm -f "$ac_tmp/stdin" + case $ac_file in + -) cat "$ac_tmp/out" && rm -f "$ac_tmp/out";; + *) rm -f "$ac_file" && mv "$ac_tmp/out" "$ac_file";; + esac \ + || as_fn_error $? "could not create $ac_file" "$LINENO" 5 + ;; + + + :C) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: executing $ac_file commands" >&5 +printf "%s\n" "$as_me: executing $ac_file commands" >&6;} + ;; + esac + + + case $ac_file$ac_mode in + "depfiles":C) test x"$AMDEP_TRUE" != x"" || { + # Older Autoconf quotes --file arguments for eval, but not when files + # are listed without --file. Let's play safe and only enable the eval + # if we detect the quoting. + # TODO: see whether this extra hack can be removed once we start + # requiring Autoconf 2.70 or later. + case $CONFIG_FILES in #( + *\'*) : + eval set x "$CONFIG_FILES" ;; #( + *) : + set x $CONFIG_FILES ;; #( + *) : + ;; +esac + shift + # Used to flag and report bootstrapping failures. + am_rc=0 + for am_mf + do + # Strip MF so we end up with the name of the file. + am_mf=`printf "%s\n" "$am_mf" | sed -e 's/:.*$//'` + # Check whether this is an Automake generated Makefile which includes + # dependency-tracking related rules and includes. + # Grep'ing the whole file directly is not great: AIX grep has a line + # limit of 2048, but all sed's we know have understand at least 4000. + sed -n 's,^am--depfiles:.*,X,p' "$am_mf" | grep X >/dev/null 2>&1 \ + || continue + am_dirpart=`$as_dirname -- "$am_mf" || +$as_expr X"$am_mf" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$am_mf" : 'X\(//\)[^/]' \| \ + X"$am_mf" : 'X\(//\)$' \| \ + X"$am_mf" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X"$am_mf" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + am_filepart=`$as_basename -- "$am_mf" || +$as_expr X/"$am_mf" : '.*/\([^/][^/]*\)/*$' \| \ + X"$am_mf" : 'X\(//\)$' \| \ + X"$am_mf" : 'X\(/\)' \| . 2>/dev/null || +printf "%s\n" X/"$am_mf" | + sed '/^.*\/\([^/][^/]*\)\/*$/{ + s//\1/ + q + } + /^X\/\(\/\/\)$/{ + s//\1/ + q + } + /^X\/\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + { echo "$as_me:$LINENO: cd "$am_dirpart" \ + && sed -e '/# am--include-marker/d' "$am_filepart" \ + | $MAKE -f - am--depfiles" >&5 + (cd "$am_dirpart" \ + && sed -e '/# am--include-marker/d' "$am_filepart" \ + | $MAKE -f - am--depfiles) >&5 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } || am_rc=$? + done + if test $am_rc -ne 0; then + { { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in '$ac_pwd':" >&5 +printf "%s\n" "$as_me: error: in '$ac_pwd':" >&2;} +as_fn_error $? "Something went wrong bootstrapping makefile fragments + for automatic dependency tracking. If GNU make was not used, consider + re-running the configure script with MAKE=\"gmake\" (or whatever is + necessary). You can also try re-running configure with the + '--disable-dependency-tracking' option to at least be able to build + the package (albeit without support for automatic dependency tracking). +See 'config.log' for more details" "$LINENO" 5; } + fi + { am_dirpart=; unset am_dirpart;} + { am_filepart=; unset am_filepart;} + { am_mf=; unset am_mf;} + { am_rc=; unset am_rc;} + rm -f conftest-deps.mk +} + ;; + + esac +done # for ac_tag + + +as_fn_exit 0 +_ACEOF +ac_clean_files=$ac_clean_files_save + +test $ac_write_fail = 0 || + as_fn_error $? "write failure creating $CONFIG_STATUS" "$LINENO" 5 + + +# configure is writing to config.log, and then calls config.status. +# config.status does its own redirection, appending to config.log. +# Unfortunately, on DOS this fails, as config.log is still kept open +# by configure, so config.status won't be able to write to it; its +# output is simply discarded. So we exec the FD to /dev/null, +# effectively closing config.log, so it can be properly (re)opened and +# appended to by config.status. When coming back to configure, we +# need to make the FD available again. +if test "$no_create" != yes; then + ac_cs_success=: + ac_config_status_args= + test "$silent" = yes && + ac_config_status_args="$ac_config_status_args --quiet" + exec 5>/dev/null + $SHELL $CONFIG_STATUS $ac_config_status_args || ac_cs_success=false + exec 5>>config.log + # Use ||, not &&, to avoid exiting from the if with $? = 1, which + # would make configure fail if this is the last instruction. + $ac_cs_success || as_fn_exit 1 +fi +if test -n "$ac_unrecognized_opts" && test "$enable_option_checking" != no; then + { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: unrecognized options: $ac_unrecognized_opts" >&5 +printf "%s\n" "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2;} +fi + + diff --git a/Packages/asio-1.36.0/configure.ac b/Packages/asio-1.36.0/configure.ac new file mode 100644 index 0000000..7ea523a --- /dev/null +++ b/Packages/asio-1.36.0/configure.ac @@ -0,0 +1,259 @@ +AC_INIT([asio],[1.36.0]) +AC_CONFIG_SRCDIR(include/asio.hpp) +AM_MAINTAINER_MODE +AM_INIT_AUTOMAKE([tar-pax]) + +AC_CANONICAL_HOST +AM_PROG_CC_C_O +AC_PROG_CXX +AC_LANG(C++) +AC_PROG_RANLIB +PKG_NOARCH_INSTALLDIR + +AC_DEFINE(_REENTRANT, [1], [Define this]) + +AC_ARG_WITH(boost, + AS_HELP_STRING([--with-boost=DIR],[location of boost distribution]), +[ + if test "${withval}" = no; then + STANDALONE="yes" + else + if test "${withval}" != system; then + CPPFLAGS="$CPPFLAGS -I${withval}" + LIBS="$LIBS -L${withval}/stage/lib" + fi + CPPFLAGS="$CPPFLAGS -DASIO_ENABLE_BOOST -DBOOST_CHRONO_HEADER_ONLY -DBOOST_CHRONO_DONT_PROVIDE_HYBRID_ERROR_HANDLING" + fi +], +[ + STANDALONE="yes" +]) + +AC_ARG_ENABLE(separate-compilation, +[ --enable-separate-compilation separate compilation of asio source], +[ + SEPARATE_COMPILATION=yes +]) + +AC_ARG_ENABLE(boost-coroutine, +[ --enable-boost-coroutine use Boost.Coroutine to implement stackful coroutines], +[ + HAVE_BOOST_COROUTINE=yes +]) + +if test "$STANDALONE" != yes; then + AC_CHECK_HEADER([boost/noncopyable.hpp],, + [ + echo "Can't find boost headers. Please check the location of the boost" + echo "distribution and rerun configure using the --with-boost=DIR option." + echo "Alternatively, run with --without-boost to enable standalone build." + exit 1 + ],[]) +fi + +AC_ARG_WITH(openssl, + AS_HELP_STRING([--with-openssl=DIR],[location of openssl]), +[ + CPPFLAGS="$CPPFLAGS -I${withval}/include" + LIBS="$LIBS -L${withval}/lib" +],[]) + +AC_CHECK_HEADER([openssl/ssl.h],, +[ + OPENSSL_FOUND=no +],[]) + +if test x$OPENSSL_FOUND != xno; then + LIBS="$LIBS -lssl -lcrypto" +fi + +AM_CONDITIONAL(HAVE_OPENSSL,test x$OPENSSL_FOUND != xno) + +WINDOWS=no +case $host in + *-*-linux*) + CXXFLAGS="$CXXFLAGS -pthread" + LDFLAGS="$LDFLAGS -pthread" + LIBS="$LIBS -lrt" + ;; + *-*-solaris*) + if test "$GXX" = yes; then + CXXFLAGS="$CXXFLAGS -D_PTHREADS" + else + # We'll assume Sun's CC. + CXXFLAGS="$CXXFLAGS -mt" + fi + LIBS="$LIBS -lsocket -lnsl -lpthread" + ;; + *-*-mingw32*) + CXXFLAGS="$CXXFLAGS -mthreads" + LDFLAGS="$LDFLAGS -mthreads" + LIBS="$LIBS -lws2_32 -lmswsock" + WINDOWS=yes + ;; + *-*-mingw64*) + CXXFLAGS="$CXXFLAGS -mthreads" + LDFLAGS="$LDFLAGS -mthreads" + LIBS="$LIBS -lws2_32 -lmswsock" + WINDOWS=yes + ;; + *-pc-cygwin*) + CXXFLAGS="$CXXFLAGS -D__USE_W32_SOCKETS -D_WIN32_WINNT=0x0601" + LIBS="$LIBS -lws2_32 -lmswsock" + WINDOWS=yes + ;; + *-apple-darwin*) + CXXFLAGS="$CXXFLAGS" + LDFLAGS="$LDFLAGS" + ;; + *-*-freebsd*) + CXXFLAGS="$CXXFLAGS -pthread" + LDFLAGS="$LDFLAGS -pthread" + ;; + *-*-netbsd*) + CXXFLAGS="$CXXFLAGS -pthread" + LDFLAGS="$LDFLAGS -pthread" + ;; + *-*-haiku*) + CXXFLAGS="$CXXFLAGS -lnetwork" + LDFLAGS="$LDFLAGS -lnetwork" + +esac + +if test "$GXX" = yes; then + CXXFLAGS="$CXXFLAGS -ftemplate-depth-256" +fi + +if test "$STANDALONE" = yes; then + CPPFLAGS="$CPPFLAGS -DASIO_STANDALONE" +fi + +if test "$SEPARATE_COMPILATION" = yes; then + CPPFLAGS="$CPPFLAGS -DASIO_SEPARATE_COMPILATION" +fi + +AC_MSG_CHECKING([whether C++11 is enabled]) +AC_COMPILE_IFELSE( + [AC_LANG_PROGRAM( + [[#if __cplusplus < 201103L]] + [[#error C++11 not available]] + [[#endif]])], + [AC_MSG_RESULT([yes]) + HAVE_CXX11=yes;], + [AC_MSG_RESULT([no]) + HAVE_CXX11=no;]) + +AC_MSG_CHECKING([whether C++14 is enabled]) +AC_COMPILE_IFELSE( + [AC_LANG_PROGRAM( + [[#if defined(__GNUC__) && !defined(__clang__)]] + [[# if (__GNUC__ <= 6)]] + [[# error C++14 support on this compiler not sufficiently compliant]] + [[# endif]] + [[#endif]] + [[#if __cplusplus < 201402L]] + [[#error C++14 not available]] + [[#endif]])], + [AC_MSG_RESULT([yes]) + HAVE_CXX14=yes;], + [AC_MSG_RESULT([no]) + HAVE_CXX14=no;]) + +AC_MSG_CHECKING([whether C++17 is enabled]) +AC_COMPILE_IFELSE( + [AC_LANG_PROGRAM( + [[#if __cplusplus < 201703L]] + [[#error C++17 not available]] + [[#endif]])], + [AC_MSG_RESULT([yes]) + HAVE_CXX17=yes;], + [AC_MSG_RESULT([no]) + HAVE_CXX17=no;]) + +AC_MSG_CHECKING([whether C++20 is enabled]) +AC_COMPILE_IFELSE( + [AC_LANG_PROGRAM( + [[#if __cplusplus < 202002L]] + [[#error C++20 not available]] + [[#endif]])], + [AC_MSG_RESULT([yes]) + HAVE_CXX20=yes;], + [AC_MSG_RESULT([no]) + HAVE_CXX20=no;]) + +AC_MSG_CHECKING([whether coroutines are enabled]) +AC_COMPILE_IFELSE( + [AC_LANG_PROGRAM( + [[#if defined(__clang__)]] + [[# if (__clang_major__ >= 14)]] + [[# if (__cplusplus >= 202002) && (__cpp_impl_coroutine >= 201902)]] + [[# if __has_include()]] + [[# define ASIO_HAS_CO_AWAIT 1]] + [[# endif]] + [[# elif (__cplusplus >= 201703) && (__cpp_coroutines >= 201703)]] + [[# if __has_include()]] + [[# define ASIO_HAS_CO_AWAIT 1]] + [[# endif]] + [[# endif]] + [[# else]] + [[# if (__cplusplus >= 201703) && (__cpp_coroutines >= 201703)]] + [[# if __has_include()]] + [[# define ASIO_HAS_CO_AWAIT 1]] + [[# endif]] + [[# endif]] + [[# endif]] + [[#elif defined(__GNUC__)]] + [[# if (__cplusplus >= 201709) && (__cpp_impl_coroutine >= 201902)]] + [[# if __has_include()]] + [[# define ASIO_HAS_CO_AWAIT 1]] + [[# endif]] + [[# endif]] + [[#endif]] + [[#ifndef ASIO_HAS_CO_AWAIT]] + [[# error coroutines not available]] + [[#endif]])], + [AC_MSG_RESULT([yes]) + HAVE_COROUTINES=yes;], + [AC_MSG_RESULT([no]) + HAVE_COROUTINES=no;]) + +if test "$GXX" = yes; then + if test "$STANDALONE" = yes; then + if test "$HAVE_CXX11" = no; then + HAVE_CXX11=yes + CPPFLAGS="-std=c++0x $CPPFLAGS" + fi + fi +fi + +AM_CONDITIONAL(STANDALONE,test x$STANDALONE = xyes) + +AM_CONDITIONAL(SEPARATE_COMPILATION,test x$SEPARATE_COMPILATION = xyes) + +AM_CONDITIONAL(HAVE_BOOST_COROUTINE,test x$HAVE_BOOST_COROUTINE = xyes) + +AM_CONDITIONAL(WINDOWS_TARGET,test x$WINDOWS != xno) + +AM_CONDITIONAL(HAVE_CXX11,test x$HAVE_CXX11 = xyes) + +AM_CONDITIONAL(HAVE_CXX14,test x$HAVE_CXX14 = xyes) + +AM_CONDITIONAL(HAVE_CXX17,test x$HAVE_CXX17 = xyes) + +AM_CONDITIONAL(HAVE_CXX20,test x$HAVE_CXX20 = xyes) + +AM_CONDITIONAL(HAVE_COROUTINES,test x$HAVE_COROUTINES = xyes) + +AC_CONFIG_FILES([asio.pc]) + +AC_CONFIG_FILES([ + Makefile + include/Makefile + src/Makefile + src/tests/Makefile + src/tests/properties/Makefile + src/examples/cpp11/Makefile + src/examples/cpp14/Makefile + src/examples/cpp17/Makefile + src/examples/cpp20/Makefile]) +AC_OUTPUT diff --git a/Packages/asio-1.36.0/depcomp b/Packages/asio-1.36.0/depcomp new file mode 100644 index 0000000..1f0aa97 --- /dev/null +++ b/Packages/asio-1.36.0/depcomp @@ -0,0 +1,792 @@ +#! /bin/sh +# depcomp - compile a program generating dependencies as side-effects + +scriptversion=2024-06-19.01; # UTC + +# Copyright (C) 1999-2024 Free Software Foundation, Inc. + +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# As a special exception to the GNU General Public License, if you +# distribute this file as part of a program that contains a +# configuration script generated by Autoconf, you may include it under +# the same distribution terms that you use for the rest of that program. + +# Originally written by Alexandre Oliva . + +case $1 in + '') + echo "$0: No command. Try '$0 --help' for more information." 1>&2 + exit 1; + ;; + -h | --h*) + cat <<\EOF +Usage: depcomp [--help] [--version] PROGRAM [ARGS] + +Run PROGRAMS ARGS to compile a file, generating dependencies +as side-effects. + +Environment variables: + depmode Dependency tracking mode. + source Source file read by 'PROGRAMS ARGS'. + object Object file output by 'PROGRAMS ARGS'. + DEPDIR directory where to store dependencies. + depfile Dependency file to output. + tmpdepfile Temporary file to use when outputting dependencies. + libtool Whether libtool is used (yes/no). + +Report bugs to . +GNU Automake home page: . +General help using GNU software: . +EOF + exit $? + ;; + -v | --v*) + echo "depcomp (GNU Automake) $scriptversion" + exit $? + ;; +esac + +# Get the directory component of the given path, and save it in the +# global variables '$dir'. Note that this directory component will +# be either empty or ending with a '/' character. This is deliberate. +set_dir_from () +{ + case $1 in + */*) dir=`echo "$1" | sed -e 's|/[^/]*$|/|'`;; + *) dir=;; + esac +} + +# Get the suffix-stripped basename of the given path, and save it the +# global variable '$base'. +set_base_from () +{ + base=`echo "$1" | sed -e 's|^.*/||' -e 's/\.[^.]*$//'` +} + +# If no dependency file was actually created by the compiler invocation, +# we still have to create a dummy depfile, to avoid errors with the +# Makefile "include basename.Plo" scheme. +make_dummy_depfile () +{ + echo "#dummy" > "$depfile" +} + +# Factor out some common post-processing of the generated depfile. +# Requires the auxiliary global variable '$tmpdepfile' to be set. +aix_post_process_depfile () +{ + # If the compiler actually managed to produce a dependency file, + # post-process it. + if test -f "$tmpdepfile"; then + # Each line is of the form 'foo.o: dependency.h'. + # Do two passes, one to just change these to + # $object: dependency.h + # and one to simply output + # dependency.h: + # which is needed to avoid the deleted-header problem. + { sed -e "s,^.*\.[$lower]*:,$object:," < "$tmpdepfile" + sed -e "s,^.*\.[$lower]*:[$tab ]*,," -e 's,$,:,' < "$tmpdepfile" + } > "$depfile" + rm -f "$tmpdepfile" + else + make_dummy_depfile + fi +} + +# A tabulation character. +tab=' ' +# A newline character. +nl=' +' +# Character ranges might be problematic outside the C locale. +# These definitions help. +upper=ABCDEFGHIJKLMNOPQRSTUVWXYZ +lower=abcdefghijklmnopqrstuvwxyz +alpha=${upper}${lower} + +if test -z "$depmode" || test -z "$source" || test -z "$object"; then + echo "depcomp: Variables source, object and depmode must be set" 1>&2 + exit 1 +fi + +# Dependencies for sub/bar.o or sub/bar.obj go into sub/.deps/bar.Po. +depfile=${depfile-`echo "$object" | + sed 's|[^\\/]*$|'${DEPDIR-.deps}'/&|;s|\.\([^.]*\)$|.P\1|;s|Pobj$|Po|'`} +tmpdepfile=${tmpdepfile-`echo "$depfile" | sed 's/\.\([^.]*\)$/.T\1/'`} + +rm -f "$tmpdepfile" + +# Avoid interference from the environment. +gccflag= dashmflag= + +# Some modes work just like other modes, but use different flags. We +# parameterize here, but still list the modes in the big case below, +# to make depend.m4 easier to write. Note that we *cannot* use a case +# here, because this file can only contain one case statement. +if test "$depmode" = hp; then + # HP compiler uses -M and no extra arg. + gccflag=-M + depmode=gcc +fi + +if test "$depmode" = dashXmstdout; then + # This is just like dashmstdout with a different argument. + dashmflag=-xM + depmode=dashmstdout +fi + +cygpath_u="cygpath -u -f -" +if test "$depmode" = msvcmsys; then + # This is just like msvisualcpp but w/o cygpath translation. + # Just convert the backslash-escaped backslashes to single forward + # slashes to satisfy depend.m4 + cygpath_u='sed s,\\\\,/,g' + depmode=msvisualcpp +fi + +if test "$depmode" = msvc7msys; then + # This is just like msvc7 but w/o cygpath translation. + # Just convert the backslash-escaped backslashes to single forward + # slashes to satisfy depend.m4 + cygpath_u='sed s,\\\\,/,g' + depmode=msvc7 +fi + +if test "$depmode" = xlc; then + # IBM C/C++ Compilers xlc/xlC can output gcc-like dependency information. + gccflag=-qmakedep=gcc,-MF + depmode=gcc +fi + +case "$depmode" in +gcc3) +## gcc 3 implements dependency tracking that does exactly what +## we want. Yay! Note: for some reason libtool 1.4 doesn't like +## it if -MD -MP comes after the -MF stuff. Hmm. +## Unfortunately, FreeBSD c89 acceptance of flags depends upon +## the command line argument order; so add the flags where they +## appear in depend2.am. Note that the slowdown incurred here +## affects only configure: in makefiles, %FASTDEP% shortcuts this. + for arg + do + case $arg in + -c) set fnord "$@" -MT "$object" -MD -MP -MF "$tmpdepfile" "$arg" ;; + *) set fnord "$@" "$arg" ;; + esac + shift # fnord + shift # $arg + done + "$@" + stat=$? + if test $stat -ne 0; then + rm -f "$tmpdepfile" + exit $stat + fi + mv "$tmpdepfile" "$depfile" + ;; + +gcc) +## Note that this doesn't just cater to obsolete pre-3.x GCC compilers. +## but also to in-use compilers like IBM xlc/xlC and the HP C compiler. +## (see the conditional assignment to $gccflag above). +## There are various ways to get dependency output from gcc. Here's +## why we pick this rather obscure method: +## - Don't want to use -MD because we'd like the dependencies to end +## up in a subdir. Having to rename by hand is ugly. +## (We might end up doing this anyway to support other compilers.) +## - The DEPENDENCIES_OUTPUT environment variable makes gcc act like +## -MM, not -M (despite what the docs say). Also, it might not be +## supported by the other compilers which use the 'gcc' depmode. +## - Using -M directly means running the compiler twice (even worse +## than renaming). + if test -z "$gccflag"; then + gccflag=-MD, + fi + "$@" -Wp,"$gccflag$tmpdepfile" + stat=$? + if test $stat -ne 0; then + rm -f "$tmpdepfile" + exit $stat + fi + rm -f "$depfile" + echo "$object : \\" > "$depfile" + # The second -e expression handles DOS-style file names with drive + # letters. + sed -e 's/^[^:]*: / /' \ + -e 's/^['$alpha']:\/[^:]*: / /' < "$tmpdepfile" >> "$depfile" +## This next piece of magic avoids the "deleted header file" problem. +## The problem is that when a header file which appears in a .P file +## is deleted, the dependency causes make to die (because there is +## typically no way to rebuild the header). We avoid this by adding +## dummy dependencies for each header file. Too bad gcc doesn't do +## this for us directly. +## Some versions of gcc put a space before the ':'. On the theory +## that the space means something, we add a space to the output as +## well. hp depmode also adds that space, but also prefixes the VPATH +## to the object. Take care to not repeat it in the output. +## Some versions of the HPUX 10.20 sed can't process this invocation +## correctly. Breaking it into two sed invocations is a workaround. + tr ' ' "$nl" < "$tmpdepfile" \ + | sed -e 's/^\\$//' -e '/^$/d' -e "s|.*$object$||" -e '/:$/d' \ + | sed -e 's/$/ :/' >> "$depfile" + rm -f "$tmpdepfile" + ;; + +hp) + # This case exists only to let depend.m4 do its work. It works by + # looking at the text of this script. This case will never be run, + # since it is checked for above. + exit 1 + ;; + +sgi) + if test "$libtool" = yes; then + "$@" "-Wp,-MDupdate,$tmpdepfile" + else + "$@" -MDupdate "$tmpdepfile" + fi + stat=$? + if test $stat -ne 0; then + rm -f "$tmpdepfile" + exit $stat + fi + rm -f "$depfile" + + if test -f "$tmpdepfile"; then # yes, the sourcefile depend on other files + echo "$object : \\" > "$depfile" + # Clip off the initial element (the dependent). Don't try to be + # clever and replace this with sed code, as IRIX sed won't handle + # lines with more than a fixed number of characters (4096 in + # IRIX 6.2 sed, 8192 in IRIX 6.5). We also remove comment lines; + # the IRIX cc adds comments like '#:fec' to the end of the + # dependency line. + tr ' ' "$nl" < "$tmpdepfile" \ + | sed -e 's/^.*\.o://' -e 's/#.*$//' -e '/^$/ d' \ + | tr "$nl" ' ' >> "$depfile" + echo >> "$depfile" + # The second pass generates a dummy entry for each header file. + tr ' ' "$nl" < "$tmpdepfile" \ + | sed -e 's/^.*\.o://' -e 's/#.*$//' -e '/^$/ d' -e 's/$/:/' \ + >> "$depfile" + else + make_dummy_depfile + fi + rm -f "$tmpdepfile" + ;; + +xlc) + # This case exists only to let depend.m4 do its work. It works by + # looking at the text of this script. This case will never be run, + # since it is checked for above. + exit 1 + ;; + +aix) + # The C for AIX Compiler uses -M and outputs the dependencies + # in a .u file. In older versions, this file always lives in the + # current directory. Also, the AIX compiler puts '$object:' at the + # start of each line; $object doesn't have directory information. + # Version 6 uses the directory in both cases. + set_dir_from "$object" + set_base_from "$object" + if test "$libtool" = yes; then + tmpdepfile1=$dir$base.u + tmpdepfile2=$base.u + tmpdepfile3=$dir.libs/$base.u + "$@" -Wc,-M + else + tmpdepfile1=$dir$base.u + tmpdepfile2=$dir$base.u + tmpdepfile3=$dir$base.u + "$@" -M + fi + stat=$? + if test $stat -ne 0; then + rm -f "$tmpdepfile1" "$tmpdepfile2" "$tmpdepfile3" + exit $stat + fi + + for tmpdepfile in "$tmpdepfile1" "$tmpdepfile2" "$tmpdepfile3" + do + test -f "$tmpdepfile" && break + done + aix_post_process_depfile + ;; + +tcc) + # tcc (Tiny C Compiler) understand '-MD -MF file' since version 0.9.26 + # FIXME: That version still under development at the moment of writing. + # Make that this statement remains true also for stable, released + # versions. + # It will wrap lines (doesn't matter whether long or short) with a + # trailing '\', as in: + # + # foo.o : \ + # foo.c \ + # foo.h \ + # + # It will put a trailing '\' even on the last line, and will use leading + # spaces rather than leading tabs (at least since its commit 0394caf7 + # "Emit spaces for -MD"). + "$@" -MD -MF "$tmpdepfile" + stat=$? + if test $stat -ne 0; then + rm -f "$tmpdepfile" + exit $stat + fi + rm -f "$depfile" + # Each non-empty line is of the form 'foo.o : \' or ' dep.h \'. + # We have to change lines of the first kind to '$object: \'. + sed -e "s|.*:|$object :|" < "$tmpdepfile" > "$depfile" + # And for each line of the second kind, we have to emit a 'dep.h:' + # dummy dependency, to avoid the deleted-header problem. + sed -n -e 's|^ *\(.*\) *\\$|\1:|p' < "$tmpdepfile" >> "$depfile" + rm -f "$tmpdepfile" + ;; + +## The order of this option in the case statement is important, since the +## shell code in configure will try each of these formats in the order +## listed in this file. A plain '-MD' option would be understood by many +## compilers, so we must ensure this comes after the gcc and icc options. +pgcc) + # Portland's C compiler understands '-MD'. + # Will always output deps to 'file.d' where file is the root name of the + # source file under compilation, even if file resides in a subdirectory. + # The object file name does not affect the name of the '.d' file. + # pgcc 10.2 will output + # foo.o: sub/foo.c sub/foo.h + # and will wrap long lines using '\' : + # foo.o: sub/foo.c ... \ + # sub/foo.h ... \ + # ... + set_dir_from "$object" + # Use the source, not the object, to determine the base name, since + # that's sadly what pgcc will do too. + set_base_from "$source" + tmpdepfile=$base.d + + # For projects that build the same source file twice into different object + # files, the pgcc approach of using the *source* file root name can cause + # problems in parallel builds. Use a locking strategy to avoid stomping on + # the same $tmpdepfile. + lockdir=$base.d-lock + trap " + echo '$0: caught signal, cleaning up...' >&2 + rmdir '$lockdir' + exit 1 + " 1 2 13 15 + numtries=100 + i=$numtries + while test $i -gt 0; do + # mkdir is a portable test-and-set. + if mkdir "$lockdir" 2>/dev/null; then + # This process acquired the lock. + "$@" -MD + stat=$? + # Release the lock. + rmdir "$lockdir" + break + else + # If the lock is being held by a different process, wait + # until the winning process is done or we timeout. + while test -d "$lockdir" && test $i -gt 0; do + sleep 1 + i=`expr $i - 1` + done + fi + i=`expr $i - 1` + done + trap - 1 2 13 15 + if test $i -le 0; then + echo "$0: failed to acquire lock after $numtries attempts" >&2 + echo "$0: check lockdir '$lockdir'" >&2 + exit 1 + fi + + if test $stat -ne 0; then + rm -f "$tmpdepfile" + exit $stat + fi + rm -f "$depfile" + # Each line is of the form `foo.o: dependent.h', + # or `foo.o: dep1.h dep2.h \', or ` dep3.h dep4.h \'. + # Do two passes, one to just change these to + # `$object: dependent.h' and one to simply `dependent.h:'. + sed "s,^[^:]*:,$object :," < "$tmpdepfile" > "$depfile" + # Some versions of the HPUX 10.20 sed can't process this invocation + # correctly. Breaking it into two sed invocations is a workaround. + sed 's,^[^:]*: \(.*\)$,\1,;s/^\\$//;/^$/d;/:$/d' < "$tmpdepfile" \ + | sed -e 's/$/ :/' >> "$depfile" + rm -f "$tmpdepfile" + ;; + +hp2) + # The "hp" stanza above does not work with aCC (C++) and HP's ia64 + # compilers, which have integrated preprocessors. The correct option + # to use with these is +Maked; it writes dependencies to a file named + # 'foo.d', which lands next to the object file, wherever that + # happens to be. + # Much of this is similar to the tru64 case; see comments there. + set_dir_from "$object" + set_base_from "$object" + if test "$libtool" = yes; then + tmpdepfile1=$dir$base.d + tmpdepfile2=$dir.libs/$base.d + "$@" -Wc,+Maked + else + tmpdepfile1=$dir$base.d + tmpdepfile2=$dir$base.d + "$@" +Maked + fi + stat=$? + if test $stat -ne 0; then + rm -f "$tmpdepfile1" "$tmpdepfile2" + exit $stat + fi + + for tmpdepfile in "$tmpdepfile1" "$tmpdepfile2" + do + test -f "$tmpdepfile" && break + done + if test -f "$tmpdepfile"; then + sed -e "s,^.*\.[$lower]*:,$object:," "$tmpdepfile" > "$depfile" + # Add 'dependent.h:' lines. + sed -ne '2,${ + s/^ *// + s/ \\*$// + s/$/:/ + p + }' "$tmpdepfile" >> "$depfile" + else + make_dummy_depfile + fi + rm -f "$tmpdepfile" "$tmpdepfile2" + ;; + +tru64) + # The Tru64 compiler uses -MD to generate dependencies as a side + # effect. 'cc -MD -o foo.o ...' puts the dependencies into 'foo.o.d'. + # At least on Alpha/Redhat 6.1, Compaq CCC V6.2-504 seems to put + # dependencies in 'foo.d' instead, so we check for that too. + # Subdirectories are respected. + set_dir_from "$object" + set_base_from "$object" + + if test "$libtool" = yes; then + # Libtool generates 2 separate objects for the 2 libraries. These + # two compilations output dependencies in $dir.libs/$base.o.d and + # in $dir$base.o.d. We have to check for both files, because + # one of the two compilations can be disabled. We should prefer + # $dir$base.o.d over $dir.libs/$base.o.d because the latter is + # automatically cleaned when .libs/ is deleted, while ignoring + # the former would cause a distcleancheck panic. + tmpdepfile1=$dir$base.o.d # libtool 1.5 + tmpdepfile2=$dir.libs/$base.o.d # Likewise. + tmpdepfile3=$dir.libs/$base.d # Compaq CCC V6.2-504 + "$@" -Wc,-MD + else + tmpdepfile1=$dir$base.d + tmpdepfile2=$dir$base.d + tmpdepfile3=$dir$base.d + "$@" -MD + fi + + stat=$? + if test $stat -ne 0; then + rm -f "$tmpdepfile1" "$tmpdepfile2" "$tmpdepfile3" + exit $stat + fi + + for tmpdepfile in "$tmpdepfile1" "$tmpdepfile2" "$tmpdepfile3" + do + test -f "$tmpdepfile" && break + done + # Same post-processing that is required for AIX mode. + aix_post_process_depfile + ;; + +msvc7) + if test "$libtool" = yes; then + showIncludes=-Wc,-showIncludes + else + showIncludes=-showIncludes + fi + "$@" $showIncludes > "$tmpdepfile" + stat=$? + grep -v '^Note: including file: ' "$tmpdepfile" + if test $stat -ne 0; then + rm -f "$tmpdepfile" + exit $stat + fi + rm -f "$depfile" + echo "$object : \\" > "$depfile" + # The first sed program below extracts the file names and escapes + # backslashes for cygpath. The second sed program outputs the file + # name when reading, but also accumulates all include files in the + # hold buffer in order to output them again at the end. This only + # works with sed implementations that can handle large buffers. + sed < "$tmpdepfile" -n ' +/^Note: including file: *\(.*\)/ { + s//\1/ + s/\\/\\\\/g + p +}' | $cygpath_u | sort -u | sed -n ' +s/ /\\ /g +s/\(.*\)/'"$tab"'\1 \\/p +s/.\(.*\) \\/\1:/ +H +$ { + s/.*/'"$tab"'/ + G + p +}' >> "$depfile" + echo >> "$depfile" # make sure the fragment doesn't end with a backslash + rm -f "$tmpdepfile" + ;; + +msvc7msys) + # This case exists only to let depend.m4 do its work. It works by + # looking at the text of this script. This case will never be run, + # since it is checked for above. + exit 1 + ;; + +#nosideeffect) + # This comment above is used by automake to tell side-effect + # dependency tracking mechanisms from slower ones. + +dashmstdout) + # Important note: in order to support this mode, a compiler *must* + # always write the preprocessed file to stdout, regardless of -o. + "$@" || exit $? + + # Remove the call to Libtool. + if test "$libtool" = yes; then + while test "X$1" != 'X--mode=compile'; do + shift + done + shift + fi + + # Remove '-o $object'. + IFS=" " + for arg + do + case $arg in + -o) + shift + ;; + $object) + shift + ;; + *) + set fnord "$@" "$arg" + shift # fnord + shift # $arg + ;; + esac + done + + test -z "$dashmflag" && dashmflag=-M + # Require at least two characters before searching for ':' + # in the target name. This is to cope with DOS-style filenames: + # a dependency such as 'c:/foo/bar' could be seen as target 'c' otherwise. + "$@" $dashmflag | + sed "s|^[$tab ]*[^:$tab ][^:][^:]*:[$tab ]*|$object: |" > "$tmpdepfile" + rm -f "$depfile" + cat < "$tmpdepfile" > "$depfile" + # Some versions of the HPUX 10.20 sed can't process this sed invocation + # correctly. Breaking it into two sed invocations is a workaround. + tr ' ' "$nl" < "$tmpdepfile" \ + | sed -e 's/^\\$//' -e '/^$/d' -e '/:$/d' \ + | sed -e 's/$/ :/' >> "$depfile" + rm -f "$tmpdepfile" + ;; + +dashXmstdout) + # This case only exists to satisfy depend.m4. It is never actually + # run, as this mode is specially recognized in the preamble. + exit 1 + ;; + +makedepend) + "$@" || exit $? + # Remove any Libtool call + if test "$libtool" = yes; then + while test "X$1" != 'X--mode=compile'; do + shift + done + shift + fi + # X makedepend + shift + cleared=no eat=no + for arg + do + case $cleared in + no) + set ""; shift + cleared=yes ;; + esac + if test $eat = yes; then + eat=no + continue + fi + case "$arg" in + -D*|-I*) + set fnord "$@" "$arg"; shift ;; + # Strip any option that makedepend may not understand. Remove + # the object too, otherwise makedepend will parse it as a source file. + -arch) + eat=yes ;; + -*|$object) + ;; + *) + set fnord "$@" "$arg"; shift ;; + esac + done + obj_suffix=`echo "$object" | sed 's/^.*\././'` + touch "$tmpdepfile" + ${MAKEDEPEND-makedepend} -o"$obj_suffix" -f"$tmpdepfile" "$@" + rm -f "$depfile" + # makedepend may prepend the VPATH from the source file name to the object. + # No need to regex-escape $object, excess matching of '.' is harmless. + sed "s|^.*\($object *:\)|\1|" "$tmpdepfile" > "$depfile" + # Some versions of the HPUX 10.20 sed can't process the last invocation + # correctly. Breaking it into two sed invocations is a workaround. + sed '1,2d' "$tmpdepfile" \ + | tr ' ' "$nl" \ + | sed -e 's/^\\$//' -e '/^$/d' -e '/:$/d' \ + | sed -e 's/$/ :/' >> "$depfile" + rm -f "$tmpdepfile" "$tmpdepfile".bak + ;; + +cpp) + # Important note: in order to support this mode, a compiler *must* + # always write the preprocessed file to stdout. + "$@" || exit $? + + # Remove the call to Libtool. + if test "$libtool" = yes; then + while test "X$1" != 'X--mode=compile'; do + shift + done + shift + fi + + # Remove '-o $object'. + IFS=" " + for arg + do + case $arg in + -o) + shift + ;; + $object) + shift + ;; + *) + set fnord "$@" "$arg" + shift # fnord + shift # $arg + ;; + esac + done + + "$@" -E \ + | sed -n -e '/^# [0-9][0-9]* "\([^"]*\)".*/ s:: \1 \\:p' \ + -e '/^#line [0-9][0-9]* "\([^"]*\)".*/ s:: \1 \\:p' \ + | sed '$ s: \\$::' > "$tmpdepfile" + rm -f "$depfile" + echo "$object : \\" > "$depfile" + cat < "$tmpdepfile" >> "$depfile" + sed < "$tmpdepfile" '/^$/d;s/^ //;s/ \\$//;s/$/ :/' >> "$depfile" + rm -f "$tmpdepfile" + ;; + +msvisualcpp) + # Important note: in order to support this mode, a compiler *must* + # always write the preprocessed file to stdout. + "$@" || exit $? + + # Remove the call to Libtool. + if test "$libtool" = yes; then + while test "X$1" != 'X--mode=compile'; do + shift + done + shift + fi + + IFS=" " + for arg + do + case "$arg" in + -o) + shift + ;; + $object) + shift + ;; + "-Gm"|"/Gm"|"-Gi"|"/Gi"|"-ZI"|"/ZI") + set fnord "$@" + shift + shift + ;; + *) + set fnord "$@" "$arg" + shift + shift + ;; + esac + done + "$@" -E 2>/dev/null | + sed -n '/^#line [0-9][0-9]* "\([^"]*\)"/ s::\1:p' | $cygpath_u | sort -u > "$tmpdepfile" + rm -f "$depfile" + echo "$object : \\" > "$depfile" + sed < "$tmpdepfile" -n -e 's% %\\ %g' -e '/^\(.*\)$/ s::'"$tab"'\1 \\:p' >> "$depfile" + echo "$tab" >> "$depfile" + sed < "$tmpdepfile" -n -e 's% %\\ %g' -e '/^\(.*\)$/ s::\1\::p' >> "$depfile" + rm -f "$tmpdepfile" + ;; + +msvcmsys) + # This case exists only to let depend.m4 do its work. It works by + # looking at the text of this script. This case will never be run, + # since it is checked for above. + exit 1 + ;; + +none) + exec "$@" + ;; + +*) + echo "Unknown depmode $depmode" 1>&2 + exit 1 + ;; +esac + +exit 0 + +# Local Variables: +# mode: shell-script +# sh-indentation: 2 +# eval: (add-hook 'before-save-hook 'time-stamp) +# time-stamp-start: "scriptversion=" +# time-stamp-format: "%:y-%02m-%02d.%02H" +# time-stamp-time-zone: "UTC0" +# time-stamp-end: "; # UTC" +# End: diff --git a/Packages/asio-1.36.0/doc/1.png b/Packages/asio-1.36.0/doc/1.png new file mode 100644 index 0000000..6003ad3 Binary files /dev/null and b/Packages/asio-1.36.0/doc/1.png differ diff --git a/Packages/asio-1.36.0/doc/2.png b/Packages/asio-1.36.0/doc/2.png new file mode 100644 index 0000000..f7c1578 Binary files /dev/null and b/Packages/asio-1.36.0/doc/2.png differ diff --git a/Packages/asio-1.36.0/doc/3.png b/Packages/asio-1.36.0/doc/3.png new file mode 100644 index 0000000..3ff0a93 Binary files /dev/null and b/Packages/asio-1.36.0/doc/3.png differ diff --git a/Packages/asio-1.36.0/doc/4.png b/Packages/asio-1.36.0/doc/4.png new file mode 100644 index 0000000..6aa29fc Binary files /dev/null and b/Packages/asio-1.36.0/doc/4.png differ diff --git a/Packages/asio-1.36.0/doc/5.png b/Packages/asio-1.36.0/doc/5.png new file mode 100644 index 0000000..36e7858 Binary files /dev/null and b/Packages/asio-1.36.0/doc/5.png differ diff --git a/Packages/asio-1.36.0/doc/6.png b/Packages/asio-1.36.0/doc/6.png new file mode 100644 index 0000000..c943676 Binary files /dev/null and b/Packages/asio-1.36.0/doc/6.png differ diff --git a/Packages/asio-1.36.0/doc/7.png b/Packages/asio-1.36.0/doc/7.png new file mode 100644 index 0000000..20940de Binary files /dev/null and b/Packages/asio-1.36.0/doc/7.png differ diff --git a/Packages/asio-1.36.0/doc/8.png b/Packages/asio-1.36.0/doc/8.png new file mode 100644 index 0000000..d8e34d4 Binary files /dev/null and b/Packages/asio-1.36.0/doc/8.png differ diff --git a/Packages/asio-1.36.0/doc/asio.png b/Packages/asio-1.36.0/doc/asio.png new file mode 100644 index 0000000..c05fd3a Binary files /dev/null and b/Packages/asio-1.36.0/doc/asio.png differ diff --git a/Packages/asio-1.36.0/doc/asio/examples.html b/Packages/asio-1.36.0/doc/asio/examples.html new file mode 100644 index 0000000..3d2c023 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/examples.html @@ -0,0 +1,56 @@ + + + +Examples + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
    +
  • + C++11 Examples: Illustrates + the use of Asio using only C++11 language and library features. Where necessary, + the examples make use of selected Boost C++ libraries. +
    • +
  • + C++14 Examples: Contains + a limited set of the C++03 Asio examples, updated to use only C++14 library + and language facilities. These examples do not make direct use of Boost + C++ libraries. +
    • +
  • + C++17 Examples: Selected + examples illustrating C++17 usage in conjunction with Technical Specifications. +
    • +
  • + C++20 Examples: Selected + examples using C++20 language features. +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/examples/cpp11_examples.html b/Packages/asio-1.36.0/doc/asio/examples/cpp11_examples.html new file mode 100644 index 0000000..4e1e751 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/examples/cpp11_examples.html @@ -0,0 +1,771 @@ + + + +C++11 Examples + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + Allocation +
+

+ This example shows how to customise the allocation of memory associated with + asynchronous operations. +

+
+
+ + Buffers +
+

+ This example demonstrates how to create reference counted buffers that can + be used with socket read and write operations. +

+
+
+ + Chat +
+

+ This example implements a chat server and client. The programs use a custom + protocol with a fixed length message header and variable length message body. +

+
+

+ The following POSIX-specific chat client demonstrates how to use the posix::stream_descriptor + class to perform console input and output. +

+
+
+ + Deferred +
+

+ Examples showing how to use the deferred completion token. +

+
+
+ + Echo +
+

+ A collection of simple clients and servers, showing the use of both synchronous + and asynchronous operations. +

+
+
+ + Fork +
+

+ These POSIX-specific examples show how to use Asio in conjunction with the + fork() + system call. The first example illustrates the steps required to start a + daemon process: +

+
+

+ The second example demonstrates how it is possible to fork a process from + within a completion handler. +

+
+
+ + Futures +
+

+ This example demonstrates how to use std::future in conjunction with Asio's + asynchronous operations. +

+
+
+ + Handler + Tracking +
+

+ This example header file shows how to implement custom handler tracking. +

+
+

+ This example program shows how to include source location information in + the handler tracking output. +

+
+
+ + HTTP + Client +
+

+ Example programs implementing simple HTTP 1.0 clients. These examples show + how to use the read_until + and async_read_until + functions. +

+
+
+ + HTTP + Server +
+

+ This example illustrates the use of asio in a simple single-threaded server + implementation of HTTP 1.0. It demonstrates how to perform a clean shutdown + by cancelling all outstanding asynchronous operations. +

+
+
+ + HTTP + Server 2 +
+

+ An HTTP server using an io_context-per-CPU design. +

+
+
+ + HTTP + Server 3 +
+

+ An HTTP server using a single io_context and a thread pool calling io_context::run(). +

+
+
+ + HTTP + Server 4 +
+

+ A single-threaded HTTP server implemented using stackless coroutines. +

+
+
+ + ICMP +
+

+ This example shows how to use raw sockets with ICMP to ping a remote host. +

+
+
+ + Invocation +
+

+ This example shows how to customise handler invocation. Completion handlers + are added to a priority queue rather than executed immediately. +

+
+
+ + Iostreams +
+

+ Two examples showing how to use ip::tcp::iostream. +

+
+
+ + Multicast +
+

+ An example showing the use of multicast to transmit packets to a group of + subscribers. +

+
+
+ + Nonblocking +
+

+ Example demonstrating reactor-style operations for integrating a third-party + library that wants to perform the I/O operations itself. +

+
+
+ + Operations +
+

+ Examples showing how to implement composed asynchronous operations as reusable + library functions. +

+
+
+ + Parallel + Groups +
+

+ Examples showing how to use the experimental::make_parallel_group operation. +

+
+
+ + Porthopper +
+

+ Example illustrating mixed synchronous and asynchronous operations. +

+
+
+ + Serialization +
+

+ This example shows how Boost.Serialization can be used with asio to encode + and decode structures for transmission over a socket. +

+
+
+ + Services +
+

+ This example demonstrates how to integrate custom functionality (in this + case, for logging) into asio's io_context, + and how to use a custom service with basic_stream_socket<>. +

+
+
+ + SOCKS + 4 +
+

+ Example client program implementing the SOCKS 4 protocol for communication + via a proxy. +

+
+
+ + Spawn +
+

+ Example of using the asio::spawn() function, a wrapper around the Boost.Context + library, to implement a chain of asynchronous operations using stackful coroutines. +

+
+
+ + SSL +
+

+ Example client and server programs showing the use of the ssl::stream<> + template with asynchronous operations. +

+
+
+ + Timeouts +
+

+ A collection of examples showing how to cancel long running asynchronous + operations after a period of time. +

+
+
+ + Timers +
+

+ Example showing how to customise basic_waitable_timer using a different clock + type. +

+
+
+ + Type + Erasure +
+

+ Example showing how to use any_completion_handler to enable + separate compilation of asynchronous operations. +

+
+
+ + UNIX + Domain Sockets +
+

+ Examples showing how to use UNIX domain (local) sockets. +

+
+
+ + Windows +
+

+ An example showing how to use the Windows-specific function TransmitFile with Asio. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/examples/cpp14_examples.html b/Packages/asio-1.36.0/doc/asio/examples/cpp14_examples.html new file mode 100644 index 0000000..d0559e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/examples/cpp14_examples.html @@ -0,0 +1,209 @@ + + + +C++14 Examples + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + Deferred +
+

+ Examples showing how to use the deferred completion token. +

+
+
+ + Echo +
+

+ A collection of simple clients and servers, showing the use of both synchronous + and asynchronous operations. +

+
+
+ + Executors +
+

+ Examples showing how to use the executor-related facilities. +

+
+
+ + Iostreams +
+

+ Two examples showing how to use ip::tcp::iostream. +

+
+
+ + Operations +
+

+ Examples showing how to implement composed asynchronous operations as reusable + library functions. +

+
+

+ Examples showing how to expose callback-based APIs as asynchronous operations. +

+
+
+ + Parallel + Groups +
+

+ Examples showing how to use the experimental::make_parallel_group operation. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/examples/cpp17_examples.html b/Packages/asio-1.36.0/doc/asio/examples/cpp17_examples.html new file mode 100644 index 0000000..36e88a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/examples/cpp17_examples.html @@ -0,0 +1,58 @@ + + + +C++17 Examples + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + Coroutines + TS Support +
+

+ Examples showing how to implement a chain of asynchronous operations using + the Coroutines TS. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/examples/cpp20_examples.html b/Packages/asio-1.36.0/doc/asio/examples/cpp20_examples.html new file mode 100644 index 0000000..f2ba5bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/examples/cpp20_examples.html @@ -0,0 +1,175 @@ + + + +C++20 Examples + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + Channels +
+

+ Example showing how to use a channel in conjunction with C++20 coroutines. +

+
+
+ + Coroutines +
+

+ Examples showing how to implement a chain of asynchronous operations using + C++20 Coroutines. +

+
+
+ + Invocation +
+

+ This example shows how to customise handler invocation using a user-defined + completion executor. +

+
+
+ + Operations +
+

+ Examples showing how to implement composed asynchronous operations as reusable + library functions. +

+
+

+ Examples showing how to expose callback-based APIs as asynchronous operations. +

+
+
+ + Type + Erasure +
+

+ Example showing how to use any_completion_handler to enable + separate compilation of asynchronous operations. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/history.html b/Packages/asio-1.36.0/doc/asio/history.html new file mode 100644 index 0000000..aa6fbad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/history.html @@ -0,0 +1,6364 @@ + + + +Revision History + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ + Asio + 1.36.0 +

+
    +
  • + Fixed an issue, introduced in Asio 1.35.0, that prevented the creation + of internal threads required for running some asynchronous operations on + a thread_pool. +
    • +
  • + Fixed co_spawn to adhere + to the asynchronous operation requirement for non-reentrant invocation + of the completion handler. +
    • +
  • + Added the [[noreturn]] attribute to asio::detail::throw_exception. +
    • +
  • + Fixed compilation errors in channel<void(error_code)> and concurrent_channel<void(error_code)>. +
    • +
  • + Fixed a compilation issue with the Bullseye compiler. +
    • +
  • + Fixed an awaitable coroutine + compile error with the clang shipped with MSVC. +
    • +
  • + Fixed support for platforms that don't define SA_NOCLDWAIT. +
    • +
  • + Worked around a warning that occurs when building with _FORTIFY_SOURCE + on recent g++. +
    • +
  • + Added a documentation note on basic_signal_set + async signal safety. +
    • +
+

+ + Asio + 1.35.0 +

+
    +
  • + Added allocator constructors to execution_context, + io_context and thread_pool. The supplied allocator is + used for allocating objects associated with the execution context, such + as services, the internal state for I/O objects like sockets or timers, + and strands. The allocator may also be accessed by user code via the execution_context::allocator<> + class template. +
    • +
  • + Extended the allocation example to cover execution_context + allocation. +
    • +
  • + Added a new configuration parameter "timer" / "heap_reserve" + that may be used to reserve space in the vector used for a timer queue's + heap. This may be used to preallocate sufficient space such that the creation + of new timers does not trigger further allocations. +
    • +
  • + Added a new configuration parameter "resolver" / "threads" + that is used to specify the number of internal threads used by async_resolve to emulate asynchronous + address resolution. If this is set to a non-zero value, that number of + threads will be created when the first resolver object is constructed. + Otherwise, it defaults to a single thread that is created on the first + call to async_resolve. +
    • +
  • + Removed deadline_timer, + basic_deadline_timer and + time_traits from the convenience + header asio.hpp. +
    • +
  • + Ensured that the Windows named pipes created by connect_pipe + use unique names that don't conflict if Asio is used in multiple, independent + plug-in DLLs. +
    • +
  • + Changed ASIO_CONCURRENCY_HINT_SAFE + to be consistent with the io_context + default constructor. +
    • +
  • + Fixed the documentation for ASIO_CONCURRENCY_HINT_UNSAFE_IO + to reflect that registration locking is still enabled. +
    • +
  • + Added separate b2 and cmake build + targets for optional dependencies. +
    • +
  • + Fixed a build error in the serialization example. +
    • +
  • + Fixed some shadow variable warnings. +
    • +
+

+ + Asio + 1.34.2 +

+
    +
  • + Fixed an ambiguous overload issue that occurred when passing a std::span to the asio::buffer + function. +
    • +
  • + Added overview documentation on the available runtime configuration options. +
    • +
  • + Updated the overview documentation to reflect the use of deferred as the default completion token. +
    • +
  • + Updated the async_result + documentation to reflect the current type requirements placed on specialisations + of the trait. +
    • +
+

+ + Asio + 1.34.1 +

+
    +
  • + Added noexcept qualifiers + to various local::basic_endpoint member functions, to make + it consistent with ip::basic_endpoint. +
    • +
  • + Fixed the asio::config class's handling of integer values. +
    • +
  • + Fixed a use-after-move error in experimental::ranged_parallel_group. +
    • +
  • + Fixed an incorrect default template argument in the implementation of + experimental::promise. +
    • +
  • + Fixed the io_uring implementation + so that it does not attempt to re-register internal descriptors with the + reactor after a fork, if they were not previously registered. +
    • +
  • + Fixed an uninitialised member in the thread_pool + default constructor. +
    • +
  • + Removed some spurious macro definitions that were left after the removal + of deprecated buffer functionality. +
    • +
  • + Added documentation to clarify the use of file_base::flags + when opening a file. +
    • +
+

+ + Asio + 1.34.0 +

+
    +
  • + Relaxed disposition requirements to require only nothrow move, rather than + copy. +
    • +
  • + Fixed compile error when threading support is disabled. +
    • +
  • + Fixed compile error when ASIO_DISABLE_SMALL_BLOCK_RECYCLING + is defined. +
    • +
  • + Fixed compile error when using Clang 19. +
    • +
  • + Changed thread_pool::join() + to ensure that it stops threads that are subsequently added to the pool + using thread_pool::attach(). +
    • +
  • + Fixed the offsets passed to io_uring_prep_write_fixed + and io_uring_prep_read_fixed, + when they are used for stream-oriented operations. +
    • +
+

+ + Asio + 1.33.0 +

+
    +
  • + Added support for using byte spans and sequences of byte spans as buffer + sequences. This means that they can be passed directly to I/O operations + such as async_read. +
    • +
  • + Added support for dispositions, which are types that can be used to test + whether an asynchronous operation completed without error. This includes + error_code and exception_ptr, but can be extended to + user types via specialisation of the disposition_traits + class template. Generic code that is intended to work in terms of dispositions + should not use asio::disposition_traits directly, but instead: +
      +
    • + Test whether a disposition holds no error by comparing against asio::no_error (of type asio::no_error_t). +
      • +
    • + Use asio::to_exception_ptr to convert a disposition + to a std::exception_ptr. +
      • +
    • + Use asio::throw_exception to throw an exception + that corresponds to the disposition, after first testing the disposition + against asio::no_error. +
      • +
    +
    • +
  • + Added disposition support to the asio::use_future + completion token, asio::awaitable<>-based coroutines, asio::spawn(), + and asio::experimental::cancellation_condition. +
    • +
  • + Added the execution_context::service_maker + abstract base class. A service_maker + is an object that is passed to an execution context's constructor, and + allows services to be added at context construction time. Additional constructor + overloads have been added to io_context + and thread_pool that accept + a service_maker. +
    • +
  • +

    + Added asio::config. The config + class provides access to configuration parameters that are associated with + an execution context. The class is intended for use by asio internals, + or by libraries or user-provided abstractions that build on top of asio. + These configuration parameters will typically be used to fine tune behaviour, + such as enabling or disabling certain optimisations. When constructing + an execution context, such as an io_context, + the caller may optionally pass a service_maker + to install a concrete configuration service into the context. For example:
    +

    +
    asio::io_context ctx{asio::config_from_env{}};
+
    +

    + The configuration parameters' values are accessed using the config class, passing a section, key + and default value:
    +

    +
    asio::config cfg{ctx};
+bool enable_locking = cfg.get("scheduler", "locking", true);
+
    +
    • +
  • + Added an initial set of configuration parameters recognised by asio's + io_context and thread_pool implementations: +
      +
    • + "scheduler" / "concurrency_hint" (int, default + 0) - A suggestion to + the scheduler of how many active should be used for running completion + handlers. +
      • +
    • + "scheduler" / "locking" (bool, default true) - May be set to false to disable locking in the scheduler, + in which case care must be taken not to perform concurrent operations + on the execution context or its I/O objects. +
      • +
    • + "scheduler" / "locking_spin_count" (int, default + 0) - The number of times + to first attempt to acquire the lock without blocking. +
      • +
    • + "scheduler" / "task_usec" (long, default -1) + - The maximum time that the scheduler will wait for its reactor task + to complete. +
      • +
    • + "scheduler" / "wait_usec" (long, default -1) + - The maximum time that the scheduler will wait on its wakeup event + in an idle thread. +
      • +
    • + "reactor" / "preallocated_io_objects" (unsigned + int, default 0) - The + number of internal reactor I/O object states to allocate at construction. +
      • +
    • + "reactor" / "registration_locking" (bool, default + true) - May be set to + false to disable locking + in the reactor around I/O object registration, in which case care + must be taken not to concurrently open or close I/O objects. +
      • +
    • + "reactor" / "registration_locking_spin_count" + (int, default 0) - The + number of times to first attempt to acquire the lock without blocking. +
      • +
    • + "reactor" / "io_locking" (bool, default true) - May be set to false to disable per I/O object locking + in the reactor, in which case the execution context must be single-threaded + and care must be taken not to perform concurrent calls to I/O operations' + initiating functions. +
      • +
    • + "reactor" / "io_locking_spin_count" (int, default + 0) - The number of times + to first attempt to acquire the lock without blocking. +
      • +
    +
    • +
  • + Removed some previously deprecated facilities: +
      +
    • + Removed Boost.Coroutine-based spawn() overloads. The spawn() function now works only with the + fiber support in Boost.Context. +
      • +
    • + Removed deprecated asio::connect + overloads. +
      • +
    • + Removed deprecated ip::address_v4 + member functions. +
      • +
    • + Removed deprecated ip::address_v6 + member functions. +
      • +
    • + Removed deprecated constant socket_base::max_connections. +
      • +
    • + Removed deprecated classes const_buffers_1 + and mutable_buffers_1. +
      • +
    • + Removed deprecated function buffer_cast. +
      • +
    • + Removed deprecated use_future_t::operator[]. +
      • +
    • + Removed deprecated alias experimental::append. +
      • +
    • + Removed deprecated alias experimental::prepend. +
      • +
    • + Removed deprecated alias experimental::as_tuple. +
      • +
    • + Removed deprecated alias experimental::deferred. +
      • +
    • + Removed deprecated class ssl::rfc2818_verification. +
      • +
    • + Removed deprecated alias io_service. +
      • +
    • + Removed deprecated class io_context::work. +
      • +
    • + Removed deprecated io_context + run functions. +
      • +
    • + Removed deprecated function io_context::reset. +
      • +
    • + Removed deprecated io_context::service + member functions. +
      • +
    • + Removed deprecated dispatch + and post members + from io_context andxi + io_context::strand. +
      • +
    +
    • +
  • + Deprecated basic_io_object. +
    • +
  • + Deprecated deadline_timer + and associated types. +
    • +
  • + Added rvalue-qualified operator() overloads to associating binders. +
    • +
  • + Added support for modular build structure. +
    • +
  • + Fixed spawn() + of functions that return move-only types. +
    • +
  • + Fixed co_composed to not + require concepts support. +
    • +
  • + Fixed the epoll reactor to not try to re-register regular file descriptors + after fork. +
    • +
  • + Fixed a leak in ssl::detail::engine move assignment. +
    • +
+

+ + Asio + 1.32.0 +

+
    +
  • + Fixed an issue in co_composed + caused by a missing decay. +
    • +
  • + Fixed an issue in co_composed + due to a missing reference in a cast to a base class type. +
    • +
  • + Changed to use the standard C++20 coroutine feature test macro by default. +
    • +
  • + Changed to use std::aligned_alloc on Android, when available. +
    • +
  • + Fixed an integer conversion warning in ip::address_v6, + on iOS/tvOS. +
    • +
  • + Added missing include of <malloc.h> + required for _alloca. +
    • +
  • + Changed to use a standard feature test macro to check if the standard library + supports std::invoke_result. +
    • +
  • + Fixed handling of file_base::append + in Windows file support. +
    • +
  • + Fixed some warnings in IP address to string conversion. +
    • +
  • + Added support for using co_spawn + when exceptions are disabled. +
    • +
  • + Fixed spawn.hpp header to be self-contained. +
    • +
  • + Enabled TLS v1.3 options for WolfSSL. +
    • +
  • + Fixed experimental::coro implementation to use the correct + cancellation slot. +
    • +
  • + Fixed io_context::strand::wrap() + so that its return value has an associated executor. +
    • +
  • + Marked constexpr global variables + as inline. +
    • +
  • + Documentation fixes. +
    • +
+

+ + Asio + 1.31.0 +

+
    +
  • +

    + Changed the default_completion_token + trait's primary template to select deferred + as the default completion token. As a result, most asynchronous operations' + initiating functions will return a deferred asynchronous operation by default. + For example, the completion token can be omitted when calling asynchronous + operations from an awaitable + coroutine:
    +

    +
    awaitable<void> echo(ip::tcp::socket& my_socket)
+{
+  char data[1024];
+  for (;;)
+  {
+    std::size_t n = co_await my_socket.async_read_some(buffer(data));
+    co_await async_write(my_socket, buffer(data, n));
+  }
+}
+
    +

    + or when using an operation that accepts asynchronous operations as function + objects, such as experimental::make_parallel_group:
    +

    +
    experimental::make_parallel_group(
+    my_socket.async_read_some(buffer(data)),
+    my_timer.async_wait()
+  ).async_wait(/* ... */);
+
    +
    • +
  • + Added the is_completion_condition + trait and used it to add the missing default completion tokens to overloads + of async_read, async_read_at, async_write, + and async_write_at. +
    • +
  • + Added the is_connect_condition + trait and used it disambiguate overloads of async_connect + when the completion token is defaulted. +
    • +
  • +

    + Extended the completion token adapters as_tuple, + bind_allocator, bind_cancellation_slot, bind_executor, bind_immediate_executor, + and redirect_error to allow + them to be used as partial completion token adapters. + This means that they can be created without explicitly supplying a completion + token. Instead, when the adapter is passed to an asynchronous operation, + it will automatically determine the operation's default completion token + and adapt it. For example, the expression:
    +

    +
    my_socket.async_read_some(my_buffer, as_tuple)
+
    +

    + will return a deferred asynchronous operation with the completion arguments + packaged in a tuple. They may also be applied using the deferred + operations' pipe operator:
    +

    +
    error_code e;
+co_await (async_write(my_socket, my_buffer) | redirect_error(e));
+
    +
    • +
  • +

    + Added the cancel_after + and cancel_at completion + token adapters. These may be used to adapt any asynchronous operation to + emit a cancellation signal after a specified duration or at an absolute + time point. For example:
    +

    +
    my_socket.async_read_some(my_buffer,
+    cancel_after(std::chrono::seconds(10),
+      [](error_code e, std::size_t n)
+      {
+        // ...
+      }));
+
    +

    + This cancellation is implemented internally using a basic_waitable_timer. + By default, this timer is created using the asynchronous operation's I/O + executor. If the operation does specify its I/O executor, a timer may be + explicitly supplied:
    +

    +
    my_socket.async_read_some(my_buffer,
+    cancel_after(my_timer, std::chrono::seconds(10),
+      [](error_code e, std::size_t n)
+      {
+        // ...
+      }));
+
    +

    + These adapters may also be used as partial completion token adapters, as + in:
    +

    +
    co_await my_socket.async_read_some(my_buffer, cancel_after(5s));
+
    +

    + or:
    +

    +
    co_await (
+    async_write(my_socket, my_buffer) | as_tuple
+      | cancel_after(std::chronos::seconds(10)
+  );
+
    +

    + or to adapt other partial completion token adapters:
    +

    +
    co_await my_socket.async_read_some(my_buffer, cancel_after(5s, as_tuple));
+
    +

    + Note that, since the implementation in terms of a timer introduces a parallel + async_wait operation, it + is the responsibility of the caller to ensure that the asynchronous operation + is performed in an implicit or explicit strand. +

    +
    • +
  • + Changed all completion token adapters to ensure they correctly propagate + the asynchronous operation's I/O executor during adaptation. +
    • +
  • + Fixed async_compose and + co_composed to correctly + indicate if they have an I/O executor. +
    • +
  • + Moved co_composed out of + the experimental namespace. +
    • +
  • +

    + Added composed, which creates + an initiation function object from a stateful implementation. It is similar + to co_composed, but for + regular function objects rather than C++20 coroutines. For example: +

    +
    struct async_echo_implementation
+{
+  tcp::socket& socket_;
+  mutable_buffer buffer_;
+  enum { starting, reading, writing } state_;
+
+  template <typename Self>
+  void operator()(Self& self,
+      error_code error,
+      std::size_t n)
+  {
+    switch (state_)
+    {
+      // ...
+    }
+  }
+};
+
+template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    mutable_buffer buffer,
+    CompletionToken&& token)
+{
+  return async_initiate<CompletionToken,
+    void(error_code, std::size_t)>(
+      composed(
+        async_echo_implementation{socket, buffer,
+          async_echo_implementation::starting}, socket),
+      token, error_code{}, 0);
+}
+
    +

    + The async_compose function + has been changed to be a thin wrapper around composed. + However, unlike async_compose, + composed allows arguments + to be passed to the stateful implementation when the operation is initiated. +

    +
    • +
  • + Changed the detached completion + token to work with asynchronous operations that have multiple completion + signatures. +
    • +
  • + Changed async_initiate + to allow an empty variadic list of completion signatures, which would indicate + that an asynchronous operation never completes. +
    • +
  • +

    + Added overloads of async_initiate + that automatically deduce the type of the completion token. For example:
    +

    +
    async_initiate(co_composed(/* ... */), detached, arg_1, arg_2);
+
    +

    + will deduce the token type from the argument detached. +

    +
    • +
  • + Added async_immediate which + implements a trivial asynchronous operation that completes immediately, + using an associated immediate executor if available. It is intended for + use within asynchronous compositions to make it easier to provide optimised + immediate completion. +
    • +
  • + Updated the documentation for various asynchronous operations to specify + immediate completion in terms of async_immediate. +
    • +
  • + Enabled SFINAE-based partial specialisation of the associator + trait. +
    • +
  • + Changed to use the recycling allocator as the fallback for all operations, + rather than calling the underlying recycling allocation helper functions + directly. +
    • +
  • + Fixed the deferred implementation + to ensure that the wrapped initiation function object's copyability is + correctly propagated. +
    • +
  • + Fixed experimental::coro compatibility with clang 15. +
    • +
  • + Fixed deduction of a completion handler's default immediate executor type. +
    • +
  • + Don't use ioctl to modify + the non-blocking mode on socket or descriptors that have been assigned, + as they may originate from an external source. +
    • +
  • + Don't call fcntl with + F_SETFL if the flags aren't + changing. +
    • +
  • + Don't enable non-blocking mode when performing an async_wait + operation on sockets or descriptors. +
    • +
  • + Update some composed operation examples to destroy the timer object before + calling the completion handler. +
    • +
  • + Fix read_until regex support + when BOOST_ASIO_NO_DYNAMIC_BUFFER_V1 + is defined. +
    • +
+

+ + Asio + 1.30.2 +

+
    +
  • + Fixed co_spawn to correctly + propagate exceptions resulting from cancellation to the completion handler. +
    • +
  • + Added calls to std::launder to fix undefined behaviour in + awaitable<> + internal storage. +
    • +
  • + Added missing handling of the file_base::append + flag in the Windows implementation of file support. +
    • +
  • + Updated the socket and descriptor implementations to add more cases where + they will fall back to fcntl + if a call to ioctl fails. +
    • +
  • + Fixed a compile error that occurred when channels and experimental::coro + were both used in the same translation unit. +
    • +
  • + Added missing CancellationSlot type requirements to documentation. +
    • +
  • + Minor documentation updates. +
    • +
+

+ + Asio + 1.30.1 +

+
    +
  • + Fixed the async_result + primary template's concept checking to correctly handle lvalue-qualified + completion signatures. +
    • +
  • + Fixed some compile errors that could arise when using the bind_allocator, bind_executor, + bind_immediate_executor + and bind_cancellation_slot + completion token adapters to adapt each other. +
    • +
  • + Changed the experimental::ranged_parallel_group + operation so that it moves the completion_order + vector when invoking the completion handler. +
    • +
  • + Fixed the asio/experimental/parallel_group.hpp header + so that it is self-contained. +
    • +
  • + Fixed some warnings about deprecated implicit copy constructors on ip::basic_resolver_query, io_context::strand, + and coroutine. +
    • +
  • + Updated the version specification used to initialise Winsock. +
    • +
  • + Fixed the documentation hyperlinks for the deduced return types of asynchronous + operations' initiating functions. +
    • +
+

+ + Asio + 1.30.0 +

+
    +
  • + Fixed compatibility between any_completion_handler + and compilation using ASIO_USE_TS_EXECUTOR_AS_DEFAULT. +
    • +
  • + Fixed a crash that may occur when attempting to access a default-constructed + any_completion_handler + object's associators. +
    • +
  • + Fixed ssl::stream<> + class's async_handshake + operation so that it works with a defaulted completion token. +
    • +
  • + Updated all examples to use C++11 as the minimum language standard. +
    • +
+

+ + Asio + 1.29.0 +

+
    +
  • + Changed to require C++11 as the minimum language standard. +
    • +
  • + Removed deprecated functionality from the asio::execution + namespace. +
    • +
  • + Removed deprecated invocation and allocation hooks. +
    • +
  • + Added compatibility between Asio's placeholders and std::bind. +
    • +
  • + Added try_send_via_dispatch + and try_send_n_via_dispatch + functions to channels. +
    • +
  • + Improved C++11 support for multi-signature channels. +
    • +
  • + Fixed compatibility between channel asynchronous operations and any_completion_handler. +
    • +
  • + Added missing equality operators for mixed property types belonging to + the same category. +
    • +
  • + Fixed an issue where spawn-based + stackful coroutines would terminate the program when used with asynchronous + operations that have a completion signature starting with std::exception_ptr. +
    • +
+

+ + Asio + 1.28.2 +

+
    +
  • + Fixed the completion token adapters bind_allocator, + bind_cancellation_slot + and bind_immediate_executor + to not require a return_type + type alias in the adapted async_result + specialisation. +
    • +
  • + Fixed a potental crash due to an object lifetime issue in the co_spawn operation's cancellation support. +
    • +
  • + Enabled compiler-supported thread locals on more target platforms, using + the thread_local keyword if + available. +
    • +
  • + Fixed the documentation of the per-operation cancellation behaviour for + experimental::co_composed to correctly state that terminal + cancellation is enabled by default. +
    • +
  • + Documented the per-operation cancellation behaviour of async_compose. +
    • +
  • + Added bind_immediate_executor + to the Completion Token + Adapters overview. +
    • +
  • + Added an example illustrating how to use an experimental + channel for mutual exclusion + between cooperating asynchronous actors. +
    • +
  • + Added an example showing how to write a minimal completion executor. +
    • +
+

+ + Asio + 1.28.1 +

+
    +
  • + Added missing compatibility with associated_immediate_executor + to any_completion_handler. +
    • +
  • + Fixed a null pointer dereference that occurs when using query, + require or prefer with an empty any_executor. +
    • +
  • + Added a workaround in experimental::coro + for a spurious syntax error when compiling with MSVC. +
    • +
  • + Fixed an integer truncation issue in per-operation cancellation, when using + the reactor backend on 64-bit Windows. +
    • +
  • + Added a compile-time check for a minimum Linux kernel version of 5.10, + when io_uring support is enabled. +
    • +
  • + Fixed a compile error in the converting move constructors for experimental::basic_channel and experimental::basic_concurrent_channel. +
    • +
  • + Fixed a memory leak on some signal_set + error handling code paths. +
    • +
  • + Fixed bad_address_cast + to not use a deprecated implicit copy constructor. +
    • +
  • + Fixed a copy/paste error in the dev_poll_reactor + backend. +
    • +
  • + Fixed the io_uring backend to ensure the internal timeout + operations, used to implement io_context::run_for + and io_context::run_until, are cleaned up correctly. +
    • +
  • + Eliminated some duplicated state in the co_spawn + implementation's entry point, reducing memory consumption. +
    • +
  • + Added c++14 echo examples to boostify script. +
    • +
+

+ + Asio + 1.28.0 +

+
    +
  • + Added missing handler tracking source location support to awaitable<>-based + coroutine's ability to co_await + asynchronous operations packaged as function objects. +
    • +
  • + Add missing handler tracking source location support to co_composed. +
    • +
  • + Fixed suppression of spurious 'potential null dereference' warnings, to + work with older compilers. +
    • +
  • + Fixed a bug where passing the deprecated const_buffers_1 + and mutable_buffers_1 types + to asio::buffer() + would result in the contiguous iterator overloads being incorrectly chosen. +
    • +
  • + Disabled the runtime Windows version test unless targeting older Windows + versions. +
    • +
  • + Fixed compatibility between buffered stream wrappers and move-constructible + streams, such as ssl::stream<>. +
    • +
  • + Marked ip::address_v4::to_ulong as deprecated in the documentation. +
    • +
  • + Fixed shadowed variable warnings. +
    • +
  • + Fixed basic_socket_acceptor::async_accept + concept requirement checking to be compatible with lambdas that have a + deduced return type. +
    • +
  • + Fixed a feature detection macro used in use_future's + compatibility traits. +
    • +
  • + Fixed as_tuple compatibility + with legacy completion tokens. +
    • +
  • + Fixed redirect_error compatibility + with new completion tokens. +
    • +
  • + Fixed a potential, Windows-specific program termination due to exceptions + that should have been allowed to escape from a destructor. +
    • +
  • + Fixed this_coro to prevent + inadvertent co_await of + boolean expressions. +
    • +
  • + Fixed result handling in experimental::use_coro + implementation. +
    • +
  • + Fixed variadic template emulation for is_async_operation + and completion_signature_of. +
    • +
  • + Fixed incorrect reuse of a moved-from result in experimental::promise. +
    • +
  • + Fixed experimental::coro use with custom allocators. +
    • +
  • + Fixed clean up of internal I/O object structures when using io_uring. +
    • +
  • + Use cached offset when seeking a file with seek_cur on Windows. +
    • +
  • + Added immediate completion to asynchronous operation requirements. +
    • +
  • + Added any_completion_handler<>, co_composed, + and immediate completion support to the documentation overview. +
    • +
  • + Added buffer literals to the documentation. +
    • +
  • + Added a link to the Asio + debugger extensions repository. +
    • +
+

+ + Asio + 1.27.0 +

+
    +
  • +

    + Added the ability to customise the execution of a completion handler when + an operation completes immediately. This change adds the associated_immediate_executor associator + trait, bind_immediate_executor + function, and immediate_executor_binder + adapter. When a supported operation completes immediately (that is, within + the initiating function) the associated immmediate executor is obtained, + and the completion handler is delivered through that executor as if by + using asio::dispatch on that executor. By default, + the immediate executor delivers the completion handler as if using asio::post via the operation's I/O executor. + For example, to allow a recursive call to the completion handler of an + async_read_some operation, + we may specify that immediate completion is delivered via a system_executor:
    +

    +
    my_socket.async_read_some(my_buffer,
+    bind_immediate_executor(
+      system_executor(),
+      [](error_code e, size_t n)
+      {
+        // ...
+      }
+    )
+  );
+
    +

    +
    Immediate execution is currently supported for asynchronous operations + on reactor-based sockets and descriptors, and for asynchronous operations + on channels. +

    +
    • +
  • +

    + Added user-defined literals for buffer types. The _buf + literal suffix, defined in namespace asio::buffer_literals, + may be used to create const_buffer objects from string, binary integer, + and hexadecimal integer literals. These buffer literals may be arbitrarily + long. For example:
    +

    +
      using namespace asio::buffer_literals;
+
+  asio::const_buffer b1 = "hello"_buf;
+  asio::const_buffer b2 = 0xdeadbeef_buf;
+  asio::const_buffer b3 = 0x01234567'89abcdef'01234567'89abcdef_buf;
+  asio::const_buffer b4 = 0b1010101011001100_buf;
+
    +

    +
    The memory associated with a buffer literal is valid for the lifetime + of the program. This means that the buffer can be safely used with asynchronous + operations:
    +

    +
    async_write(my_socket, "hello"_buf, my_handler);
+
    +

    +
    +

    +
    • +
  • + Added a new protocol type local::seq_packet_protocol + to represent AF_UNIX with + SOCK_SEQPACKET. +
    • +
  • +

    + Exposed sigaction() + flags via optional argument to signal_set::add. + When registering a signal, it is now possible to pass flags that specify + the behaviour associated with the signal. These flags are specified as + an enum type in a new class, signal_set_base, and are passed to the underlying + sigaction() + call. For example:
    +

    +
    asio::signal_set sigs(my_io_context);
+sigs.add(SIGINT, asio::signal_set::flags::restart);
+
    +

    +
    Specifying flags other than flags::dont_care + will fail unless sigaction() is supported by the target operating + system. Since signal registration is global, conflicting flags (multiple + registrations that pass differing flags other than flags::dont_care) + will also result in an error. +

    +
    • +
  • + Change allocator_binder, + executor_binder, and cancellation_slot_binder to support detection + of unspecialised associators. +
    • +
  • + Fixed ambiguity in associated_cancellation_slot<reference_wrapper>::get(). +
    • +
  • + Fixed awaitable handling + for completion signatures containing std::exception_ptr. +
    • +
  • + Fixed experimental::channel try_send + failure after a cancel. +
    • +
  • + Fixed thread_pool::join() + deadlock when the pool has no internal threads. +
    • +
  • + Fixed pipe release() + when using io_uring. +
    • +
  • + Fixed a data initialisation issue in the io_uring backend. +
    • +
  • + Fixed a dangling reference issue in the execution context overload of + get_associated_executor. +
    • +
  • + Ensured buffered messages can still be received when an experimental::channel + is closed. +
    • +
  • + Fixed the any_completion_handler + assignment operator to work correctly. +
    • +
  • + Constrained the constructor of the move-only class template any_completion_handler to prevent accidental + copying +
    • +
  • + Suppressed spurious 'potential null dereference' warnings. +
    • +
  • + Changed to use uint64_t + for OpenSSL options, to match OpenSSL 3. +
    • +
  • + Fixed deferred interoperability + with multiple completion signatures. +
    • +
  • + Fixed channels to support C++11 and later. Note that for C++11 and C++14, + support is limited to channels with a single completion signature, or channels + with a void() signature (plus the error signature added by the channel + traits). +
    • +
  • + Added any_completion_handler + to the documentation. +
    • +
+

+ + Asio + 1.26.0 +

+
    +
  • + Fixed spawn and co_spawn implementations to dispatch + cancellation handlers on the correct executor. When a completion handler + uses a specified (i.e. non-default) associated executor, cancellation handlers + are dispatched to the executor that was passed to spawn() or co_spawn(). +
    • +
  • + Fixed spawn to ensure the + completion handler is dispatched through the correct executor. +
    • +
  • + Changed to use snprintf + rather than sprintf on + latest Xcode, to address deprecation warnings. +
    • +
  • + Fixed compatibility between co_spawn + and any_completion_handler. +
    • +
  • + Fixed the arguments passed to select_reactor::run + when it is run on an internal thread. +
    • +
  • + Fixed compilation errors when (BOOST_)ASIO_DISABLE_SMALL_BLOCK_RECYCLING is + defined. +
    • +
  • + Updated detection of C++20 coroutine support on clang 14 and later. This + includes the ability to use coroutines with libstdc++. +
    • +
  • + Changed standard library feature detection to always enable std::invoke_result when targeting C++17 or + later. +
    • +
  • + Fixed detection of return type deduction with MSVC. +
    • +
  • + Added a missing include in experimental::coro + implementation. +
    • +
  • + Updated the asynchronous operation requirements to relax the requirements + on the associated executor. +
    • +
  • + Added io_uring to the implementation notes. +
    • +
+

+ + Asio + 1.25.0 +

+
    +
  • +

    + Added the consign completion + token adapter, which can be used to attach additional values to a completion + handler. This is typically used to keep at least one copy of an object, + such as a smart pointer, alive until the completion handler is called. + For example:
    +

    +
    auto timer1 = std::make_shared<asio::steady_timer>(my_io_context);
+timer1->expires_after(std::chrono::seconds(1));
+timer1->async_wait(
+    asio::consign(
+      [](asio::error_code ec)
+      {
+        // ...
+      },
+      timer1
+    )
+  );
+
    +

    +
    +

    +
    • +
  • +

    + Added any_completion_handler<>, which can be used to type-erase + completion handlers. A typical use case is to enable separate compilation + of asynchronous operation implementations. For example:
    +

    +
    // Header file:
+
+void async_sleep_impl(
+    asio::any_completion_handler<void(asio::error_code)> handler,
+    asio::any_io_executor ex, std::chrono::nanoseconds duration);
+
+template <typename CompletionToken>
+inline auto async_sleep(asio::any_io_executor ex,
+    std::chrono::nanoseconds duration, CompletionToken&& token)
+{
+  return asio::async_initiate<
+    CompletionToken, void(asio::error_code)>(
+      async_sleep_impl, token, std::move(ex), duration);
+}
+
+// Separately compiled source file:
+
+void async_sleep_impl(
+    asio::any_completion_handler<void(asio::error_code)> handler,
+    asio::any_io_executor ex, std::chrono::nanoseconds duration)
+{
+  auto timer = std::make_shared<asio::steady_timer>(ex, duration);
+  timer->async_wait(asio::consign(std::move(handler), timer));
+}
+
    +

    +
    +

    +
    • +
  • +

    + Added experimental::co_composed which facilitates a lightweight + implementation of user-defined asynchronous operations using C++20 coroutines. + The following example illustrates a simple asynchronous operation that + implements an echo protocol in terms of a coroutine:
    +

    +
    template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    CompletionToken&& token)
+{
+  return asio::async_initiate<
+    CompletionToken, void(asio::error_code)>(
+      asio::experimental::co_composed<
+        void(asio::error_code)>(
+          [](auto state, tcp::socket& socket) -> void
+          {
+            try
+            {
+              state.throw_if_cancelled(true);
+              state.reset_cancellation_state(
+                asio::enable_terminal_cancellation());
+
+              for (;;)
+              {
+                char data[1024];
+                std::size_t n = co_await socket.async_read_some(
+                    asio::buffer(data), asio::deferred);
+
+                co_await asio::async_write(socket,
+                    asio::buffer(data, n), asio::deferred);
+              }
+            }
+            catch (const asio::system_error& e)
+            {
+              co_return {e.code()};
+            }
+          }, socket),
+      token, std::ref(socket));
+}
+
    +

    +
    +

    +
    • +
  • +

    + Add range-based experimental::make_parallel_group() overloads that may + be used to launch a dynamically-sized set of asynchronous operations, where + all operations are the same type. For example:
    +

    +
    using op_type = decltype(
+    socket1.async_read_some(
+      asio::buffer(data1),
+      asio::deferred
+    )
+  );
+
+std::vector<op_type> ops;
+ops.push_back(
+    socket1.async_read_some(
+      asio::buffer(data1),
+      asio::deferred
+    )
+  );
+ops.push_back(
+    socket2.async_read_some(
+      asio::buffer(data2),
+      asio::deferred
+    )
+  );
+
+asio::experimental::make_parallel_group(ops).async_wait(
+    asio::experimental::wait_for_all(),
+    [](
+        std::vector<std::size_t> completion_order,
+        std::vector<asio::error_code> e,
+        std::vector<std::size_t> n
+      )
+    {
+      for (std::size_t i = 0; i < completion_order.size(); ++i)
+      {
+        std::size_t idx = completion_order[i];
+        std::cout << "socket " << idx << " finished: ";
+        std::cout << e[idx] << ", " << n[idx] << "\n";
+      }
+    }
+  );
+
    +

    +
    Thanks go to Klemens Morgenstern for supplying part of this implementation. +

    +
    • +
  • + Added any_completion_executor, + a type-erased wrappers for executors that are associated with completion + handlers. +
    • +
  • + Added missing context query + to use_future's executor. +
    • +
  • + Added nothrow constructor overloads to execution::any_executor<> and any_io_executor. +
    • +
  • + Optimised representation of empty execution::any_executor + objects to improve the performance of copy and move operations. +
    • +
  • + Added an associated_cancellation_slot + specialisation for std::reference_wrapper. +
    • +
  • + Changed I/O objects to return their executors by const reference. +
    • +
  • + Changed associated to use deduced return types for all two-argument get functions. +
    • +
  • + Fixed spawn implementation + to catch unhandled exceptions and rethrow them outside of the spawned "thread". +
    • +
  • + Fixed cleanup of of terminal-state spawn + "thread" objects. +
    • +
  • + Changed semantics of dispatch + to mean the executor is used as-is. An execution context's default executor + is imbued with the possibly-blocking property. +
    • +
  • + Deprecated the execution::execute + customisation point. Use execute + as a member function. +
    • +
  • + Deprecated the concepts, traits, functions and customisation points related + to senders and receivers. +
    • +
  • + Added a C++11 parallel_group + example. +
    • +
  • + Fixed example code to not use the deprecated conversion of a resolve result + to an endpoint. +
    • +
  • + Fixed an ambiguity in experimental::channel_traits + specialisations. +
    • +
  • + Added a specialised channel implementation for the for R(error_code) signature. +
    • +
  • + Made cancelled() + public on the async_compose + 'self' object. +
    • +
  • + Added io_executor_type and get_io_executor to the async_compose + 'self' object. +
    • +
  • + Fixed implementation of release() for Windows overlapped handles. +
    • +
  • + Enabled deferred awaiting for experimental::coro, + regularised experimental::use_coro, + and fixed allocator handling. This means that use_coro + does not return a coro object, just like use_awaitable does, i.e. it's + an overhead that buys us type erasure. Allocators can now be set for coro by including allocator_arg + in the coro signature. +
    • +
  • + Cleaned up experimental::promise + and made it an asynchronous operation object. +
    • +
  • + Constrained post/defer overloads on ability to require + blocking.never. +
    • +
  • + Changed descriptor implementation to fall back to fcntl + if ioctl fails with ENOTTY when setting non-blocking mode. +
    • +
+

+ + Asio + 1.24.0 +

+
    +
  • + Improved the performance of awaitable<>-based coroutines when they directly + co_await an asynchronous + operation, by eliminating the copy of the operation object in await_transform. +
    • +
  • + Improved the performance of spawn()-based stackful coroutines by storing + a reference to the yield context in the completion handler, rather than + storing a copy of the executor. +
    • +
  • + Fixed a C++03 build error by disabling index_sequence + emulation when variadic templates are unavailable. +
    • +
  • + Fixed detection of std::aligned_alloc + for older Apple platforms. +
    • +
  • + Removed faulty assertions from experimental::coro + implementation. +
    • +
  • + Added defence against Qt-defined macros when building with Intel C++. +
    • +
  • + Ensured that a spawn()-based + stackful coroutine is cleaned up immediately after it completes. +
    • +
  • + Changed the implementation of the select_reactor, + on Windows, to ensure that any exception resulting from failure to recreate + its interrupter's sockets will be allowed to propagate out through io_context::run(). +
    • +
  • + Changed the MSVC version used for the system_error + workaround, as more recent runtime redistributables appear to have fixed + the issue. +
    • +
  • + Changed the async_compose + example to use a return type compatible with the new async_result + form. +
    • +
+

+ + Asio + 1.23.0 +

+
    +
  • + Added a deduced trailing return type, using decltype, + to all asynchronous operations' initiating functions when using C++11. + This change enables the new form of async_result, + where the return type can vary per operation, for C++11. +
    • +
  • + Moved append, prepend, as_tuple, + and deferred to the asio namespace, and made them compatible + with C++11. These are no longer experimental facilities, although the names + have temporarily been retained under the asio::experimental + namespace for backwards compatibility. +
    • +
  • + Added buffer() + overloads for contiguous containers, such as std::span. +
    • +
  • +

    + Added the ability for awaitable<>-based coroutines to directly co_await operations that are packaged + as function objects. For example, using deferred:
    +

    +
    asio::awaitable<void> my_coro()
+{
+  asio::steady_timer timer(co_await asio::this_coro::executor);
+  timer.expires_after(std::chrono::seconds(5));
+
+  co_await timer.async_wait(asio::deferred);
+}
+
    +

    + or with a handcrafted function object:
    +

    +
    asio::awaitable<void> my_coro()
+{
+  asio::steady_timer timer(co_await asio::this_coro::executor);
+  timer.expires_after(std::chrono::seconds(5));
+
+  co_await [&](auto&& token)
+  {
+    return timer.async_wait(std::forward<decltype(token)>(token));
+  };
+}
+
    +

    +
    +

    +
    • +
  • +

    + Changed spawn() + to be a completion token-based asynchronous operation. This introduces + new spawn() + overloads that conform to the requirements for asynchronous operations. + For example:
    +

    +
    std::string do_read(asio::yield_context yield)
+{
+  char data[1024];
+  size_t n = my_socket.async_read_some(asio::buffer(data), yield);
+  return std::string(data, n);
+}
+
+asio::spawn(my_executor, do_read,
+    [](std::exception_ptr ex, std::string result)
+    {
+      // ...
+    });
+
    +

    + These new spawn() + overloads support cancellation, and the basic_yield_context + completion token has also been enhanced to support move-only and variadic + result types. When targeting C++11 and later, these functions are implemented + in terms of Boost.Context directly. The existing overloads have been retained + but are deprecated. +

    +
    • +
  • +

    + Added the is_async_operation + trait and async_operation + concept. The is_async_operation + trait may be used to determine if a function object, and optional arguments, + may be called to initiate an asynchronous operation. For example, when + using deferred:
    +

    +
    auto d = my_timer.async_wait(asio::deferred);
+static_assert(asio::is_async_operation<decltype(d)>::value);
+
    +

    +
    or with a handcrafted asynchronous operation:
    +

    +
    struct my_async_op
+{
+  asio::ip::tcp::socket& socket_ = ...;
+
+  template <typename Token>
+  auto operator()(asio::const_buffer data, Token&& token)
+  {
+    return asio::async_write(socket_, data,
+        std::forward<Token>(token));
+  }
+};
+
+static_assert(
+    asio::is_async_operation<
+      my_async_op, asio::const_buffer>::value);
+
    +

    +
    +

    +
    • +
  • +

    + Added the completion_signature_of + trait. The completion_signature_of + trait (and corresponding type alias completion_signature_of_t) + may be used to determine the completion signature of an asynchronous operation. + For example:
    +

    +
    auto d = my_timer.async_wait(asio::deferred);
+using sig = asio::completion_signature_of<decltype(d)>::type;
+// sig is void(error_code)
+
    +

    +
    or with a handcrafted asynchronous operation:
    +

    +
    struct my_async_op
+{
+  asio::ip::tcp::socket& socket_ = ...;
+
+  template <typename Token>
+  auto operator()(asio::const_buffer data, Token&& token)
+  {
+    return asio::async_write(socket_, data,
+        std::forward<Token>(token));
+  }
+};
+
+using sig =
+  asio::completion_signature_of<
+    my_async_op, asio::const_buffer>::type;
+// sig is void(error_code, size_t)
+
    +

    +
    +

    +
    • +
  • + Added converting move construction/assignment to posix descriptors, serial + ports, pipes, Windows object_handle, + Windows stream handles, and Windows random-access handles. +
    • +
  • + Added release() + member functions to pipes, Windows stream handles, and Windows random-access + handles. +
    • +
  • + Enabled support for Endpoint + implementations that return void + pointers from their data() member functions, as per the documented + Endpoint type requirements. +
    • +
  • + Removed all() + and race() + from experimental::promise, as experimental::parallel_group + covers this functionality. +
    • +
  • + Added source locations to exceptions and error codes produced by the synchronous + and asynchronous operations. +
    • +
  • + Fixed compatibility with OpenSSL 3.0.4 and later. +
    • +
  • + Fixed compatibility with with -masm=intel. +
    • +
  • + Explicitly stated that socket shutdown() calls are thread-safe with respect to + certain other synchronous operations on the same socket. +
    • +
  • + Optimised the move construction of I/O objects where only the executor + type differs. +
    • +
  • + Fixed the detection of std::invoke_result + for clang/libc++. +
    • +
  • + Fixed an issue where experimental::parallel_group + initiation incorrectly moved arguments instead of forwarding them. +
    • +
  • + Fixed a sequencing issue in the implementation of post(), dispatch(), and defer(), where the the associated allocator may + be obtained from an already moved-from completion handler. +
    • +
  • + Fixed the awaitable<> + implementation to propagate exceptions from awaited initiation functions + through the current completion handler. +
    • +
  • + Fixed detection of std::aligned_alloc + with gcc. +
    • +
  • + Changed to avoid using the soon-to-be-deprecated std::aligned_storage + on newer compilers. +
    • +
  • + Fixed various compiler warnings. +
    • +
  • + Updated all composed operations examples, and the C++11 timeouts example, + to use the new async_result + form. +
    • +
  • + Added composed operation and coroutine examples for C++20. +
    • +
  • + Added pkg-config support. +
    • +
+

+ + Asio + 1.22.2 +

+
    +
  • + On Windows, changed the file support to open files using the same sharing + mode as fopen(). +
    • +
  • + On Linux, fixed the UNIX domain sockets implementation to correctly handle + EAGAIN as an indication + of an in-progress connect operation. +
    • +
  • + Fixed experimental::basic_channel::reset() + and experimental::basic_concurrent_channel::reset() + so that they work correctly for an unclosed channel. +
    • +
  • + Fixed potential undefined behaviour in the experimental::promise + operations race() + and all(). +
    • +
  • + Changed the co_spawn implementation + to explicitly dispatch cancellation signals through the specified executor, + if the the completion handler has an associated executor of its own. +
    • +
  • + Added more detailed reference documentation to make_strand(), make_work_guard(), ip::address_v4, + ip::address_v6, experimental::basic_channel, + and experimental::basic_concurrent_channel. +
    • +
  • + Re-arranged and extended the Overview documentation to cover files, pipes, + async_compose, experimental::deferred, experimental::parallel_group, + experimental::promise, channels, and completion token + adapters. +
    • +
  • + Reverted the io_context + reference documentation to use executor_work_guard + when preventing the io_context + from running out of work. +
    • +
  • + Removed references to deadline_timer + from the Overview documentation. +
    • +
  • + Added reference documentation cross-references to asynchronous model elements. +
    • +
+

+ + Asio + 1.22.1 +

+
    +
  • + Added bind_allocator, to + simplify associating a custom allocator with a completion token or handler. +
    • +
  • + Added the file_base::sync_all_on_write flag, which maps to + O_SYNC on POSIX and FILE_FLAG_WRITE_THROUGH on Windows. +
    • +
  • + Added missing implementation of basic_file::release(). +
    • +
  • + Added per-operation cancellation support to signal sets. +
    • +
  • + Exposed recycling_allocator + as part of the public interface. +
    • +
  • + Added the nodiscard attribute + to the following functions: +
      +
    • + bind_allocator() +
      • +
    • + bind_cancellation_slot() +
      • +
    • + bind_executor() +
      • +
    • + buffer() +
      • +
    • + dynamic_buffer() +
      • +
    • + experimental::append() +
      • +
    • + experimental::as_single() +
      • +
    • + experimental::as_tuple() +
      • +
    • + experimental::make_parallel_group() +
      • +
    • + experimental::prepend() +
      • +
    • + get_associated_allocator() +
      • +
    • + get_associated_cancellation_slot() +
      • +
    • + get_associated_executor() +
      • +
    • + make_work_guard() +
      • +
    +
    • +
  • + Added compatibility with OpenSSL 3.0, particularly when deprecated functionality + is disabled. +
    • +
  • + Added support for adopting an existing SSL* into an ssl::stream<>. +
    • +
  • + Enabled executor_work_guard<> even when ASIO_NO_TS_EXECUTORS + is defined. +
    • +
  • + Enabled movable socket iostreams when using clang. +
    • +
  • + Fixed bind_cancellation_slot + compatibility with legacy completion tokens. +
    • +
  • + Fixed bind_executor compatibility + with legacy completion tokens. +
    • +
  • + Fixed associator specialisations + for experimental::append and experimental::prepend, + to correctly propagate the associated allocator, executor, and cancellation + slot. +
    • +
  • + Fixed 'zero as null pointer constant' warning in C++20 coroutines implementation + of awaitable. +
    • +
  • + Ensured concurrency hint preprocessor macros are made available when asio/io_context.hpp + is included. +
    • +
  • + Fixed issue where the primary associated_allocator + template was not correctly detecting the nested T::allocator_type. +
    • +
  • + Fixed io_uring implementation of async_receive_from + operation for sockets. +
    • +
  • + Fixed io_uring implementation of write_some_at + operation for files. +
    • +
  • + Changed io_uring implementation to correctly check that + it is not the default before registering with reactor. +
    • +
  • + Fixed a circular inclusion issue when using io_uring + in some build configurations. +
    • +
  • + Fixed experimental::coro's per-operation cancellation to + clear the slot at completion of each operation. +
    • +
  • + Fixed memory management in experimental::promise's + type-erased completion handlers. +
    • +
  • + Fixed move operator= + implementation for ssl::stream. +
    • +
  • + Fixed any_io_executor implementation + to work when both ASIO_USE_TS_EXECUTOR_AS_DEFAULT + and ASIO_SEPARATE_COMPILATION + are defined. +
    • +
  • + Fixed implementation of basic_socket::at_mark() when using the sockatmark() system call. +
    • +
  • + Changed the recycling allocator to use the default alignment as the minimum + alignment for allocations. +
    • +
  • + Added additional standard header file includes, as required by newer compilers. +
    • +
  • + Added a workaround for apparent coroutine codegen bug with Apple's clang. +
    • +
  • + Fixed various warnings in the examples and unit tests. +
    • +
  • + Added a C++11 example showing file descriptor passing over local sockets. + Thanks to Heiko Hund for providing this example. +
    • +
  • + Added C++14 examples of wrapping callback-based APIs in asynchronous operations. +
    • +
  • + Added an overview of Asio's asynchronous model to the documentation. +
    • +
  • + Reworked reference documentation in terms of completion tokens. +
    • +
  • + Updated documentation of asynchronous operation requirements to use new + completion token form. +
    • +
  • + Updated documentation for dispatch(), post(), and defer() to cover both the old and new executor + forms. +
    • +
  • + Documented per-operation cancellation for serial ports. +
    • +
  • + Clarified the non-concurrency guarantees made for allocators. +
    • +
+

+ + Asio + 1.22.0 +

+
    +
  • + Improved error messages emitted by ssl + facilities. +
    • +
  • + Fixed bind_executor compatibility + with completion tokens. +
    • +
  • + Fixed build errors when ASIO_USE_TS_EXECUTOR_AS_DEFAULT + is defined. +
    • +
  • + Fixed corruption, cleanup issues in channel implementation. +
    • +
  • + Added missing move assignment operator to awaitable<>. +
    • +
  • + Fixed an access violation when using coroutines with MSVC, due to incorrect + alignment of allocated memory. +
    • +
  • + Fixed a cleanup issue in experimental::parallel_group + that occured when the execution context was shut down with parallel operations + still pending. +
    • +
  • + Fixed header inclusion order problem when io_uring is enabled. +
    • +
  • + Eliminated shared_ptr use + from experimental::coro co_spawn() implementation. +
    • +
  • + Prevented async_resume + from being called on experimental::coro + temporaries. +
    • +
  • + Made awaitable_operators.hpp + header self-contained. +
    • +
  • + Added clarifications to the documentation on concurrency hints. +
    • +
  • + Added documentation on error handling techniques for C++20 coroutines. +
    • +
  • + Added channel-based proxy example. +
    • +
  • + Regenerated ssl certificates + used in examples. +
    • +
+

+ + Asio + 1.21.0 +

+
    +
  • + Added an io_uring backend. This backend may be used for all I/O objects, + including sockets, timers, and posix descriptors.

    The backend + is disabled by default, and must be enabled by defining both ASIO_HAS_IO_URING and ASIO_DISABLE_EPOLL.
    +
    Simply defining ASIO_HAS_IO_URING + alone will enable the backend without using it for the existing I/O objects. + This allows it to be used for I/O objects that require io_uring support, + such as files.

    This support depends on the liburing + library at both compile and link time. Add -luring to your list of libraries for + linking. +
    • +
  • +

    + Added support for files. This introduces new classes for stream-oriented + and random-access files. For example, to write to a newly created stream-oriented + file:
    +

    +
    asio::stream_file file(
+    my_io_context, "/path/to/file",
+    asio::stream_file::write_only
+      | asio::stream_file::create
+      | asio::stream_file::truncate);
+
+file.async_write_some(my_buffer,
+    [](error_code e, size_t n)
+    {
+      // ...
+    });
+
    +

    +
    or to read from a random-access file:
    +

    +
    asio::random_access_file file(
+    my_io_context, "/path/to/file",
+    asio::random_access_file::read_only);
+
+file.async_read_some_at(1234, my_buffer,
+    [](error_code e, size_t n)
+    {
+      // ...
+    });
+
    +

    +
    This feature currently supports I/O completion ports on Windows, + and io_uring on Linux (define ASIO_HAS_IO_URING + to enable). +

    +
    • +
  • +

    + Added support for portable pipes. This change add supports for pipes on + POSIX and Windows (when I/O completion ports are available). For example, + to create and use a connected pair of pipe objects:
    +

    +
    asio::readable_pipe read_end;
+asio::writable_pipe write_end;
+asio::connect_pipe(read_end, write_end);
+
+write_end.async_write_some(my_write_buffer,
+    [](error_code e, size_t n)
+    {
+      // ...
+    });
+
+read_end.async_read_some(my_read_buffer,
+    [](error_code e, size_t n)
+    {
+      // ...
+    });
+
    +

    +
    +

    +
    • +
  • +

    + Added support for registered buffers. The mutable_registered_buffer + and const_registered_buffer + classes are buffer sequence types that represent registered buffers. These + buffers are obtained by first performing a buffer registration:
    +

    +
    auto my_registration =
+  asio::register_buffers(
+      my_execution_context,
+      my_buffer_sequence);
+
    +

    +
    The registration object must be maintained for as long as the buffer + registration is required. The supplied buffer sequence represents the memory + location or locations that will be registered, and the caller must ensure + they remain valid for as long as they are registered. The registration + is automatically removed when the registration object is destroyed. There + can be at most one active registration per execution context.

    + The registration object is a container of registered buffers. Buffers may + be obtained from it by iterating over the container, or via direct index + access:
    +

    +
    asio::mutable_registered_buffer my_buffer
+  = my_registration[i];
+
    +

    +
    The registered buffers may then be passed directly to operations:
    +

    +
    asio::async_read(my_socket, my_buffer,
+    [](error_code ec, size_t n)
+    {
+      // ...
+    });
+
    +

    +
    Buffer registration supports the io_uring backend when used with + read and write operations on descriptors, files, pipes, and sockets. For + portability, the facility may be used on other platforms, but the registered + buffers will behave as normal buffers. +

    +
    • +
  • +

    + Added experimental support for channels. This adds templates experimental::basic_channel and experimental::basic_concurrent_channel, + with aliases experimental::channel + and experimental::concurrent_channel. Channels may be used + to send completions as messages. For example:
    +

    +
    // Create a channel with no buffer space.
+channel<void(error_code, size_t)> ch(ctx);
+
+// The call to try_send fails as there is no buffer
+// space and no waiting receive operations.
+bool ok = ch.try_send(asio::error::eof, 123);
+assert(!ok);
+
+// The async_send operation is outstanding until
+// a receive operation consumes the message.
+ch.async_send(asio::error::eof, 123,
+    [](error_code ec)
+    {
+      // ...
+    });
+
+// The async_receive consumes the message. Both the
+// async_send and async_receive operations complete
+// immediately.
+ch.async_receive(
+    [](error_code ec, size_t n)
+    {
+      // ...
+    });
+
    +

    +
    +

    +
    • +
  • + Implemented improvements to experimental::coro. +
      +
    • + Added overload so member functions can provide an explicit executor. +
      • +
    • + Added co_spawn for + coro tasks. +
      • +
    • + Added reference and overview documentation. +
      • +
    • + Adopted awaitable cancellation model. +
      • +
    • + Refactored implementation. +
      • +
    +
    • +
  • + Disabled aligned_alloc + on clang when using an MSVC runtime. +
    • +
  • + Changed to use a faster implementation for ip::network_v4::canonical(). +
    • +
  • + Added template specialisations for common uses to improve compile time. +
    • +
  • + Reduced the size of io_context + executors to a single pointer. +
    • +
  • + Increased the small object buffer size for execution::any_executor + and any_io_executor. +
    • +
  • + Fixed multi-signature handling when variadic templates are disabled. +
    • +
  • + Fixed compatibility with new versions of gcc and clang. +
    • +
  • + Fixed compilation on Solaris. +
    • +
  • + Fix defence against Qt-defined macros when building with MSVC. +
    • +
  • + Fixed various warnings. +
    • +
+

+ + Asio + 1.20.0 +

+
    +
  • + Fixed experimental::coro compatibility with gcc. +
    • +
  • + Fixed experimental::promise compatibility with gcc. +
    • +
  • + Added documentation for per-operation cancellation. +
    • +
  • + Added documentation for parallel_group. +
    • +
  • + Added overview documentation for experimental::coro. +
    • +
  • + Added some missing C++14 examples. +
    • +
  • + Updated C++20 coroutines overview documentation. +
    • +
+

+ + Asio + 1.19.2 +

+
    +
  • + Cleaned up memory recycling to ensure the cache size is used consistently. +
    • +
  • + Changed parallel_group + to use the recycling allocator for shared state. +
    • +
  • + Changed awaitable memory + recycling to use the configurable cache size. +
    • +
  • + Ensured parallel_group + respects operations' associated executors. +
    • +
  • + Added defence against macros defined by Qt. +
    • +
  • + Added missing boost_ prefix + to namespaces during boostification. +
    • +
  • + Added missing lvalue-qualified overloads for deferred + operator(). +
    • +
  • + Added a tag to disambiguate deferred + constructors. +
    • +
  • + Added missing push/pop_options includes. +
    • +
  • + Fixed argument evaluation order issue with a potentially moved-from variable + in awaitable implementation. +
    • +
  • + Enabled "expression SFINAE" for recent MSVC using /std:c++latest. +
    • +
  • + Fixed compilation errors when dev_poll_reactor + backend is used. +
    • +
  • + Fixed handler type requirements checking to reflect rvalue completion handler + invocation. +
    • +
  • + Fixed posix::basic_stream_descriptor move operations + to work with non-defaulted executors. +
    • +
  • + Added missing move of executor in strand implementation. +
    • +
+

+ + Asio + 1.19.1 +

+
    +
  • + Fixed handling of move-only results with awaitable operators && and ||. +
    • +
  • + Fixed strand<> + to avoid using a potentially moved-from executor. +
    • +
  • + Fixed order of _aligned_malloc + arguments for MSVC. +
    • +
  • + Ensured handler alignment requirements are respected by cancellation_signal. +
    • +
  • + Ensured gcc tests are not used for clang + when detecting compiler features. +
    • +
  • + Disabled coroutines support for the clang shipped with + MSVC. +
    • +
  • + Fixed compatibility with recent LibreSSL when OPENSSL_NO_SSL_INTERN + is defined. +
    • +
  • + Documented supported cancellation types for individual asynchronous operations. +
    • +
  • + Ensured un-cancelled ops are correctly placed back in the queue. +
    • +
+

+ + Asio + 1.19.0 +

+
    +
  • + Added support for cancellation of individual asynchronous operations. Cancellation + is implemented by having each completion handler carry an associated CancellationSlot, a lightweight cancellation + channel that is specified through the new associated_cancellation_slot + associator. A concrete CancellationSlot + implementation is provided in the form of the cancellation_signal + and cancellation_slot classes. + In conjunction with the bind_cancellation_slot + helper function, these may be used to hook cancellation into asynchronous + operations. However, it should be noted that these classes are the low-level + building blocks of cancellation, and most use cases should use a higher + level abstraction for cancellation, such as experimental::parallel_group + or the new logical operators for awaitable + (see below). The ability to cancel individual operations, or composed operations, + is currently supported by: +
      +
    • + timers +
      • +
    • + sockets on POSIX and Windows +
      • +
    • + POSIX descriptors +
      • +
    • + Windows HANDLEs +
      • +
    • + SSL streams +
      • +
    • + all Asio-provided composed operations such as async_read + and async_write +
      • +
    • + compositions based on async_compose +
      • +
    • + C++20 coroutines that use awaitable +
      • +
    • + C++20 coroutines that use the new experimental::coro + (see below) +
      • +
    • + the new experimental::parallel_group + operation (see below) +
      • +
    • + the new experimental::promise + class (see below) +
      • +
    +
    • +
  • +

    + Added the associator trait. + The associator trait is + used to generically forward associators, such as associated_executor + and associated_allocator, + through intermediate completion handlers. For example:
    +

    +
    template <typename Handler>
+struct intermediate_handler
+{
+  Handler handler_;
+
+  template <typename... Args>
+  void operator()(Args&... args)
+  {
+    // ...
+  }
+};
+
+namespace asio {
+  template <
+      template <typename, typename> class Associator,
+      typename Handler,
+      typename DefaultCandidate>
+  struct associator<
+      Associator,
+      intermediate_handler<Handler>,
+      DefaultCandidate>
+  {
+    using type =
+      typename Associator<Handler, DefaultCandidate>::type;
+
+    static type get(
+        const intermediate_handler<Handler>& h,
+        const DefaultCandidate& c = DefaultCandidate()) noexcept
+    {
+      return Associator<Handler, DefaultCandidate>::get(
+          h.handler_, c);
+    }
+  };
+} // namespace asio
+
    +

    +
    +

    +
    • +
  • + Changed all asynchronous operations implemented in Asio to invoke their + completion handlers as rvalue references. This allows an rvalue reference + qualifier to be added to the function call operator. +
    • +
  • +

    + Added support for asynchronous operations with multiple completion signatures. + Completion signatures may also specify that they are noexcept, + and whether they are lvalue-invocable (and thus do not "consume" + the completion handler) or rvalue-invocable (and thus do "consume" + the handler, indicating an end to the asynchronous operation). For example:
    +

    +
    auto my_async_operation(...,
+    asio::completion_token_for<
+      void(intermediate_result_type) & noexcept,
+      void(final_result_type) &&
+    > auto&& token)
+{
+  // ...
+}
+
    +

    +
    +

    +
    • +
  • +

    + Added operator&& + and operator|| + for awaitable<>. + The logical operators || and + && have been overloaded + for awaitable<>, + to allow coroutines to be trivially awaited in parallel.

    When + awaited using &&, + the co_await expression + waits until both operations have completed successfully. As a "short-circuit" + evaluation, if one operation fails with an exception, the other is immediately + cancelled. For example:
    +

    +
    std::tuple<std::size_t, std::size_t> results =
+  co_await (
+    async_read(socket, input_buffer, use_awaitable)
+      && async_write(socket, output_buffer, use_awaitable)
+  );
+
    +

    +
    When awaited using ||, + the co_await expression + waits until either operation succeeds. As a "short-circuit" evaluation, + if one operation succeeds without throwing an exception, the other is immediately + cancelled. For example:
    +

    +
    std::variant<std::size_t, std::monostate> results =
+  co_await (
+    async_read(socket, input_buffer, use_awaitable)
+      || timer.async_wait(use_awaitable)
+  );
+
    +

    +
    The operators may be enabled by adding the #include:
    +

    +
    #include <asio/experimental/awaitable_operators.hpp>
+
    +

    +
    and then bringing the contents of the experimental::awaitable_operators + namespace into scope:
    +

    +
    using namespace asio::experimental::awaitable_operators;
+
    +

    +
    +

    +
    • +
  • +

    + Added the experimental::as_tuple + completion token adapter. The as_tuple + completion token adapter can be used to specify that the completion handler + arguments should be combined into a single tuple argument. The as_tuple adapter may be used in conjunction + with use_awaitable and + structured bindings as follows:
    +

    +
    auto [e, n] = co_await socket.async_read_some(
+    asio::buffer(data), as_tuple(use_awaitable));
+
    +

    +
    Alternatively, it may be used as a default completion token like + so:
    +

    +
    using default_token = as_tuple_t<use_awaitable_t<>>;
+using tcp_socket = default_token::as_default_on_t<tcp::socket>;
+// ...
+awaitable<void> do_read(tcp_socket socket)
+{
+  // ...
+  auto [e, n] = co_await socket.async_read_some(asio::buffer(data));
+  // ...
+}
+
    +

    +
    +

    +
    • +
  • +

    + Added the experimental::append + completion token adapter. The append + completion token adapter can be used to pass additional completion handler + arguments at the end of the completion signature. For example:
    +

    +
    timer.async_wait(
+    asio::experimental::append(
+      [](std::error_code ec, int i)
+      {
+        // ...
+      },
+    42)
+  );
+
+std::future<int> f = timer.async_wait(
+    asio::experimental::append(
+      asio::use_future,
+      42
+    )
+  );
+
    +

    +
    +

    +
    • +
  • +

    + Added the experimental::prepend + completion token adapter. The prepend + completion token adapter can be used to pass additional arguments before + the existing completion handler arguments. For example:
    +

    +
    timer.async_wait(
+    asio::experimental::prepend(
+      [](int i, std::error_code ec)
+      {
+        // ...
+      },
+    42)
+  );
+
+std::future<std::tuple<int, std::error_code>> f = timer.async_wait(
+    asio::experimental::prepend(
+      asio::use_future,
+      42
+    )
+  );
+
    +

    +
    +

    +
    • +
  • +

    + Added the experimental::deferred + completion token. The deferred + completion token takes a call to an asynchronous operation's initiating + function and turns it into a function object that accepts a completion + token. For example:
    +

    +
    auto deferred_op =
+  timer.async_wait(
+    asio::experimental::deferred);
+...
+std::move(deferred_op)(
+    [](std::error_code ec){ ... });
+
    +

    +
    or:
    +

    +
    auto deferred_op =
+  timer.async_wait(
+    asio::experimental::deferred);
+...
+std::future<void> =
+  std::move(deferred_op)(
+    asio::use_future);
+
    +

    +
    The deferred token also supports chaining, to create simple compositions:
    +

    +
    auto deferred_op =
+  timer.async_wait(
+    asio::experimental::deferred(
+      [&](std::error_code ec)
+      {
+        timer.expires_after(
+            std::chrono::seconds(1));
+
+        return timer.async_wait(
+            asio::experimental::deferred);
+      });
+...
+std::future<void> = std::move(deferred_op)(asio::use_future);
+
    +

    +
    +

    +
    • +
  • +

    + Added the experimental::parallel_group + class and experimental::make_parallel_group + function. This utility may be used to launch work that is performed in + parallel, and wait for one or all of the operations to complete. A parallel_group implements automatic cancellation + of incomplete operations. For example:
    +

    +
    experimental::make_parallel_group(
+    [&](auto token)
+    {
+      return stream.async_read_some(asio::buffer(data), token);
+    },
+    [&](auto token)
+    {
+      return timer.async_wait(token);
+    }
+  ).async_wait(
+    experimental::wait_for_one(),
+    [](
+        std::array<std::size_t, 2> completion_order,
+        std::error_code ec1, std::size_t n1,
+        std::error_code ec2
+    )
+    {
+      // ...
+    }
+  );
+
    +

    +
    The conditions for completion of the group may be specified using + one of the four provided function objects wait_for_all, + wait_for_one, wait_for_one_success, and wait_for_one_error, or with a custom + function. The parallel_group + class can also be combined with deferred + as follows:
    +

    +
    experimental::make_parallel_group(
+    stream.async_read_some(asio::buffer(data), experimental::deferred),
+    timer.async_wait(experimental::deferred)
+  ).async_wait(
+    // ...
+  );
+
    +

    +
    Note: for maximum flexibility, parallel_group + does not propagate the executor automatically to the operations within + the group. +

    +
    • +
  • +

    + Added experimental::promise. The promise + type allows eager execution and synchronisation of async operations. For + example:
    +

    +
    auto promise = async_read(
+    stream, asio::buffer(my_buffer),
+    asio::experimental::use_promise);
+
+... do other stuff while the read is going on ...
+
+promise.async_wait( // completion the operation
+    [](error_code ec, std::size_t bytes_read)
+    {
+      ...
+    });
+
    +

    +
    Promises can be safely disregarded if the result is no longer required. + Different operations can be combined to either wait for all to complete + or for one to complete (and cancel the rest). For example, to wait for + one to complete:
    +

    +
    auto timeout_promise =
+  timer.async_wait(
+    asio::experimental::use_promise);
+
+auto read_promise = async_read(
+    stream, asio::buffer(my_buffer),
+    asio::experimental::use_promise);
+
+auto promise =
+  asio::experimental::promise<>::race(
+    timeout_promise, read_promise);
+
+promise.async_wait(
+    [](std::variant<error_code, std::tuple<error_code, std::size_t>> v)
+    {
+      if (v.index() == 0) {} //timed out
+      else if (v.index() == 1) // completed in time
+    });
+
    +

    +
    or to wait for all to complete:
    +

    +
    auto write_promise = async_write(
+    stream, asio::buffer(my_write_buffer),
+    asio::experimental::use_promise);
+
+auto read_promise = async_read(
+    stream, asio::buffer(my_buffer),
+    asio::experimental::use_promise);
+
+auto promise =
+  asio::experimental::promise<>::all(
+    write_promise, read_promise);
+
+promise.async_wait(
+    [](std::tuple<error_code, std::size_t> write_result,
+      std::tuple<error_code, std::size_t> read_result)
+    {
+    });
+
    +

    +
    Thanks go to Klemens Morgenstern for contributing this feature. +

    +
    • +
  • +

    + Added the experimental::coro + class template. The coro + type is a C++20 coroutine primitive for resumable functions, with the ability + to combine both asynchronous waiting (co_await) + and yielding (co_yield) + into a single, stateful control flow. For example:
    +

    +
    #include <asio.hpp>
+#include <asio/experimental/coro.hpp>
+
+using asio::ip::tcp;
+
+asio::experimental::coro<std::string> reader(tcp::socket& sock)
+{
+  std::string buf;
+  while (sock.is_open())
+  {
+    std::size_t n = co_await asio::async_read_until(
+        sock, asio::dynamic_buffer(buf), '\n',
+        asio::experimental::use_coro);
+    co_yield buf.substr(0, n);
+    buf.erase(0, n);
+  }
+}
+
+asio::awaitable<void> consumer(tcp::socket sock)
+{
+  auto r = reader(sock);
+  auto msg1 = co_await r.async_resume(asio::use_awaitable);
+  std::cout << "Message 1: " << msg1.value_or("\n");
+  auto msg2 = co_await r.async_resume(asio::use_awaitable);
+  std::cout << "Message 2: " << msg2.value_or("\n");
+}
+
+asio::awaitable<void> listen(tcp::acceptor& acceptor)
+{
+  for (;;)
+  {
+    co_spawn(
+        acceptor.get_executor(),
+        consumer(co_await acceptor.async_accept(asio::use_awaitable)),
+        asio::detached);
+  }
+}
+
+int main()
+{
+  asio::io_context ctx;
+  tcp::acceptor acceptor(ctx, {tcp::v4(), 54321});
+  co_spawn(ctx, listen(acceptor), asio::detached);
+  ctx.run();
+}
+
    +

    +
    Thanks go to Klemens Morgenstern for contributing this feature. +

    +
    • +
  • + Added move assignment to ssl::stream<>. +
    • +
  • + Changed co_spawn to dispatch the coroutine's initial step + to the executor, and to only post + the completion handler if the coroutine did not otherwise perform a context + switch (i.e. a co_await + on an asynchronous operation). +
    • +
  • + Enabled additional optimisations for any_executor + and any_io_executor when + used with asynchronous operations. +
    • +
  • + Added the nodiscard attribute + to awaitable<>. +
    • +
  • + Increased the number of cached slots in the default recycling allocator. + This number defaults to 2, but may also be specified by defining the ASIO_RECYCLING_ALLOCATOR_CACHE_SIZE macro. +
    • +
  • + Disabled the std::system_error message workaround for recent + MSVC. +
    • +
  • + Changed the default allocator behaviour to respect alignment requirements, + to support over-aligned types. Requires C++17 or later, or Boost. +
    • +
  • + Ensured the result strings are always initialised in reverse name resolution. +
    • +
  • + Fixed recursive template instantiation issues in use_awaitable_t::executor_with_default. +
    • +
  • + Fixed the any_io_executor + equality operators to correctly return a result based on the target executor. +
    • +
+

+ + Asio + 1.18.2 +

+
    +
  • + Added ip::scope_id_type type alias. +
    • +
  • + Added ip::port_type type alias. +
    • +
  • + Added std::hash specialisations for IP addresses. +
    • +
  • + Added std::hash specialisations for ip::basic_endpoint<>. +
    • +
  • + Refactored SFINAE usage to improve compile times. +
    • +
  • + Added friendship support to customisation points, and made most customisations + private. +
    • +
  • + Changed any_io_executor + to a "strong typedef"-style class. +
    • +
  • + Fixed experimental::as_single to work with handler hook deprecation. +
    • +
  • + Ensured pthread condition variable attributes are cleaned up on all platforms. +
    • +
  • + Clarified thread safety notes on sockets and descriptors. +
    • +
  • + Ensured errno is not overwritten + if socket() + fails on macOS/FreeBSD. +
    • +
  • + Fixed work tracking for io_context + and thread_pool executors + when move-assigned. +
    • +
  • + Ensured internal call_stack + objects are accessed only from implementation files. +
    • +
  • + Fixed I/O object move-assignment to ensure the executor is left in a valid + state. +
    • +
  • + Fixed detection of compiler support for defaulted template argument on + functions with MSVC. +
    • +
  • + Prevented the blocking.always + property from being used with strand<>, as it did not produce the correct + semantics. +
    • +
  • + Removed deprecated file asio/impl/src.cpp. +
    • +
+

+ + Asio + 1.18.1 +

+
    +
  • + Enabled support for UNIX domain sockets on Windows. From Windows 10, UNIX + domain sockets (a.k.a "local" sockets) are supported on Windows, + with the exception of the connect_pair + function (which will fail with an operation_not_supported error). +
    • +
  • + Added executor-converting construction and assignment to ip::basic_resolver. +
    • +
  • + Added compatibility between polymorphic executors and the (deprecated) + handler invocation hook. +
    • +
  • +

    + Added the experimental::as_single + completion token adapter. The as_single + completion token adapter can be used to specify that the completion handler + arguments should be combined into a single argument. For completion signatures + with a single parameter, the argument is passed through as-is. For signatures + with two or more parameters, the arguments are combined into a tuple. The + as_single adapter may be + used in conjunction with use_awaitable + and structured bindings as follows:
    +

    +
    auto [e, n] = co_await socket.async_read_some(
+    asio::buffer(data), as_single(use_awaitable));
+
    +

    +
    Alternatively, it may be used as a default completion token like + so:
    +

    +
    using default_token = as_single_t<use_awaitable_t<>>;
+using tcp_socket = default_token::as_default_on_t<tcp::socket>;
+// ...
+awaitable<void> do_read(tcp_socket socket)
+{
+  // ...
+  auto [e, n] = co_await socket.async_read_some(asio::buffer(data));
+  // ...
+}
+
    +

    +
    +

    +
    • +
  • + Added support for MSG_NOSIGNAL + on more platforms by using _POSIX_VERSION + to detect whether it is supported. +
    • +
  • + Added the ability to compile using libpthread on Windows. +
    • +
  • + Added workarounds for the Intel C++ compiler. +
    • +
  • + Added more support for detecting and optimising for handlers that have + no custom executor. +
    • +
  • + Reduced lock contention for timer cancellation on Windows. +
    • +
  • + Reinstated a previously removed null-pointer check, as it had a measurable + impact on performance. +
    • +
  • + Fixed the executor concept + to test for a const-qualified execute(). +
    • +
  • + Fixed any_executor support + for builds without RTTI support. +
    • +
  • + Fixed the thread_pool unit + test to work without RTTI support. +
    • +
  • + Fixed C++20 coroutines compatibility with clang on Windows. +
    • +
  • + Fixed some compatibility issues with Windows Runtime. +
    • +
  • + Fixed shadow name warnings caused by addition of asio::query. +
    • +
  • + Fixed a "logical ‘or’ of equal expressions" warning on linux. +
    • +
  • + Fixed a benign switch fallthrough warning. +
    • +
  • + Added missing push/pop_options.hpp includes. +
    • +
  • + Suppressed zero-as-null-pointer-constant warnings. +
    • +
  • + Fixed a comma-operator warning. +
    • +
  • + Updated the documentation to clarify when the select + reactor is used on Windows. +
    • +
  • + Fixed potential ambiguity caused by any_executor + comparisons and conversion. +
    • +
  • + Added detection of non-experimental C++20 coroutines on MSVC 19.8. +
    • +
  • + Fixed compatibility with uClibc. +
    • +
  • + Fixed strand<> + adaptation of Networking TS executors when targeting older C++ versions + or less conformant compilers. +
    • +
+

+ + Asio + 1.18.0 +

+
    +
  • + Marked the basic_socket_acceptor + move constructor as noexcept. +
    • +
  • + Added workarounds for various issues in gcc 10's coroutine + support. +
    • +
  • + Added standard executor support to windows::overlapped_ptr. +
    • +
  • + Added missing compatibility macros for the execution::receiver_of + concept. +
    • +
  • + Added short-circuited evaluation to execution::executor, + execution::operation_state,execution::sender, + execution::receiver, execution::receiver_of, + and execution::scheduler concepts and the corresponding + traits. These now test first for well-formed CPO expressions (or, in the + case of senders, a specialised sender_traits + template) and, if not valid, short-circuit the remainder of the evaluation. + This helps prevent recursive template instantiations that can occur in + some contexts. +
    • +
  • + Added constraints to the strand + template's constructor, to prevent template instantiation recursion. +
    • +
  • + Changed Asio's internal executor adapters to prevent template instantiation + recursion. +
    • +
  • + Added constraints to the execution::any_executor + template's converting constructors, as per the specification. +
    • +
  • + Added missing execution::sender_traits + specialisation and connect() member function to the thread_pool executor, as per the specification. +
    • +
  • + Changed execution::blocking_t::always_t::is_preferable to be false as per the + specification. +
    • +
  • + Added shape_type and index_type to thread_pool + executors, as per the specification. +
    • +
  • + Ensured that the standard executor concept-related traits (such as execution::is_executor) work with void. +
    • +
  • + Fixed async_compose support + for standard executors. +
    • +
  • + Fixed the forward declaration of any_io_executor + in asio/ts/netfwd.hpp. +
    • +
  • + Fixed use_future compatibility + with older compilers. +
    • +
  • + Fixed compatibility with MinGW. +
    • +
  • + Improved compatibility with older versions of gcc. +
    • +
  • + Added compatiblity with clang-cl on Windows. +
    • +
  • + Fixed various compiler warnings. +
    • +
  • + Added basic overview documentation for the standard executors support. +
    • +
  • + Added detailed descriptions to the standard executor-related member functions + of io_context executors, + thread_pool executors, + system_executor, and strand<>. +
    • +
  • + Changed introductory documentation to reflect that there our now multiple + types of I/O execution context. +
    • +
  • + Marked constructors, destructors, and static data members in class synopses + in the reference documentation. +
    • +
  • + Fixed various minor documentation errors. +
    • +
+

+ + Asio + 1.17.0 +

+
    +
  • + Added an implementation of the proposed standard executors (P0443r13, + P1348r0, and P1393r0). +
    • +
  • + Added support for the proposed standard executors to Asio's I/O facilities: +
      +
    • + The io_context::executor_type, thread_pool::executor_type, + system_executor, + and strand executors + now meet the requirements for the proposed standard executors. These + classes also continue to meet the existing requirements for the Networking + TS model of executors. +
      • +
    • + All I/O objects, asynchronous operations, and utilities including + dispatch, post, defer, + get_associated_executor, + bind_executor, make_work_guard, spawn, co_spawn, + async_compose, use_future, etc., can interoperate + with both new proposed standard executors, and with existing Networking + TS executors. The implementation determines at compile time which + model a particular executor meets; the proposed standard executor + model is used in preference if both are detected. +
      • +
    • + The any_io_executor + type alias has been introduced as the new default runtime-polymorphic + executor for all I/O objects. This type alias points to the execution::any_executor<> + template with a set of supportable properties specified for use with + I/O. This change may break existing code that directly uses the old + polymorphic wrapper, executor. + If required for backward compatibility, ASIO_USE_TS_EXECUTOR_AS_DEFAULT + can be defined, which changes the any_io_executor + type alias to instead point to the executor + polymorphic wrapper. +
      • +
    • + Support for the existing Networking TS model of executors can be + disabled by defining ASIO_NO_TS_EXECUTORS. +
      • +
    +
    • +
  • +

    + Added converting move construction and assignment to basic_waitable_timer. + This enables move construction and assignment between different timer types, + provided the executor types are convertible. For example:
    +

    +
    basic_waitable_timer<
+    clock_type,
+    traits_type,
+    io_context::executor_type
+  > timer1(my_io_context);
+
+basic_waitable_timer<
+    clock_type,
+    traits_type,
+    any_io_executor // polymorphic wrapper
+  > timer2(std::move(timer1));
+
    +

    +
    +

    +
    • +
  • + Enabled C++20 coroutine support when using gcc 10. +
    • +
  • +

    + Added overloads of co_spawn + that launch an awaitable. This change allows us to write:
    +

    +
    co_spawn(executor,
+    echo(std::move(socket)),
+    detached);
+
    +

    +
    instead of:
    +

    +
    co_spawn(executor,
+    [socket = std::move(socket)]() mutable
+    {
+      return echo(std::move(socket));
+    },
+    detached);
+
    +

    +
    +

    +
    • +
  • + Added a new constructor overload to use_awaitable_t's + default executor adapter, to enable conversion between executor types. +
    • +
  • + Added support for using detached_t + as a default completion token, by adding members as_default_on() and as_default_on_t<>. +
    • +
  • + Added a move constructor to ssl::stream<>. +
    • +
  • + Changed ssl::stream<> + write operations to linearise gather-write buffer sequences. +
    • +
  • + Added compile-time detection of the deprecated asio_handler_invoke + hook. This hook was deprecated with the introduction of the Networking + TS trait associated_executor + and function get_associated_executor(). Compiling an application with ASIO_NO_DEPRECATED will now trigger a + compile error if any handler implements the asio_handler_invoke + hook. +
    • +
  • + Added compile-time detection of the deprecated asio_handler_allocate + and asio_handle_deallocate + hooks. These hooks were deprecated with the introduction of the Networking + TS trait associated_allocator + and function get_associated_allocator(). Compiling an application with ASIO_NO_DEPRECATED will now trigger a + compile error if any handler implements the asio_handler_allocate + or asio_handler_deallocate + hooks. +
    • +
  • + Implemented a number of performance optimisations, including: +
      +
    • + Specialising single-buffer operations to use recv + rather than recvmsg, + send rather than + sendmsg, read rather than readv, and write + rather than writev. +
      • +
    • + Lightening the reference counting overhead of the polymorphic wrapper + executor. +
      • +
    • + Returning from system call operation wrappers as early as possible, + and only accessing errno + and error codes when on an error path. +
      • +
    • + Applying additional optimisations if a "native" I/O executor + (such as io_context::exeutor_type) + is detected. +
      • +
    +
    • +
  • +

    + Added source location support to handler tracking. The new ASIO_HANDLER_LOCATION((file_name, + line, + function_name)) + macro may be used to inform the handler tracking mechanism of a source + location. This macro declares an object that is placed on the stack. Then, + when an asynchronous operation is launched with location information, it + outputs lines using the <action> + n^m, prior to the n*m line that signifies + the beginning of the asynchronous operation. For example: +

    +
      @asio|1589423304.861944|>7|ec=system:0,bytes_transferred=5
+  @asio|1589423304.861952|7^8|in 'async_write' (...../../include/asio/impl/write.hpp:330)
+  @asio|1589423304.861952|7^8|called from 'do_write' (handler_tracking/async_tcp_echo_server.cpp:62)
+  @asio|1589423304.861952|7^8|called from 'operator()' (handler_tracking/async_tcp_echo_server.cpp:51)
+  @asio|1589423304.861952|7*8|socket@0x7ff61c008230.async_send
+  @asio|1589423304.861975|.8|non_blocking_send,ec=system:0,bytes_transferred=5
+  @asio|1589423304.861980|<7|
    +

    +
    If std::source_location or std::experimental::source_location + are available, the use_awaitable_t + token (when default-constructed or used as a default completion token) + will also cause handler tracking to output a source location for each newly + created asynchronous operation. A use_awaitable_t + object may also be explicitly constructed with location information. +

    +
    • +
  • + Implemented various improvements to the handlerviz.pl + tool. +
      +
    • + Add nodes for pending handlers at bottom of graph, outlined in red. +
      • +
    • + Display source location in a tooltip on the edge label (for SVG). +
      • +
    • + Use invisible nodes to enforce order to keep related control flow + vertical. +
      • +
    +
    • +
  • +

    + Added the handlerlive.pl tool, which processes handler + tracking output to produce a list of "live" handlers. Live handlers + are those that are associated with pending asynchronous operations, as + well as handlers that are currently executing. For example: +

    +
    cat output.txt | perl handlerlive.pl
+
    +

    + or: +

    +
    perl handerlive.pl < output.txt
+
    +

    + or: +

    +
    perl handlerlive.pl output.txt
+
    +

    +
    +

    +
    • +
  • +

    + Added the handlertree.pl tool, which filters handler + tracking output to include only those events in the tree that produced + the nominated handlers. For example, to filter the output to include only + the events associated with handlers 123, + 456, and their predecessors: +

    +
      cat output.txt | perl handlertree.pl 123 456
    +

    + or: +

    +
      perl handlertree.pl 123 456 < output.txt
    +

    +
    This script may be combined with handerlive.pl and handlerviz.pl + to produce a graph of the "live" asynchronous operation chains. + For example: +

    +
      cat output.txt | \
+    perl handlertree.pl perl handlerlive.pl output.txt | \
+    perl handlerviz.pl | \
+    dot -Tsvg > output.svg
    +

    +
    +

    +
    • +
  • + Added changes for clang-based Embarcadero C++ compilers. +
    • +
  • + Fixed a deadlock that can occur when multiple threads concurrently initialise + the Windows I/O completion port backend. +
    • +
  • + Fixed async_compose to + work with copyable handlers when passed by lvalue. +
    • +
  • + Fixed completion signature deduction in co_spawn. +
    • +
  • + Removed a spurious Executor + base class from the executor_binder + implementation. +
    • +
  • + Various fixes and improvements in the documentation and examples. +
    • +
+

+ + Asio + 1.16.1 +

+
    +
  • + Fixed compatibility with C++20 concept syntax. +
    • +
  • + Marked the POSIX descriptor classes' move constructors as noexcept. +
    • +
  • + Added the ssl::host_name_verification class, which is + a drop-in replacement for ssl::rfc2818_verification. + The ssl::rfc2818_verification class has been marked + as deprecated. As a consequence of this change, SSL support now depends + on functions that were introduced in OpenSSL 1.0.2. +
    • +
  • + Added an ssl::context constructor to take ownership + of a native handle. +
    • +
  • + Changed C++ language version detection with gcc to use + __cplusplus macro. +
    • +
  • + Fixed a work counting issue in the asynchronous resolve operation for endpoints. +
    • +
  • + Fixed the strand<> + converting constructors and assignment operators. +
    • +
  • + Ensured that resolvers are restarted correctly after a fork. +
    • +
  • + Fixed compatibility with the current NetBSD release. +
    • +
  • + Removed spurious handler requirement checks in some async_read + overloads. +
    • +
  • + Changed the ssl::context class to propagate non-EOF errors + from the add_certificate_authority + function. +
    • +
  • + Fixed a Windows-specific thread_pool + destructor hang that occurred when the pool had an associated I/O object. +
    • +
  • + Changed the select reactor to recreate the "self + pipe trick" sockets on error. This addresses an issue on some versions + of Windows, where these sockets are discconected after a system sleep. +
    • +
  • + Fixed a compile error in the buffered streams due to the lack of reference + collapsing in C++98. +
    • +
  • + Changed the priority_scheduler + example to demonstrate calls to shutdown() and destroy(). +
    • +
  • + Removed some unnecessary null pointer checks. +
    • +
  • + Changed Windows platform detection to recognise TV titles as Windows apps. +
    • +
  • + Added some emscripten compatibility patches. +
    • +
  • + Fixed a compile error in the use_awaitable_t::as_default_on + function. +
    • +
  • + Changed all uses of the boost.bind placeholders to use the boost::placeholders namespace. +
    • +
  • + Fixed a potential compile error in the async_compose + implementation due to incorrect overload selection. +
    • +
  • + Suppressed some non-virtual destructor warnings. +
    • +
  • + Various documentation fixes and improvements. +
    • +
+

+ + Asio + 1.16.0 +

+
    +
  • + Changed the async_initiate + helper function to automatically deduce its return type. This is enabled + for C++11 or later. +
    • +
  • + Changed all asynchronous operations to use automatically deduced return + types. This allows completion token implementations to incorporate the + asynchronous operation initiation into the initiating function's return + type, without type erasure. Note that C++14 or later is required to support + completion tokens that use per-operation return type deduction. For C++11 + or earlier, a completion token's async_result specialisation must still + provide the nested typedef return_type. +
    • +
  • + Introduced three new concepts to support async_initiate. +
      +
    • + completion_signature<T>: Checks if T + is a signature of the form R(Args...). +
      • +
    • + completion_handler_for<T, Signature>: Checks if T + is usable as a completion handler with the specified signature. +
      • +
    • + completion_token_for<T, Signature>: Checks if T + is a completion token that can be used with async_initiate and the + specified signature. +
      • +
    • + For backward compatibility with pre-concepts C++, the macros (BOOST_)ASIO_COMPLETION_SIGNATURE, + (BOOST_)ASIO_COMPLETION_HANDLER_FOR, + and (BOOST_)ASIO_COMPLETION_TOKEN_FOR + are provided. These macros expand to typename + when concepts are unsupported. +
      • +
    +
    • +
  • +

    + Added the nested template type rebind_executor + to all I/O object types, as a way to generically rebind them to use alternative + I/O executors. For example: +

    +
    using my_socket_type = tcp::socket::rebind_executor<my_executor_type>::other;
+
    +

    +
    +

    +
    • +
  • + Changed the asynchronous operations' initiation function objects to report + their associated I/O executor via the nested type executor_type + and member function get_executor(). Note that the presence of executor_type and get_executor() should be treated as optional, and consequently + it may be preferable to access them via the associated_executor + trait and the get_associated_executor() helper function. +
    • +
  • +

    + Added the default_completion_token + trait, so that every I/O executor type now has an associated default completion + token type. This trait may be used in asynchronous operation declarations + as follows: +

    +
    template <
+    typename IoObject,
+    typename CompletionToken =
+      typename default_completion_token<
+        typename IoObject::executor_type
+      >::type
+  >
+auto async_xyz(
+    IoObject& io_object,
+    CompletionToken&& token =
+      typename default_completion_token<
+        typename IoObject::executor_type
+      >::type{}
+  );
+
    +

    +
    If not specialised, this trait type is void, + meaning no default completion token type is available for the given I/O + executor. +

    +
    • +
  • +

    + Specialised the default_completion_token + trait for the use_awaitable + completion token, so that it may be used as shown in the following example: +

    +
    auto socket = use_awaitable.as_default_on(tcp::socket(my_context));
+// ...
+co_await socket.async_connect(my_endpoint); // Defaults to use_awaitable.
+
    +

    +
    In this example, the type of the socket + object is transformed from tcp::socket + to have an I/O executor with the default completion token set to use_awaitable. Alternatively, the socket + type may be computed directly: +

    +
    using tcp_socket = use_awaitable_t<>::as_default_on_t<tcp::socket>;
+tcp_socket socket(my_context);
+// ...
+co_await socket.async_connect(my_endpoint); // Defaults to use_awaitable.
+
    +

    +
    +

    +
    • +
  • + Added missing async_initiate + to the Windows-specific I/O objects' asynchronous operations. +
    • +
  • +

    + Ensured that the executor type is propagated to newly accepted sockets. + When synchronously or asynchronously accepting a new connection, but without + specifying an executor or execution context, the accept operation will + now correctly propagate the executor type from the acceptor to the socket. + For example, if your acceptor type is: +

    +
    basic_socket_acceptor<ip::tcp, my_executor_type>
+
    +

    +
    then your accepted socket type will be: +

    +
    basic_stream_socket<ip::tcp, my_executor_type>
+
    +

    +
    +

    +
    • +
  • + Changed to require that Protocol + copy and move operations never throw. +
    • +
  • + Changed to require that Endpoint + default constructor and move operations never throw. +
    • +
  • + Added the noexcept qualifier + to protocol accessors. +
    • +
  • + Added the noexcept qualifier + to socket move constructors. +
    • +
  • + Fixed issues associated with opening serial ports on Windows: +
      +
    • + Use the correct constant to initialise the RTS control flag. +
      • +
    • + Specify a default baud rate (9600). +
      • +
    +
    • +
  • + Fixed a lost "outstanding work count" that can occur when an + asynchronous accept operation is automatically restarted. +
    • +
+

+ + Asio + 1.14.1 +

+
    +
  • + Improved performance slightly by eliminating a redundant move construction + when completed handlers are dispatched. +
    • +
  • + Eliminated a compiler warning by annotating a case + fall-through in the free function connect() implementation. +
    • +
  • + Fixed the is_*_buffer_sequence detection traits for + user-defined sequence types. +
    • +
  • + Fixed some Windows-specific warnings about an incompatible pointer cast + when obtaining the CancelIoEx + entry point. +
    • +
  • + Changed to automatically set the defaults when opening a serial port on + Windows. +
    • +
  • + Changed the serial port get_option() member function to be const. +
    • +
  • + Fixed a name hiding issue with the WinRT stream-oriented socket backend's + shutdown function. +
    • +
  • + Applied a minor fix to the documentation for is_dynamic_buffer. +
    • +
  • + Added some support for Haiku OS. +
    • +
  • + Added wolfSSL compatability. +
    • +
  • + Changed to require C++17 or later for coroutines TS support with clang. +
    • +
  • + Fixed a doxygen generation problem in the tutorial. +
    • +
+

+ + Asio + 1.14.0 +

+
    +
  • + Improved I/O object performance by adding runtime detection of native I/O + executors when using the polymorphic executor wrapper. +
    • +
  • + Changed I/O object move constructors so that the executor is copied, not + moved. This ensures that the moved-from I/O object is left in the same + state as if constructed with a valid executor but without a resource. +
    • +
  • + On Windows, fixed an issue where global object destructors were not being + run. +
    • +
  • + Fixed move-based async_accept + between sockets with different executor types. +
    • +
+

+ + Asio + 1.13.0 +

+
    +
  • + Added custom I/O executor support to I/O objects. +
      +
    • + All I/O objects now have an additional Executor + template parameter. This template parameter defaults to the asio::executor type (the polymorphic + executor wrapper) but can be used to specify a user-defined executor + type. +
      • +
    • + I/O objects' constructors and functions that previously took an + asio::io_context& + now accept either an Executor + or a reference to a concrete ExecutionContext + (such as asio::io_context or asio::thread_pool). +
      • +
    • +

      + Note: One potential source of breakage in existing user code is when + reusing an I/O object's io_context + for constructing another I/O object, as in: +

      +
      asio::steady_timer my_timer(my_socket.get_executor().context());
+
      +

      +
      To fix this, either construct the second I/O object using + the first I/O object's executor:
      +

      +
      asio::steady_timer my_timer(my_socket.get_executor());
+
      +

      +
      or otherwise explicitly pass the io_context:
      +

      +
      asio::steady_timer my_timer(my_io_context);
+
      +

      +
      +

      +
      • +
    • + The previously deprecated get_io_context + and get_io_service + member functions have now been removed. +
      • +
    • + The previously deprecated service template parameters, and the corresponding + classes, have now been removed. +
      • +
    +
    • +
  • + Added a new async_result + form with an initiate static + member function. +
      +
    • +

      + The async_result + template now supports a new form: +

      +
      template <typename CompletionToken, typename Signature>
+struct async_result
+{
+  typedef /* ... */ return_type;
+
+  template <typename Initiation,
+      typename RawCompletionToken,
+      typename... Args>
+  static return_type initiate(
+      Initiation&& initiation,
+      RawCompletionToken&& token,
+      Args&&... args);
+};
+
      +

      +
      +

      +
      • +
    • + The initiate member + function must: (a) transform the token into a completion handler + object handler; (b) + cause the invocation of the function object initiation + as if by calling std::forward<Initiation>(initiation)(std::move(handler), std::forward<Args>(args)...). Note that the invocation of + initiation may be + deferred (e.g. lazily evaluated), in which case initiation + and args must be + decay-copied and moved as required. +
      • +
    • + A helper function template async_initiate + has also been added as a wrapper for the invocation of async_result<>::initiate. For backward compatibility, + this function supports both the old and new async_result + forms. +
      • +
    • + The composed operations examples have been updated to use async_initiate. +
      • +
    • + The previously deprecated handler_type + trait and single-argument form of async_result + have now been removed. +
      • +
    +
    • +
  • + Updated the Coroutines TS support and promoted it to the asio namespace. +
      +
    • + The awaitable<>, + co_spawn, this_coro, detached, + and redirect_error + facilities have been moved from the asio::experimental + namespace to namespace asio. + As part of this change, the this_coro::token() awaitable has been superseded by + the asio::use_awaitable completion token. +
      • +
    • + Please note that the use_awaitable + and redirect_error + completion tokens work only with asynchronous operations that use + the new form of async_result + with member function initiate. + Furthermore, when using use_awaitable, + please be aware that the asynchronous operation is not initiated + until co_await is + applied to the awaitable<>. +
      • +
    +
    • +
  • + Added a new DynamicBuffer_v2 + concept which is CopyConstructible. +
      +
    • +

      + This change adds a new set of type requirements for dynamic buffers, + DynamicBuffer_v2, + which supports copy construction. These new type requirements enable + dynamic buffers to be used as arguments to user-defined composed + operations, where the same dynamic buffer object is used repeatedly + for multiple underlying operations. For example:
      +

      +
      template <typename DynamicBuffer>
+void echo_line(tcp::socket& sock, DynamicBuffer buf)
+{
+  n = asio::read_until(sock, buf, '\n');
+  asio::write(sock, buf, asio::transfer_exactly(n));
+}
+
      +

      +
      +

      +
      • +
    • + The original DynamicBuffer + type requirements have been renamed to DynamicBuffer_v1. + These requirements continue to be compatible with the Networking + TS. +
      • +
    • + New type traits is_dynamic_buffer_v1 + and is_dynamic_buffer_v2 + have been added to test for conformance to DynamicBuffer_v1 + and DynamicBuffer_v2 + respectively. The existing is_dynamic_buffer + trait has been retained and delegates to is_dynamic_buffer_v1 + (unless ASIO_NO_DYNAMIC_BUFFER_V1 + is explicitly defined, in which case it delegates to is_dynamic_buffer_v2). +
      • +
    • + For convenience, the dynamic_string_buffer + and dynamic_vector_buffer + classes conform to both DynamicBuffer_v1 + and DynamicBuffer_v2 + requirements. +
      • +
    • + When ASIO_NO_DYNAMIC_BUFFER_V1 + is defined, all support for DynamicBuffer_v1 + types and functions is #ifdef-ed out. Support for using basic_streambuf with the read, async_read, + read_until, async_read_until, write, and async_write + functions is also disabled as a consequence. +
      • +
    • + Note: This change should have no impact on existing source code that + simply uses dynamic buffers in conjunction with Asio's composed operations. +
      • +
    +
    • +
  • + Added a new async_compose + function that simplifies the implementation of user-defined asynchronous + operations. +
    • +
  • + Added a make_strand function, + which creates a strand + with a deduced Executor + template argument. +
    • +
  • + Relaxed the completion condition type requirements to only require move-constructibility + rather than copy-constructibility. +
    • +
  • + Added a constructor for local::basic_endpoint + that takes a string_view. +
    • +
  • + Added the noexcept qualifier to various member functions of the ip::address, ip::address_v4, + ip::address_v6, ip::basic_endpoint, + and executor_work_guard + classes. +
    • +
  • + Added the noexcept qualifier to the buffer_sequence_begin + and buffer_sequence_end + functions. +
    • +
  • + Added a new ASIO_DISABLE_VISIBILITY + configuration #define + that allows visibility pragmas to be disabled. (Note: If symbols are hidden, + extra care must be taken to ensure that Asio types are not passed across + shared library API boundaries.) +
    • +
  • + Changed compile-time feature detection to define ASIO_STANDALONE + automatically if C++11 or later is detected. +
      +
    • + Users should define ASIO_ENABLE_BOOST + to explicitly disable standalone mode when compiling with C++11 or + later. +
      • +
    • + The configure script + now defaults to a standalone build unless Boost is specified or detected. +
      • +
    +
    • +
  • + Enabled recycling of the memory used to type-erase a function object with + the polymorphic executor. +
    • +
  • + Changed receive operations to return the correct number of bytes transferred + when truncation (error::message_size) + occurs on a datagram-oriented socket. +
    • +
  • + Fixed multicast behaviour on QNX by automatically applying SO_REUSEPORT when the reuse_address + option is set. +
    • +
  • + Added inclusion of unistd.h when + targeting Haiku OS, to fix feature detection. +
    • +
  • + Added the network_v[46].hpp + headers to the top-level convenience header. +
    • +
  • + Fixed calculation of absolute timeout when the backend uses pthread_cond_timedwait. +
    • +
  • + Changed the range-based asynchronous connect operation to deduce the EndpointSequence iterator type rather + than assume the presence of a const_iterator + typedef. +
    • +
  • + Fixed buffer_sequence_begin + and buffer_sequence_end + to prevent implicit conversion. This change addresses an issue where a + call to buffer_sequence_begin + or buffer_sequence_end + could trigger an implicit conversion to const_buffer + or mutable_buffer. Whenever + this implicit conversion occurred, the return value of buffer_sequence_begin + or buffer_sequence_end + would point to a temporary object. +
    • +
  • + Ensured SSL handshake errors are propagated to the peer before the local + operation completes. +
    • +
  • + Suppressed the eof error + on SSL shutdown as it actually indicates success. +
    • +
  • + Added a fallback error code for when we OpenSSL produces an SSL_ERROR_SYSCALL result without an associated + error. +
    • +
  • + Changed composed asynchronous read and write operations to move, rather + than copy, the buffer sequence objects when the composed operation implementation + is moved. +
    • +
  • + Changed to use <atomic> when targeting apple/clang/libc++ with + recent Xcode versions, even for C++03. This fixes a warning about the deprecation + of OSMemoryBarrier. +
    • +
  • + Fixed compile errors that occur when using the composed read and write + operations with MSVC 11.0, by disabling decltype + support for that compiler. +
    • +
  • + Increased the default value of _WIN32_WINNT + to 0x0601 (Windows 7). +
    • +
  • + Fixed dispatch documentation + to note that it may call the supplied function object in the current thread. +
    • +
  • + Updated post and defer documentation to clarify the the + distinction between them. +
    • +
+

+ + Asio + 1.12.2 +

+
    +
  • + Fixed a problem with the detection of std::future + availability with libstdc++. +
    • +
  • + Fixed compile error in regex overload of read_until. +
    • +
  • + Fixed a timer heap corruption issue that can occur when moving a cancelled + timer. +
    • +
  • + Fixed detection of std::experimental::string_view + and std::string_view with newer clang/libc++. +
    • +
  • + Fixed MSVC version detection for availability of std::invoke_result. +
    • +
  • + Fixed the buffer sequence traits to test the new requirements, if decltype is available. +
    • +
  • + Fixed an MSVC issue when building with exceptions disabled. +
    • +
  • + Added SSL context options for TLS v1.3. +
    • +
  • + Added a compile-time test for TLS v1 support. +
    • +
  • + Fixed the macro used to test for TLS v1.2 support. +
    • +
  • + Prevented global objects from being created once per thread on Windows. +
    • +
  • + Fixed a crash when using size(), max_size() or empty() on default-constructed resolver results. +
    • +
  • + Changed to move the return value in basic_resolver_results::begin() to + avoid copying. +
    • +
  • + Enabled move support for the Intel Compiler. +
    • +
  • + Fixed std::string_view detection issue when using + clang-cl. +
    • +
  • + Fixed the handler tracking operation name for io_context::executor_type::dispatch. +
    • +
  • + Fixed a buffer overflow that could occur when parsing an address string + with a 64-bit scope id. +
    • +
  • + Added examples showing how to write composed operations. +
    • +
  • + Added C++11 versions of the Timeouts, Timers, SOCKS4 and SSL examples. +
    • +
  • + Fixed minor issues in documentation and examples. +
    • +
+

+ + Asio + 1.12.1 +

+
    +
  • + Added missing const qualifier to basic_socket_acceptor::get_option. +
    • +
  • + Worked around a parsing error that occurs with some versions of gcc. +
    • +
  • + Fixed broken code samples in tutorial. +
    • +
  • + Added new experimental features. (Note that "experimental" features + may be changed without notice in subsequent releases.) +
      +
    • + Added experimental::detached + completion token. +
      • +
    • + Added experimental::redirect_error + completion token. +
      • +
    • + Added experimental::co_spawn + facility for integration with the coroutines technical specification. +
      • +
    +
    • +
  • + Updated timeout examples to use latest features. +
      +
    • + Used asio::steady_timer rather than asio::deadline_timer. +
      • +
    • + Used asio::dynamic_buffer rather than asio::streambuf. +
      • +
    • + Used timed asio::io_context::run_for() + function for blocking clients. +
      • +
    • + Added example showing a custom completion token for blocking with + timeouts. +
      • +
    +
    • +
  • + Fixed unit tests to compile when (BOOST_)ASIO_NO_DEPRECATED is defined. +
    • +
  • + Changed socket iostreams to use chrono by default, to fix compatibility + with the Networking TS. Define (BOOST_)ASIO_USE_BOOST_DATE_TIME_FOR_SOCKET_IOSTREAM + to enable the old Boost.Date_Time interface in basic_socket_streambuf + and basic_socket_iostream. +
    • +
  • + Updated examples to use chrono rather than Boost.Date_Time. +
    • +
  • + Fixed an incorrect member function detector in the is_dynamic_buffer + trait. +
    • +
  • + Fixed an async_result incompatibility + with deprecated handler_type. +
    • +
  • + Added a missing move optimisation in the SSL stream implementation. +
    • +
  • + Fixed incorrect basic_resolver_results::value_type + typedef. +
    • +
  • + Fixed a compile error with some OpenSSL versions when SSL_OP_NO_COMPRESSION + is defined. +
    • +
  • + Changed add_certificate_authority + to process multiple certificates in a bundle. +
    • +
  • + Eliminated deprecation warning with MSVC by using std::invoke_result + rather than std::result_of. +
    • +
  • + Changed to use std::string_view for C++17 or later, and + std::experimental::string_view for C++14. Define the preprocessor + macro (BOOST_)ASIO_DISABLE_STD_STRING_VIEW + to force the use of std::experimental::string_view (assuming it is available) + when compiling in C++17 mode. +
    • +
  • + Ensured DynamicBuffer template + arguments are decayed before using in enable_if + tests. +
    • +
  • + Changed documentation to distinguish legacy completion handlers (which + are still required to be CopyConstructible) from new MoveConstructible + handlers. +
    • +
  • + Suppressed a discarded return value warning in the buffer debugging support. +
    • +
  • + Fixed basic_yield_context + to work with completion signatures containing reference parameters. +
    • +
  • + Ensured that stackful coroutines launched using spawn() correctly store decayed copies of their + function and handler arguments. +
    • +
  • + Fixed some compatibility issues with Android. +
    • +
  • + Fixed some minor portability issues in examples. +
    • +
+

+ + Asio + 1.12.0 +

+
    +
  • + Completed the interface changes to reflect the Networking TS (N4656). +
      +
    • + See the list of new interfaces + and, where applicable, the corresponding old interfaces that have + been superseded. +
      • +
    • + The service template parameters, and the corresponding classes, are + disabled by default. For example, instead of basic_socket<Protocol, SocketService> we now have simply basic_socket<Protocol>. + The old interface can be enabled by defining the (BOOST_)ASIO_ENABLE_OLD_SERVICES macro. +
      • +
    +
    • +
  • + Added support for customised handler tracking. +
    • +
  • + Added reactor-related (i.e. descriptor readiness) events to handler tracking. +
    • +
  • + Added special concurrency hint values that may be used to disable locking + on a per io_context basis. +
    • +
  • + Enabled perfect forwarding for the first ssl::stream<> constructor argument. +
    • +
  • + Added ability to release ownership of the underlying native socket. (Requires + Windows 8.1 or later when using the I/O completion port backend.) +
    • +
+

+ + Asio + 1.11.0 +

+
    +
  • + Implemented changes to substantially reflect the Networking Library Proposal + (N4370). +
      +
    • + New Executor type + requirements and classes to support an executor framework, including + the execution_context + base class, the executor_work + class for tracking outstanding work, and the executor + polymorphic wrapper. Free functions dispatch(), post() and defer() have been added and are used to + submit function objects to executors. +
      • +
    • + Completion handlers now have an associated executor and associated + allocator. The free function wrap() is used to associate an executor + with a handler or other object. The handler hooks for allocation, + invocation and continuation have been deprecated. +
      • +
    • + A system_executor + class has been added as a default executor. +
      • +
    • + The io_service class + is now derived from execution_context + and implements the executor type requirements in its nested executor_type class. The member + functions dispatch(), post(), defer() and wrap() have been deprecated. The io_service::work class has been deprecated. +
      • +
    • + The io_service member + function reset() + has been renamed to restart(). The old name is retained for backward + compatibility but has been deprecated. +
      • +
    • + The make_service<>() function is now used to + add a new service to an execution context such as an io_service. The add_service() function has been deprecated. +
      • +
    • + A new strand<> + template has been added to allow strand functionality to be used + with generic executor types. +
      • +
    • + I/O objects (such as sockets and timers) now provide access to their + associated io_service + via a context() + member function. The get_io_service() member function is deprecated. +
      • +
    • + All asynchronous operations and executor operations now support move-only + handlers. However, the deprecated io_service::post(), io_service::dispatch(), io_service::strand::post() and io_service::strand::dispatch() functions still require copyable + handlers. +
      • +
    • + Waitable timer objects are now movable. +
      • +
    • + Waitable timers, socket iostreams and socket streambufs now provide + an expiry() + member function for obtaining the expiry time. The accessors expires_at() + and expires_after() have been deprecated, though those + names are retained for the mutating members. +
      • +
    • + The std::packaged_task class template is + now supported as a completion handler. The initiating operation automatically + returns the future associated with the task. The package() function has been added as a convenient + factory for packaged tasks. +
      • +
    • + Sockets, socket acceptors and descriptors now provide wait() + and async_wait() + operations that may be used to wait for readiness. The null_buffers type has been deprecated. +
      • +
    • + The proposed error code enum classes are simulated using namespaces. + Existing asio error codes now have a correspondence with the standard + error conditions. +
      • +
    • + Conversion between IP address types, and conversion from string to + address, is now supported via the address_cast<>(), make_address(), make_address_v4() and make_address_v6() free functions. The from_string(), + to_v4(), + to_v6() + and v4_mapped() + member functions have been deprecated. +
      • +
    • + A default-constructed ip::address + now represents an invalid address value that is neither IPv4 nor + IPv6. +
      • +
    • + New buffer() + overloads that generate mutable buffers for non-const string objects. +
      • +
    • + Support for dynamic buffer sequences that automatically grow and + shrink to accomodate data as it is read or written. This is a generic + facility similar to the existing asio::streambuf + class. This support includes: +
        +
      • + New dynamic_string_buffer + and dynamic_vector_buffer + adapter classes that meet the DynamicBufferSequence + type requirements. +
        • +
      • + New dynamic_buffer() factory functions for creating + a dynamic buffer adapter for a vector + or string. +
        • +
      • + New overloads for the read(), async_read(), write() and async_write(), read_until() and async_read_until() free functions that directly + support dynamic buffer sequences. +
        • +
      +
      • +
    • + Support for networks and address ranges. Thanks go to Oliver Kowalke + for contributing to the design and providing the implementation on + which this facility is based. The following new classes have been + added: +
        +
      • + address_iterator_v4 + for iterating across IPv4 addresses +
        • +
      • + address_iterator_v6 + for iterating across IPv6 addresses +
        • +
      • + address_range_v4 + to represent a range of IPv4 addresses +
        • +
      • + address_range_v6 + to represent a range of IPv6 addresses +
        • +
      • + network_v4 + for manipulating IPv4 CIDR addresses, e.g. 1.2.3.0/24 +
        • +
      • + network_v6 + for manipulating IPv6 CIDR addresses, e.g. ffe0:/120 +
        • +
      +
      • +
    • + New convenience headers in <asio/ts/*.hpp> + that correspond to the headers in the proposal. +
      • +
    +
    • +
  • + Added a new, executor-aware thread_pool + class. +
    • +
  • + Changed spawn() + to be executor-aware. +
    • +
  • + Added a new spawn() + overload that takes only a function object. +
    • +
  • + Changed spawn() + and yield_context to permit + nested calls to the completion handler. +
    • +
  • + Removed previously deprecated functions. +
    • +
  • + Added options for disabling TLS v1.1 and v1.2. +
    • +
  • + Changed the SSL wrapper to call the password callback when loading an in-memory + key. +
    • +
  • + Changed the tutorial to use std::endl + to ensure output is flushed. +
    • +
  • + Fixed false SSL error reports by ensuring that the SSL error queue is cleared + prior to each operation. +
    • +
  • + Fixed an ssl::stream<> + bug that may result in spurious 'short read' errors. +
    • +
  • + Enabled perfect forwarding for the first ssl::stream<> constructor argument. +
    • +
  • + Added standalone Asio support for Clang when used with libstdc++ and C++11. +
    • +
  • + Fixed an unsigned integer overflow reported by Clang's integer sanitizer. +
    • +
  • + Added support for move-only return types when using a yield_context + object with asynchronous operations. +
    • +
  • + Ensured errors generated by Windows' ConnectEx + function are mapped to their portable equivalents. +
    • +
  • + Changed multicast test to treat certain join_group + failures as non-fatal. +
    • +
+

+ + Asio + 1.10.5 +

+
    +
  • + Fixed the kqueue reactor so that it works on FreeBSD. +
    • +
  • + Fixed an issue in the kqueue reactor which resulted + in spinning when using serial ports on Mac OS. +
    • +
  • + Fixed kqueue reactor support for read-only file descriptors. +
    • +
  • + Fixed a compile error when using the /dev/poll reactor. +
    • +
  • + Changed the Windows backend to use WSASocketW, + as WSASocketA has been + deprecated. +
    • +
  • + Fixed some warnings reported by Visual C++ 2013. +
    • +
  • + Fixed integer type used in the WinRT version of the byte-order conversion + functions. +
    • +
  • + Changed documentation to indicate that use_future + and spawn() + are not made available when including the asio.hpp + convenience header. +
    • +
  • + Explicitly marked asio::strand + as deprecated. Use asio::io_service::strand + instead. +
    • +
+

+ + Asio + 1.10.4 +

+
    +
  • + Stopped using certain Winsock functions that are marked as deprecated in + the latest Visual C++ and Windows SDK. +
    • +
  • + Fixed a shadow variable warning on Windows. +
    • +
  • + Fixed a regression in the kqueue backend that was introduced + in Asio 1.10.2. +
    • +
  • + Added a workaround for building the unit tests with gcc + on AIX. +
    • +
+

+ + Asio + 1.10.3 +

+
    +
  • + Worked around a gcc problem to do with anonymous enums. +
    • +
  • + Reverted the Windows HANDLE + backend change to ignore ERROR_MORE_DATA. + Instead, the error will be propagated as with any other (i.e. in an error_code or thrown as a system_error), and the number of bytes + transferred will be returned. For code that needs to handle partial messages, + the error_code overload + should be used. +
    • +
  • + Fixed an off-by-one error in the signal_set + implementation's signal number check. +
    • +
  • + Changed the Windows IOCP backend to not assume that SO_UPDATE_CONNECT_CONTEXT + is defined. +
    • +
  • + Fixed a Windows-specific issue, introduced in Asio 1.10.2, by using VerifyVersionInfo rather than GetVersionEx, as GetVersionEx + has been deprecated. +
    • +
  • + Changed to use SSE2 intrinsics rather than inline assembly, to allow the + Cray compiler to work. +
    • +
+

+ + Asio + 1.10.2 +

+
    +
  • + Fixed asio::spawn() + to work correctly with new Boost.Coroutine interface. +
    • +
  • + Ensured that incomplete asio::spawn() coroutines are correctly unwound when + cleaned up by the io_service + destructor. +
    • +
  • + Fixed delegation of continuation hook for handlers produced by io_service::wrap() + and strand::wrap(). +
    • +
  • + Changed the Windows I/O completion port backend to use ConnectEx, + if available, for connection-oriented IP sockets. +
    • +
  • + Changed the io_service + backend for non-Windows (and non-IOCP Windows) platforms to use a single + condition variable per io_service + instance. This addresses a potential race condition when run_one() + is used from multiple threads. +
    • +
  • + Prevented integer overflow when computing timeouts based on some boost::chrono and std::chrono + clocks. +
    • +
  • + Made further changes to EV_CLEAR + handling in the kqueue backend, to address other cases where the close() + system call may hang on Mac OS X. +
    • +
  • + Fixed infinite recursion in implementation of resolver_query_base::flags::operator~. +
    • +
  • + Made the select reactor + more efficient on Windows for large numbers of sockets. +
    • +
  • + Fixed a Windows-specific type-aliasing issue reported by gcc. +
    • +
  • + Prevented execution of compile-time-only buffer test to avoid triggering + an address sanitiser warning. +
    • +
  • + Disabled the GetQueuedCompletionStatus + timeout workaround on recent versions of Windows. +
    • +
  • + Changed implementation for Windows Runtime to use FormatMessageW + rather than FormatMessageA, + as the Windows store does not permit the latter. +
    • +
  • + Added support for string-based scope IDs when using link-local multicast + addresses. +
    • +
  • + Changed IPv6 multicast group join to use the address's scope ID as the + interface, if an interface is not explicitly specified. +
    • +
  • + Fixed multicast test failure on Mac OS X and the BSDs by using a link-local + multicast address. +
    • +
  • + Various minor documentation improvements. +
    • +
+

+ + Asio + 1.10.1 +

+
    +
  • + Implemented a limited port to Windows Runtime. This support requires that + the language extensions be enabled. Due to the restricted facilities exposed + by the Windows Runtime API, the port also comes with the following caveats: +
      +
    • + The core facilities such as the io_service, + strand, buffers, + composed operations, timers, etc., should all work as normal. +
      • +
    • + For sockets, only client-side TCP is supported. +
      • +
    • + Explicit binding of a client-side TCP socket is not supported. +
      • +
    • + The cancel() + function is not supported for sockets. Asynchronous operations may + only be cancelled by closing the socket. +
      • +
    • + Operations that use null_buffers + are not supported. +
      • +
    • + Only tcp::no_delay and socket_base::keep_alive + options are supported. +
      • +
    • + Resolvers do not support service names, only numbers. I.e. you must + use "80" rather than "http". +
      • +
    • + Most resolver query flags have no effect. +
      • +
    +
    • +
  • + Extended the ability to use Asio without Boost to include Microsoft Visual + Studio 2012. When using a C++11 compiler, most of Asio may now be used + without a dependency on Boost header files or libraries. To use Asio in + this way, define ASIO_STANDALONE + on your compiler command line or as part of the project options. This standalone + configuration has been tested for the following platforms and compilers: +
      +
    • + Microsoft Visual Studio 2012 +
      • +
    • + Linux with g++ 4.7 or 4.8 (requires -std=c++11) +
      • +
    • + Mac OS X with clang++ / Xcode 4.6 (requires -std=c++11 -stdlib=libc++) +
      • +
    +
    • +
  • + Fixed a regression (introduced in 1.10.0) where, on some platforms, errors + from async_connect were + not correctly propagated through to the completion handler. +
    • +
  • + Fixed a Windows-specific regression (introduced in 1.10.0) that occurs + when multiple threads are running an io_service. + When the bug occurs, the result of an asynchronous operation (error and + bytes tranferred) is incorrectly discarded and zero values used instead. + For TCP sockets this results in spurious end-of-file notifications. +
    • +
  • + Fixed a bug in handler tracking, where it was not correctly printing out + some handler IDs. +
    • +
  • + Fixed the comparison used to test for successful synchronous accept operations + so that it works correctly with unsigned socket descriptors. +
    • +
  • + Ensured the signal number is correctly passed to the completion handler + when starting an async_wait + on a signal that is already raised. +
    • +
  • + Suppressed a g++ 4.8+ warning about unused typedefs. +
    • +
  • + Enabled the move optimisation for handlers that use the default invocation + hook. +
    • +
  • + Clarified that programs must not issue overlapping async_write_at + operations. +
    • +
  • + Changed the Windows HANDLE + backend to treat ERROR_MORE_DATA + as a non-fatal error when returned by GetOverlappedResult + for a synchronous read. +
    • +
  • + Visual C++ language extensions use generic + as a keyword. Added a workaround that renames the namespace to cpp_generic when those language extensions + are in effect. +
    • +
  • + Fixed some asynchronous operations that missed out on getting async_result support in 1.10.0. In particular, + the buffered stream templates have been updated so that they adhere to + current handler patterns. +
    • +
  • + Enabled move support for Microsoft Visual Studio 2012. +
    • +
  • + Added use_future support + for Microsoft Visual Studio 2012. +
    • +
  • + Removed a use of std::min in the Windows IOCP backend to avoid + a dependency on the <algorithm> header. +
    • +
  • + Eliminated some unnecessary handler copies. +
    • +
  • + Fixed support for older versions of OpenSSL that do not provide the SSL_CTX_clear_options function. +
    • +
  • + Fixed various minor and cosmetic issues in code and documentation. +
    • +
+

+ + Asio + 1.10.0 +

+
    +
  • + Added new traits classes, handler_type + and async_result, that + allow the customisation of the return type of an initiating function. +
    • +
  • + Added the asio::spawn() + function, a high-level wrapper for running stackful coroutines, based on + the Boost.Coroutine library. The spawn() function enables programs to implement + asynchronous logic in a synchronous manner. For example: size_t n + = my_socket.async_read_some(my_buffer, yield);. For further information, see Stackful + Coroutines. +
    • +
  • + Added the asio::use_future special value, which provides + first-class support for returning a C++11 std::future + from an asynchronous operation's initiating function. For example: future<size_t> + = my_socket.async_read_some(my_buffer, asio::use_future);. For further information, see Futures. +
    • +
  • + Promoted the stackless coroutine class and macros to be part of Asio's + documented interface, rather than part of the HTTP server 4 example. For + further information, see Stackless + Coroutines. +
    • +
  • + Added a new handler hook called asio_handler_is_continuation. + Asynchronous operations may represent a continuation of the asynchronous + control flow associated with the current executing handler. The asio_handler_is_continuation hook can + be customised to return true + if this is the case, and Asio's implementation can use this knowledge to + optimise scheduling of the new handler. To cover common cases, Asio customises + the hook for strands, spawn() and composed asynchronous operations. +
    • +
  • + Added four new generic protocol classes, generic::datagram_protocol, + generic::raw_protocol, generic::seq_packet_protocol + and generic::stream_protocol, which implement the + Protocol type requirements, + but allow the user to specify the address family (e.g. AF_INET) + and protocol type (e.g. IPPROTO_TCP) + at runtime. For further information, see Support + for Other Protocols. +
    • +
  • + Added C++11 move constructors that allow the conversion of a socket (or + acceptor) into a more generic type. For example, an ip::tcp::socket + can be converted into a generic::stream_protocol::socket + via move construction. For further information, see Support + for Other Protocols. +
    • +
  • + Extended the basic_socket_acceptor<>'s accept() and async_accept() functions to allow a new connection to + be accepted directly into a socket of a more generic type. For example, + an ip::tcp::acceptor can be used to accept into a + generic::stream_protocol::socket object. For further information, + see Support for + Other Protocols. +
    • +
  • + Moved existing examples into a C++03-specific directory, and added a new + directory for C++11-specific examples. A limited subset of the C++03 examples + have been converted to their C++11 equivalents. +
    • +
  • + Add the ability to use Asio without Boost, for a limited set of platforms. + When using a C++11 compiler, most of Asio may now be used without a dependency + on Boost header files or libraries. To use Asio in this way, define ASIO_STANDALONE on your compiler command + line or as part of the project options. This standalone configuration has + currently been tested for the following platforms and compilers: +
      +
    • + Linux with g++ 4.7 (requires -std=c++11) +
      • +
    • + Mac OS X with clang++ / Xcode 4.6 (requires -std=c++11 -stdlib=libc++) +
      • +
    +
    • +
  • + Various SSL enhancements. Thanks go to Nick Jones, on whose work these + changes are based. +
      +
    • + Added support for SSL handshakes with re-use of data already read + from the wire. New overloads of the ssl::stream<> class's handshake() and async_handshake() functions have been added. These + accept a ConstBufferSequence + to be used as initial input to the ssl engine for the handshake procedure. +
      • +
    • + Added support for creation of TLSv1.1 and TLSv1.2 ssl::context + objects. +
      • +
    • + Added a set_verify_depth() function to the ssl::context + and ssl::stream<> + classes. +
      • +
    • + Added the ability to load SSL certificate and key data from memory + buffers. New functions, add_certificate_authority(), use_certificate(), use_certificate_chain(), use_private_key(), use_rsa_private_key() and use_tmp_dh(), have been added to the ssl::context class. +
      • +
    • + Changed ssl::context to automatically disable + SSL compression by default. To enable, use the new ssl::context::clear_options() + function, as in my_context.clear_options(ssl::context::no_compression). +
      • +
    +
    • +
  • + Fixed a potential deadlock in signal_set + implementation. +
    • +
  • + Fixed an error in acceptor example in documentation. +
    • +
  • + Fixed copy-paste errors in waitable timer documentation. +
    • +
  • + Added assertions to satisfy some code analysis tools. +
    • +
  • + Fixed a malformed #warning + directive. +
    • +
  • + Fixed a potential data race in the Linux epoll + implementation. +
    • +
  • + Fixed a Windows-specific bug, where certain operations might generate an + error_code with an invalid + (i.e. NULL) error_category. +
    • +
  • + Fixed basic_waitable_timer's + underlying implementation so that it can handle any time_point + value without overflowing the intermediate duration objects. +
    • +
  • + Fixed a problem with lost thread wakeups that can occur when making concurrent + calls to run() + and poll() + on the same io_service + object. +
    • +
  • + Fixed implementation of asynchronous connect operation so that it can cope + with spurious readiness notifications from the reactor. +
    • +
  • + Fixed a memory leak in the ssl::rfc2818_verification + class. +
    • +
  • + Added a mechanism for disabling automatic Winsock initialisation. See the + header file asio/detail/winsock_init.hpp for details. +
    • +
+

+ + Asio + 1.8.3 +

+
    +
  • + Fixed some 64-to-32-bit conversion warnings. +
    • +
  • + Fixed various small errors in documentation and comments. +
    • +
  • + Fixed an error in the example embedded in basic_socket::get_option's + documentation. +
    • +
  • + Changed to use long rather + than int for SSL_CTX options, + to match OpenSSL. +
    • +
  • + Changed to use _snwprintf + to address a compile error due to the changed swprintf + signature in recent versions of MinGW. +
    • +
  • + Fixed a deadlock that can occur on Windows when shutting down a pool of + io_service threads due + to running out of work. +
    • +
  • + Changed UNIX domain socket example to treat errors from accept + as non-fatal. +
    • +
  • + Added a small block recycling optimisation to improve default memory allocation + behaviour. +
    • +
+

+ + Asio + 1.8.2 +

+
    +
  • + Fixed an incompatibility between ip::tcp::iostream + and C++11. +
    • +
  • + Decorated GCC attribute names with underscores to prevent interaction with + user-defined macros. +
    • +
  • + Added missing #include <cctype>, needed for some versions of MinGW. +
    • +
  • + Changed to use gcc's atomic builtins on ARM CPUs, when + available. +
    • +
  • + Changed strand destruction to be a no-op, to allow strand objects to be + destroyed after their associated io_service + has been destroyed. +
    • +
  • + Added support for some newer versions of glibc which provide the epoll_create1() + function but always fail with ENOSYS. +
    • +
  • + Changed the SSL implementation to throw an exception if SSL engine initialisation + fails. +
    • +
  • + Fixed another regression in buffered_write_stream. +
    • +
  • + Implemented various minor performance improvements, primarily targeted + at Linux x86 and x86-64 platforms. +
    • +
+

+ + Asio + 1.8.1 +

+
    +
  • + Changed the epoll_reactor + backend to do lazy registration for EPOLLOUT + events. +
    • +
  • + Fixed the epoll_reactor + handling of out-of-band data, which was broken by an incomplete fix in + the last release. +
    • +
  • + Changed Asio's SSL wrapper to respect OpenSSL's OPENSSL_NO_ENGINE + feature test #define. +
    • +
  • + Fixed windows::object_handle so that it works with Windows + compilers that support C++11 move semantics (such as g++). +
    • +
  • + Improved the performance of strand rescheduling. +
    • +
  • + Added support for g++ 4.7 when compiling in C++11 mode. +
    • +
  • + Fixed a problem where signal_set + handlers were not being delivered when the io_service + was constructed with a concurrency_hint + of 1. +
    • +
+

+ + Asio + 1.8.0 +

+
    +
  • + 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. +
    • +
  • + Fixed a compile error on NetBSD. +
    • +
  • + Fixed deadlock on Mac OS X. +
    • +
  • + Fixed a regression in buffered_write_stream. +
    • +
  • + Fixed a non-paged pool "leak" on Windows when an io_service is repeatedly run without + anything to do. +
    • +
  • + Reverted earlier change to allow some speculative operations to be performed + without holding the lock, as it introduced a race condition in some multithreaded + scenarios. +
    • +
  • + Fixed a bug where the second buffer in an array of two buffers may be ignored + if the first buffer is empty. +
    • +
+

+ + Asio + 1.6.1 +

+
    +
  • + Implemented various performance improvements, including: +
      +
    • + Using thread-local operation queues in single-threaded use cases + (i.e. when concurrency_hint + is 1) to eliminate a lock/unlock pair. +
      • +
    • + Allowing some epoll_reactor + speculative operations to be performed without holding the lock. +
      • +
    • + Improving locality of reference by performing an epoll_reactor's + I/O operation immediately before the corresponding handler is called. + This also improves scalability across CPUs when multiple threads + are running the io_service. +
      • +
    • + Specialising asynchronous read and write operations for buffer sequences + that are arrays (boost::array + or std::array) of exactly two buffers. +
      • +
    +
    • +
  • + Fixed a compile error in the regex overload of async_read_until. +
    • +
  • + Fixed a Windows-specific compile error by explicitly specifying the signal() + function from the global namespace. +
    • +
  • + Changed the deadline_timer + implementation so that it does not read the clock unless the timer heap + is non-empty. +
    • +
  • + Changed the SSL stream's buffers' sizes so that they are large enough to + hold a complete TLS record. +
    • +
  • + Fixed the behaviour of the synchronous null_buffers + operations so that they obey the user's non-blocking setting. +
    • +
  • + Changed to set the size of the select fd_set + at runtime when using Windows. +
    • +
  • + Disabled an MSVC warning due to const qualifier being applied to function + type. +
    • +
  • + Fixed a crash that occurs when using the Intel C++ compiler. +
    • +
  • + Changed the initialisation of the OpenSSL library so that it supports all + available algorithms. +
    • +
  • + Fixed the SSL error mapping used when the session is gracefully shut down. +
    • +
  • + Added some latency test programs. +
    • +
  • + Clarified that a read operation ends when the buffer is full. +
    • +
  • + Fixed an exception safety issue in epoll_reactor + initialisation. +
    • +
  • + Made the number of strand implementations configurable by defining (BOOST_)ASIO_STRAND_IMPLEMENTATIONS + to the desired number. +
    • +
  • + Added support for a new (BOOST_)ASIO_ENABLE_SEQUENTIAL_STRAND_ALLOCATION + flag which switches the allocation of strand implementations to use a round-robin + approach rather than hashing. +
    • +
  • + Fixed potential strand starvation issue that can occur when strand.post() + is used. +
    • +
+

+ + Asio + 1.6.0 +

+
    +
  • + Improved support for C++0x move construction to further reduce copying + of handler objects. In certain designs it is possible to eliminate virtually + all copies. Move support is now enabled when compiling in -std=c++0x + mode on g++ 4.5 or higher. +
    • +
  • + Added build support for platforms that don't provide either of signal() + or sigaction(). +
    • +
  • + Changed to use C++0x variadic templates when they are available, rather + than generating function overloads using the Boost.Preprocessor library. +
    • +
  • + Ensured the value of errno + is preserved across the implementation's signal handler. +
    • +
  • + On Windows, ensured the count of outstanding work is decremented for abandoned + operations (i.e. operations that are being cleaned up within the io_service destructor). +
    • +
  • + Fixed behaviour of zero-length reads and writes in the new SSL implementation. +
    • +
  • + Added support for building with OpenSSL 1.0 when OPENSSL_NO_SSL2 + is defined. +
    • +
  • + Changed most examples to treat a failure by an accept operation as non-fatal. +
    • +
  • + Fixed an error in the tick_count_timer example by making + the duration type signed. Previously, a wait on an already-passed deadline + would not return for a very long time. +
    • +
+

+ + Asio + 1.5.3 +

+
    +
  • + Added a new, completely rewritten SSL implementation. The new implementation + compiles faster, shows substantially improved performance, and supports + custom memory allocation and handler invocation. It includes new API features + such as certificate verification callbacks and has improved error reporting. + The new implementation is source-compatible with the old for most uses. + However, if necessary, the old implementation may still be used by defining + (BOOST_)ASIO_ENABLE_OLD_SSL. +
    • +
  • + Added new asio::buffer() + overloads for std::array, when available. The support is + automatically enabled when compiling in -std=c++0x mode + on g++ 4.3 or higher, or when using MSVC 10. The support may be explicitly + enabled by defining (BOOST_)ASIO_HAS_STD_ARRAY, + or disabled by defining (BOOST_)ASIO_DISABLE_STD_ARRAY. +
    • +
  • + Changed to use the C++0x standard library templates array, + shared_ptr, weak_ptr and atomic + when they are available, rather than the Boost equivalents. +
    • +
  • + Support for std::error_code and std::system_error + is no longer enabled by default for g++ 4.5, as that compiler's standard + library does not implement std::system_error::what() correctly. +
    • +
+

+ + Asio + 1.5.2 +

+
    +
  • + Added support for C++0x move construction and assignment to sockets, serial + ports, POSIX descriptors and Windows handles. +
    • +
  • + Added support for the fork() system call. Programs that use fork() + must call io_service.notify_fork() + at the appropriate times. Two new examples have been added showing how + to use this feature. +
    • +
  • + Cleaned up the handling of errors reported by the close() system call. In particular, assume that + most operating systems won't have close() fail with EWOULDBLOCK, + but if it does then set the blocking mode and restart the call. If any + other error occurs, assume the descriptor is closed. +
    • +
  • + The kqueue flag EV_ONESHOT + seems to cause problems on some versions of Mac OS X, with the io_service destructor getting stuck inside + the close() + system call. Changed the kqueue backend to use EV_CLEAR + instead. +
    • +
  • + Changed exception reporting to include the function name in exception + what() + messages. +
    • +
  • + Fixed an insufficient initialisers warning with MinGW. +
    • +
  • + Changed the shutdown_service() member functions to be private. +
    • +
  • + Added archetypes for testing socket option functions. +
    • +
  • + Added a missing lock in signal_set_service::cancel(). +
    • +
  • + Fixed a copy/paste error in SignalHandler + example. +
    • +
  • + Added the inclusion of the signal header to signal_set_service.hpp + so that constants like NSIG + may be used. +
    • +
  • + Changed the signal_set_service + implementation so that it doesn't assume that SIGRTMAX + is a compile-time constant. +
    • +
  • + Changed the Boost.Asio examples so that they don't use Boost.Thread's convenience + header. Use the header file that is specifically for the boost::thread + class instead. +
    • +
+

+ + Asio + 1.5.1 +

+
    +
  • + Added support for signal handling, using a new class called signal_set. Programs may add one or more + signals to the set, and then perform an async_wait() operation. The specified handler will + be called when one of the signals occurs. The same signal number may registered + with multiple signal_set + objects, however the signal number must be used only with Asio. +
    • +
  • + Added handler tracking, a new debugging aid. When enabled by defining + (BOOST_)ASIO_ENABLE_HANDLER_TRACKING, + Asio writes debugging output to the standard error stream. The output records + asynchronous operations and the relationships between their handlers. It + may be post-processed using the included handlerviz.pl + tool to create a visual representation of the handlers (requires GraphViz). +
    • +
  • + Fixed a bug in asio::streambuf where the consume() function did not always update the internal + buffer pointers correctly. The problem may occur when the asio::streambuf is filled with data using the + standard C++ member functions such as sputn(). (Note: the problem does not manifest + when the streambuf is populated by the Asio free functions read(), + async_read(), + read_until() + or async_read_until().) +
    • +
  • + Fixed a bug on kqueue-based platforms, where reactor read operations that + return false from their perform() function are not correctly re-registered + with kqueue. +
    • +
  • + Support for std::error_code and std::system_error + is no longer enabled by default for MSVC10, as that compiler's standard + library does not implement std::system_error::what() correctly. +
    • +
  • + Modified the buffers_iterator<> and ip::basic_resolver_iterator + classes so that the value_type typedefs are non-const byte types. +
    • +
+

+ + Asio + 1.5.0 +

+
    +
  • + Added support for timeouts on socket iostreams, such as ip::tcp::iostream. + A timeout is set by calling expires_at() or expires_from_now() to establish a deadline. Any socket operations + which occur past the deadline will put the iostream into a bad state. +
    • +
  • + Added a new error() + member function to socket iostreams, for retrieving the error code from + the most recent system call. +
    • +
  • + Added a new basic_deadline_timer::cancel_one() function. This function lets you cancel + a single waiting handler on a timer. Handlers are cancelled in FIFO order. +
    • +
  • + Added a new transfer_exactly() completion condition. This can be used + to send or receive a specified number of bytes even if the total size of + the buffer (or buffer sequence) is larger. +
    • +
  • + Added new free functions connect() and async_connect(). These operations try each endpoint in + a list until the socket is successfully connected. +
    • +
  • + Extended the buffer_size() function so that it works for buffer + sequences in addition to individual buffers. +
    • +
  • + Added a new buffer_copy() function that can be used to copy the + raw bytes between individual buffers and buffer sequences. +
    • +
  • + Added new non-throwing overloads of read(), read_at(), write() and write_at() that do not require a completion condition. +
    • +
  • + Added friendlier compiler errors for when a completion handler does not + meet the necessary type requirements. When C++0x is available (currently + supported for g++ 4.5 or later, and MSVC 10), static_assert + is also used to generate an informative error message. This checking may + be disabled by defining (BOOST_)ASIO_DISABLE_HANDLER_TYPE_REQUIREMENTS. +
    • +
  • + Added support for using std::error_code + and std::system_error, when available. The support + is automatically enabled when compiling in -std=c++0x + mode on g++ 4.5 or higher, or when using MSVC 10. The support may be explicitly + enabled by defining ASIO_HAS_STD_SYSTEM_ERROR, + or disabled by defining ASIO_DISABLE_STD_SYSTEM_ERROR. + (Available in non-Boost version of Asio only.) +
    • +
  • + Made the is_loopback(), + is_unspecified() + and is_multicast() + functions consistently available across the ip::address, + ip::address_v4 and ip::address_v6 + classes. +
    • +
  • + Added new non_blocking() functions for managing the non-blocking + behaviour of a socket or descriptor. The io_control() commands named non_blocking_io + are now deprecated in favour of these new functions. +
    • +
  • + Added new native_non_blocking() functions for managing the non-blocking + mode of the underlying socket or descriptor. These functions are intended + to allow the encapsulation of arbitrary non-blocking system calls as asynchronous + operations, in a way that is transparent to the user of the socket object. + The functions have no effect on the behaviour of the synchronous operations + of the socket or descriptor. +
    • +
  • + Added the io_control() + member function for socket acceptors. +
    • +
  • + For consistency with the C++0x standard library, deprecated the native_type typedefs in favour of native_handle_type, and the native() + member functions in favour of native_handle(). +
    • +
  • + Added a release() + member function to posix descriptors. This function releases ownership + of the underlying native descriptor to the caller. +
    • +
  • + Added support for sequenced packet sockets (SOCK_SEQPACKET). +
    • +
  • + Added a new io_service::stopped() function that can be used to determine + whether the io_service + has stopped (i.e. a reset() call is needed prior to any further calls + to run(), + run_one(), + poll() + or poll_one()). +
    • +
  • + Reduced the copying of handler function objects. +
    • +
  • + Added support for C++0x move construction to further reduce copying of + handler objects. Move support is enabled when compiling in -std=c++0x + mode on g++ 4.5 or higher, or when using MSVC10. +
    • +
  • + Removed the dependency on OS-provided macros for the well-known IPv4 and + IPv6 addresses. This should eliminate the annoying "missing braces + around initializer" warnings. +
    • +
  • + Reduced the size of ip::basic_endpoint<> objects (such as ip::tcp::endpoint and ip::udp::endpoint). +
    • +
  • + Changed the reactor backends to assume that any descriptors or sockets + added using assign() + may have been dup()-ed, + and so require explicit deregistration from the reactor. +
    • +
  • + Changed the SSL error category to return error strings from the OpenSSL + library. +
    • +
  • + Changed the separate compilation support such that, to use Asio's SSL capabilities, + you should also include 'asio/ssl/impl/src.hpp` in one source file in your + program. +
    • +
  • + Removed the deprecated member functions named io_service(). The get_io_service() member functions should be used instead. +
    • +
  • + Removed the deprecated typedefs resolver_query + and resolver_iterator from + the ip::tcp, ip::udp + and ip::icmp classes. +
    • +
  • + Fixed a compile error on some versions of g++ due to anonymous enums. +
    • +
  • + Added an explicit cast to the FIONBIO + constant to int to suppress a compiler warning on some platforms. +
    • +
  • + Fixed warnings reported by g++'s -Wshadow compiler option. +
    • +
+

+ + Asio + 1.4.8 +

+
    +
  • + Fixed an integer overflow problem that occurs when ip::address_v4::broadcast() is used on 64-bit platforms. +
    • +
  • + Fixed a problem on older Linux kernels (where epoll is used without timerfd support) that prevents timely + delivery of deadline_timer + handlers, after the program has been running for some time. +
    • +
+

+ + Asio + 1.4.7 +

+
    +
  • + Fixed a problem on kqueue-based platforms where a deadline_timer + may never fire if the io_service + is running in a background thread. +
    • +
  • + Fixed a const-correctness issue that prevented valid uses of has_service<> + from compiling. +
    • +
  • + Fixed MinGW cross-compilation. +
    • +
  • + Removed dependency on deprecated Boost.System functions (Boost.Asio only). +
    • +
  • + Ensured close()/closesocket() + failures are correctly propagated. +
    • +
  • + Added a check for errors returned by InitializeCriticalSectionAndSpinCount. +
    • +
  • + Added support for hardware flow control on QNX. +
    • +
  • + Always use pselect() + on HP-UX, if it is available. +
    • +
  • + Ensured handler arguments are passed as lvalues. +
    • +
  • + Fixed Windows build when thread support is disabled. +
    • +
  • + Fixed a Windows-specific problem where deadline_timer + objects with expiry times set more than 5 minutes in the future may never + expire. +
    • +
  • + Fixed the resolver backend on BSD platforms so that an empty service name + resolves to port number 0, + as per the documentation. +
    • +
  • + Fixed read operations so that they do not accept buffer sequences of type + const_buffers_1. +
    • +
  • + Redefined Protocol and + id to avoid clashing with + Objective-C++ keywords. +
    • +
  • + Fixed a vector reallocation + performance issue that can occur when there are many active deadline_timer objects. +
    • +
  • + Fixed the kqueue backend so that it compiles on NetBSD. +
    • +
  • + Fixed the socket io_control() implementation on 64-bit Mac OS X and + BSD platforms. +
    • +
  • + Fixed a Windows-specific problem where failures from accept() are incorrectly treated as successes. +
    • +
  • + Deprecated the separate compilation header asio/impl/src.cpp + in favour of asio/impl/src.hpp. +
    • +
+

+ + Asio + 1.4.6 +

+
    +
  • + Reduced compile times. (Note that some programs may need to add additional + #includes, e.g. if the + program uses boost::array but does not explicitly include <boost/array.hpp>.) +
    • +
  • + Reduced the size of generated code. +
    • +
  • + Refactored deadline_timer + implementation to improve performance. +
    • +
  • + Improved multiprocessor scalability on Windows by using a dedicated hidden + thread to wait for timers. +
    • +
  • + Improved performance of asio::streambuf + with async_read() + and async_read_until(). + These read operations now use the existing capacity of the streambuf when reading, rather than limiting + the read to 512 bytes. +
    • +
  • + Added optional separate compilation. To enable, include asio/impl/src.cpp + in one source file in a program, then build the program with (BOOST_)ASIO_SEPARATE_COMPILATION + defined in the project/compiler settings. Alternatively, (BOOST_)ASIO_DYN_LINK + may be defined to build a separately-compiled Asio as part of a shared + library. +
    • +
  • + Added new macro (BOOST_)ASIO_DISABLE_FENCED_BLOCK + to permit the disabling of memory fences around completion handlers, even + if thread support is enabled. +
    • +
  • + Reworked timeout examples to better illustrate typical use cases. +
    • +
  • + Ensured that handler arguments are passed as const types. +
    • +
  • + Fixed incorrect parameter order in null_buffers + variant of async_send_to. +
    • +
  • + Ensured unsigned char is used with isdigit + in getaddrinfo emulation. +
    • +
  • + Fixed handling of very small but non-zero timeouts. +
    • +
  • + Fixed crash that occurred when an empty buffer sequence was passed to a + composed read or write operation. +
    • +
  • + Added missing operator+ overload in buffers_iterator. +
    • +
  • + Implemented cancellation of null_buffers + operations on Windows. +
    • +
+

+ + Asio + 1.4.5 +

+
    +
  • + Improved performance. +
    • +
  • + Reduced compile times. +
    • +
  • + Reduced the size of generated code. +
    • +
  • + Extended the guarantee that background threads don't call user code to + all asynchronous operations. +
    • +
  • + Changed to use edge-triggered epoll on Linux. +
    • +
  • + Changed to use timerfd + for dispatching timers on Linux, when available. +
    • +
  • + Changed to use one-shot notifications with kqueue on Mac OS X and BSD platforms. +
    • +
  • + Added a bitmask type ip::resolver_query_base::flags + as per the TR2 proposal. This type prevents implicit conversion from int to flags, + allowing the compiler to catch cases where users incorrectly pass a numeric + port number as the service name. +
    • +
  • + Added #define NOMINMAX + for all Windows compilers. Users can define (BOOST_)ASIO_NO_NOMINMAX to suppress this definition. +
    • +
  • + Fixed a bug where 0-byte asynchronous reads were incorrectly passing an + error::eof result to the completion handler. +
    • +
  • + Changed the io_control() member functions to always call ioctl on the underlying descriptor when + modifying blocking mode. +
    • +
  • + Changed the resolver implementation so that it no longer requires the typedefs + InternetProtocol::resolver_query and InternetProtocol::resolver_iterator, + as neither typedef is part of the documented InternetProtocol + requirements. The corresponding typedefs in the ip::tcp, + ip::udp and ip::icmp + classes have been deprecated. +
    • +
  • + Fixed out-of-band handling for reactors not based on select(). +
    • +
  • + Added new (BOOST_)ASIO_DISABLE_THREADS + macro that allows Asio's threading support to be independently disabled. +
    • +
  • + Minor documentation improvements. +
    • +
+

+ + Asio + 1.4.4 +

+
    +
  • + Added a new HTTP Server 4 example illustrating the use of stackless coroutines + with Asio. +
    • +
  • + Changed handler allocation and invocation to use boost::addressof + to get the address of handler objects, rather than applying operator& + directly. +
    • +
  • + Restricted MSVC buffer debugging workaround to 2008, as it causes a crash + with 2010 beta 2. +
    • +
  • + Fixed a problem with the lifetime of handler memory, where Windows needs + the OVERLAPPED structure + to be valid until both the initiating function call has returned and the + completion packet has been delivered. +
    • +
  • + Don't block signals while performing system calls, but instead restart + the calls if they are interrupted. +
    • +
  • + Documented the guarantee made by strand objects with respect to order of + handler invocation. +
    • +
  • + Changed strands to use a pool of implementations, to make copying of strands + cheaper. +
    • +
  • + Ensured that kqueue support is enabled for BSD platforms. +
    • +
  • + Added a boost_ prefix to + the extern "C" + thread entry point function. +
    • +
  • + In getaddrinfo emulation, + only check the socket type (SOCK_STREAM + or SOCK_DGRAM) if a service + name has been specified. This should allow the emulation to work with raw + sockets. +
    • +
  • + Added a workaround for some broken Windows firewalls that make a socket + appear bound to 0.0.0.0 when it is in fact bound to 127.0.0.1. +
    • +
  • + Applied a fix for reported excessive CPU usage under Solaris. +
    • +
  • + Added some support for platforms that use older compilers such as g++ 2.95. +
    • +
+

+ + Asio + 1.4.3 +

+
    +
  • + Added a new ping example to illustrate the use of ICMP sockets. +
    • +
  • + Changed the buffered*_stream<> + templates to treat 0-byte reads and writes as no-ops, to comply with the + documented type requirements for SyncReadStream, + AsyncReadStream, SyncWriteStream and AsyncWriteStream. +
    • +
  • + Changed some instances of the throw + keyword to boost::throw_exception() + to allow Asio to be used when exception support is disabled. Note that + the SSL wrappers still require exception support. +
    • +
  • + Made Asio compatible with the OpenSSL 1.0 beta. +
    • +
  • + Eliminated a redundant system call in the Solaris /dev/poll backend. +
    • +
  • + Fixed a bug in resizing of the bucket array in the internal hash maps. +
    • +
  • + Ensured correct propagation of the error code when a synchronous accept + fails. +
    • +
  • + Ensured correct propagation of the error code when a synchronous read or + write on a Windows HANDLE + fails. +
    • +
  • + Fixed failures reported when _GLIBCXX_DEBUG + is defined. +
    • +
  • + Fixed custom memory allocation support for timers. +
    • +
  • + Tidied up various warnings reported by g++. +
    • +
  • + Various documentation improvements, including more obvious hyperlinks to + function overloads, header file information, examples for the handler type + requirements, and adding enum values to the index. +
    • +
+

+ + Asio + 1.4.2 +

+
    +
  • + Implement automatic resizing of the bucket array in the internal hash maps. + This is to improve performance for very large numbers of asynchronous operations + and also to reduce memory usage for very small numbers. A new macro (BOOST_)ASIO_HASH_MAP_BUCKETS + may be used to tweak the sizes used for the bucket arrays. (N.B. this feature + introduced a bug which was fixed in Asio 1.4.3 / Boost 1.40.) +
    • +
  • + Add performance optimisation for the Windows IOCP backend for when no timers + are used. +
    • +
  • + Prevent locale settings from affecting formatting of TCP and UDP endpoints. +
    • +
  • + Fix a memory leak that occurred when an asynchronous SSL operation's completion + handler threw an exception. +
    • +
  • + Fix the implementation of io_control() so that it adheres to the documented + type requirements for IoControlCommand. +
    • +
  • + Fix incompatibility between Asio and ncurses.h. +
    • +
  • + On Windows, specifically handle the case when an overlapped ReadFile call fails with ERROR_MORE_DATA. This enables a hack + where a windows::stream_handle can be used with a message-oriented + named pipe. +
    • +
  • + Fix system call wrappers to always clear the error on success, as POSIX + allows successful system calls to modify errno. +
    • +
  • + Don't include termios.h if (BOOST_)ASIO_DISABLE_SERIAL_PORT is defined. +
    • +
  • + Cleaned up some more MSVC level 4 warnings. +
    • +
  • + Various documentation fixes. +
    • +
+

+ + Asio + 1.4.1 +

+
    +
  • + Improved compatibility with some Windows firewall software. +
    • +
  • + Ensured arguments to windows::overlapped_ptr::complete() are correctly passed to the completion + handler. +
    • +
  • + Fixed a link problem and multicast failure on QNX. +
    • +
  • + Fixed a compile error in SSL support on MinGW / g++ 3.4.5. +
    • +
  • + Drop back to using a pipe for notification if eventfd is not available + at runtime on Linux. +
    • +
  • + Various minor bug and documentation fixes. +
    • +
+

+ + Asio + 1.4.0 +

+
    +
  • + Enhanced CompletionCondition concept with the signature size_t + CompletionCondition(error_code ec, size_t total), + where the return value indicates the maximum number of bytes to be transferred + on the next read or write operation. (The old CompletionCondition signature + is still supported for backwards compatibility). +
    • +
  • + New windows::overlapped_ptr class to allow arbitrary + overlapped I/O functions (such as TransmitFile) + to be used with Asio. +
    • +
  • + On recent versions of Linux, an eventfd + descriptor is now used (rather than a pipe) to interrupt a blocked select/epoll + reactor. +
    • +
  • + Added const overloads of lowest_layer(). +
    • +
  • + Synchronous read, write, accept and connect operations are now thread safe + (meaning that it is now permitted to perform concurrent synchronous operations + on an individual socket, if supported by the OS). +
    • +
  • + Reactor-based io_service + implementations now use lazy initialisation to reduce the memory usage + of an io_service object + used only as a message queue. +
    • +
+

+ + Asio + 1.2.0 +

+
    +
  • + Added support for serial ports. +
    • +
  • + Added support for UNIX domain sockets. +
    • +
  • + Added support for raw sockets and ICMP. +
    • +
  • + Added wrappers for POSIX stream-oriented file descriptors (excluding regular + files). +
    • +
  • + Added wrappers for Windows stream-oriented HANDLEs + such as named pipes (requires HANDLEs + that work with I/O completion ports). +
    • +
  • + Added wrappers for Windows random-access HANDLEs + such as files (requires HANDLEs + that work with I/O completion ports). +
    • +
  • + Added support for reactor-style operations (i.e. they report readiness + but perform no I/O) using a new null_buffers + type. +
    • +
  • + Added an iterator type for bytewise traversal of buffer sequences. +
    • +
  • + Added new read_until() + and async_read_until() + overloads that take a user-defined function object for locating message + boundaries. +
    • +
  • + Added an experimental two-lock queue (enabled by defining (BOOST_)ASIO_ENABLE_TWO_LOCK_QUEUE) + that may provide better io_service + scalability across many processors. +
    • +
  • + Various fixes, performance improvements, and more complete coverage of + the custom memory allocation support. +
    • +
+

+ + Asio + 1.0.0 +

+

+ First stable release of Asio. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/index.html b/Packages/asio-1.36.0/doc/asio/index.html new file mode 100644 index 0000000..a8e6181 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/index.html @@ -0,0 +1,7653 @@ + + + + + + + + + + + + +
asio C++ library
+
+
+PrevUpHome +
+
+
+
+

+Index

+
+
+

Symbols

+
+
~allocator_binder
+
allocator_binder, allocator_binder::~allocator_binder +
+
~allocator_impl_base
+
execution_context::allocator_impl_base, execution_context::allocator_impl_base::~allocator_impl_base +
+
~any_completion_executor
+
any_completion_executor, any_completion_executor::~any_completion_executor +
+
~any_completion_handler
+
any_completion_handler, any_completion_handler::~any_completion_handler +
+
~any_executor
+
execution::any_executor, execution::any_executor::~any_executor +
+
~any_io_executor
+
any_io_executor, any_io_executor::~any_io_executor +
+
~auto_allocator_ptr
+
execution_context::auto_allocator_ptr, execution_context::auto_allocator_ptr::~auto_allocator_ptr +
+
~awaitable
+
awaitable, awaitable::~awaitable +
+
~bad_address_cast
+
ip::bad_address_cast, ip::bad_address_cast::~bad_address_cast +
+
~basic_channel
+
experimental::basic_channel, experimental::basic_channel::~basic_channel +
+
~basic_concurrent_channel
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::~basic_concurrent_channel +
+
~basic_datagram_socket
+
basic_datagram_socket, basic_datagram_socket::~basic_datagram_socket +
+
~basic_deadline_timer
+
basic_deadline_timer, basic_deadline_timer::~basic_deadline_timer +
+
~basic_descriptor
+
posix::basic_descriptor, posix::basic_descriptor::~basic_descriptor +
+
~basic_executor_type
+
+
io_context::basic_executor_type, io_context::basic_executor_type::~basic_executor_type +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::~basic_executor_type +
+
+
~basic_file
+
basic_file, basic_file::~basic_file +
+
~basic_io_object
+
+
basic_io_object, basic_io_object::~basic_io_object +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::~basic_io_object +
+
+
~basic_overlapped_handle
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::~basic_overlapped_handle +
+
~basic_random_access_file
+
basic_random_access_file, basic_random_access_file::~basic_random_access_file +
+
~basic_raw_socket
+
basic_raw_socket, basic_raw_socket::~basic_raw_socket +
+
~basic_readable_pipe
+
basic_readable_pipe, basic_readable_pipe::~basic_readable_pipe +
+
~basic_resolver
+
ip::basic_resolver, ip::basic_resolver::~basic_resolver +
+
~basic_seq_packet_socket
+
basic_seq_packet_socket, basic_seq_packet_socket::~basic_seq_packet_socket +
+
~basic_serial_port
+
basic_serial_port, basic_serial_port::~basic_serial_port +
+
~basic_signal_set
+
basic_signal_set, basic_signal_set::~basic_signal_set +
+
~basic_socket
+
basic_socket, basic_socket::~basic_socket +
+
~basic_socket_acceptor
+
basic_socket_acceptor, basic_socket_acceptor::~basic_socket_acceptor +
+
~basic_socket_streambuf
+
basic_socket_streambuf, basic_socket_streambuf::~basic_socket_streambuf +
+
~basic_stream_file
+
basic_stream_file, basic_stream_file::~basic_stream_file +
+
~basic_stream_socket
+
basic_stream_socket, basic_stream_socket::~basic_stream_socket +
+
~basic_waitable_timer
+
basic_waitable_timer, basic_waitable_timer::~basic_waitable_timer +
+
~basic_writable_pipe
+
basic_writable_pipe, basic_writable_pipe::~basic_writable_pipe +
+
~buffer_registration
+
buffer_registration, buffer_registration::~buffer_registration +
+
~cancellation_signal
+
cancellation_signal, cancellation_signal::~cancellation_signal +
+
~cancellation_slot_binder
+
cancellation_slot_binder, cancellation_slot_binder::~cancellation_slot_binder +
+
~context
+
ssl::context, ssl::context::~context +
+
~context_base
+
ssl::context_base, ssl::context_base::~context_base +
+
~coro
+
experimental::coro, experimental::coro::~coro +
+
~descriptor_base
+
posix::descriptor_base, posix::descriptor_base::~descriptor_base +
+
~execution_context
+
execution_context, execution_context::~execution_context +
+
~executor
+
executor, executor::~executor +
+
~executor_binder
+
executor_binder, executor_binder::~executor_binder +
+
~executor_work_guard
+
executor_work_guard, executor_work_guard::~executor_work_guard +
+
~file_base
+
file_base, file_base::~file_base +
+
~immediate_executor_binder
+
immediate_executor_binder, immediate_executor_binder::~immediate_executor_binder +
+
~io_context
+
io_context, io_context::~io_context +
+
~overlapped_ptr
+
windows::overlapped_ptr, windows::overlapped_ptr::~overlapped_ptr +
+
~promise
+
experimental::promise, experimental::promise::~promise +
+
~resolver_base
+
ip::resolver_base, ip::resolver_base::~resolver_base +
+
~resolver_query_base
+
ip::resolver_query_base, ip::resolver_query_base::~resolver_query_base +
+
~serial_port_base
+
serial_port_base, serial_port_base::~serial_port_base +
+
~service
+
+
execution_context::service, execution_context::service::~service +
+
io_context::service, io_context::service::~service +
+
+
~service_maker
+
execution_context::service_maker, execution_context::service_maker::~service_maker +
+
~signal_set_base
+
signal_set_base, signal_set_base::~signal_set_base +
+
~socket_base
+
socket_base, socket_base::~socket_base +
+
~strand
+
+
io_context::strand, io_context::strand::~strand +
+
strand, strand::~strand +
+
+
~stream
+
ssl::stream, ssl::stream::~stream +
+
~stream_base
+
ssl::stream_base, ssl::stream_base::~stream_base +
+
~system_context
+
system_context, system_context::~system_context +
+
~thread
+
thread, thread::~thread +
+
~thread_pool
+
thread_pool, thread_pool::~thread_pool +
+
+
+
+

A

+
+
accept
+
basic_socket_acceptor, basic_socket_acceptor::accept +
+
acceptor
+
+
ip::tcp, ip::tcp::acceptor +
+
local::seq_packet_protocol, local::seq_packet_protocol::acceptor +
+
local::stream_protocol, local::stream_protocol::acceptor +
+
+
access_denied
+
error::basic_errors, error::basic_errors +
+
add
+
+
basic_signal_set, basic_signal_set::add +
+
time_traits< boost::posix_time::ptime + >, time_traits< + boost::posix_time::ptime >::add +
+
+
address
+
+
ip::address, ip::address::address +
+
ip::basic_endpoint, ip::basic_endpoint::address +
+
ip::network_v4, ip::network_v4::address +
+
ip::network_v6, ip::network_v6::address +
+
+
address_configured
+
+
ip::basic_resolver, ip::basic_resolver::address_configured +
+
ip::basic_resolver_query, ip::basic_resolver_query::address_configured +
+
ip::resolver_base, ip::resolver_base::address_configured +
+
ip::resolver_query_base, ip::resolver_query_base::address_configured +
+
+
address_family_not_supported
+
error::basic_errors, error::basic_errors +
+
address_in_use
+
error::basic_errors, error::basic_errors +
+
address_v4
+
ip::address_v4, ip::address_v4::address_v4 +
+
address_v6
+
ip::address_v6, ip::address_v6::address_v6 +
+
add_certificate_authority
+
ssl::context, ssl::context::add_certificate_authority +
+
add_service
+
execution_context, execution_context::add_service +
+
add_verify_path
+
ssl::context, ssl::context::add_verify_path +
+
all
+
cancellation_type, cancellation_type +
+
allocate
+
+
any_completion_handler_allocator, any_completion_handler_allocator::allocate +
+
execution_context::allocator, execution_context::allocator::allocate +
+
execution_context::allocator_impl, execution_context::allocator_impl::allocate +
+
execution_context::allocator_impl_base, execution_context::allocator_impl_base::allocate +
+
recycling_allocator, recycling_allocator::allocate +
+
+
allocator
+
+
execution_context::allocator, execution_context::allocator::allocator +
+
execution_context::allocator< + void >, execution_context::allocator< + void >::allocator +
+
+
allocator_
+
partial_allocator_binder, partial_allocator_binder::allocator_ +
+
allocator_binder, allocator_binder +
+
allocator_binder, allocator_binder::allocator_binder +
+
allocator_impl
+
execution_context::allocator_impl, execution_context::allocator_impl::allocator_impl +
+
allocator_t
+
execution::allocator_t, execution::allocator_t::allocator_t +
+
allocator_type
+
+
allocator_binder, allocator_binder::allocator_type +
+
any_completion_handler, any_completion_handler::allocator_type +
+
buffer_registration, buffer_registration::allocator_type +
+
experimental::coro, experimental::coro::allocator_type +
+
experimental::use_coro_t, experimental::use_coro_t::allocator_type +
+
experimental::use_promise_t, experimental::use_promise_t::allocator_type +
+
use_future_t, use_future_t::allocator_type +
+
+
allowed
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::allowed +
+
allowed_t
+
execution::blocking_adaptation_t::allowed_t, execution::blocking_adaptation_t::allowed_t::allowed_t +
+
all_matching
+
+
ip::basic_resolver, ip::basic_resolver::all_matching +
+
ip::basic_resolver_query, ip::basic_resolver_query::all_matching +
+
ip::resolver_base, ip::resolver_base::all_matching +
+
ip::resolver_query_base, ip::resolver_query_base::all_matching +
+
+
already_connected
+
error::basic_errors, error::basic_errors +
+
already_open
+
error::misc_errors, error::misc_errors +
+
already_started
+
error::basic_errors, error::basic_errors +
+
always
+
execution::blocking_t, execution::blocking_t::always +
+
always_t
+
execution::blocking_t::always_t, execution::blocking_t::always_t::always_t +
+
any
+
+
ip::address_v4, ip::address_v4::any +
+
ip::address_v6, ip::address_v6::any +
+
+
any_completion_executor, any_completion_executor +
+
any_completion_executor, any_completion_executor::any_completion_executor +
+
any_completion_handler, any_completion_handler +
+
any_completion_handler, any_completion_handler::any_completion_handler +
+
any_completion_handler_allocator, any_completion_handler_allocator +
+
+
any_completion_handler_allocator, any_completion_handler_allocator::any_completion_handler_allocator +
+
any_completion_handler_allocator< + void, Signatures... >, any_completion_handler_allocator< + void, Signatures... >::any_completion_handler_allocator +
+
+
any_completion_handler_allocator::rebind, any_completion_handler_allocator::rebind +
+
any_completion_handler_allocator< + void, Signatures... >, any_completion_handler_allocator< + void, Signatures... > +
+
any_completion_handler_allocator< + void, Signatures... >::rebind, any_completion_handler_allocator< + void, Signatures... >::rebind +
+
any_executor
+
execution::any_executor, execution::any_executor::any_executor +
+
any_io_executor, any_io_executor +
+
any_io_executor, any_io_executor::any_io_executor +
+
append, append +
+
+
basic_file, basic_file::append +
+
basic_random_access_file, basic_random_access_file::append +
+
basic_stream_file, basic_stream_file::append +
+
file_base, file_base::append +
+
+
append_t, append_t +
+
append_t, append_t::append_t +
+
argument_type
+
+
allocator_binder, allocator_binder::argument_type +
+
cancellation_slot_binder, cancellation_slot_binder::argument_type +
+
executor_binder, executor_binder::argument_type +
+
immediate_executor_binder, immediate_executor_binder::argument_type +
+
+
asio_handler_is_continuation, asio_handler_is_continuation +
+
asn1
+
+
ssl::context, ssl::context::file_format +
+
ssl::context_base, ssl::context_base::file_format +
+
+
assign
+
+
basic_datagram_socket, basic_datagram_socket::assign +
+
basic_file, basic_file::assign +
+
basic_random_access_file, basic_random_access_file::assign +
+
basic_raw_socket, basic_raw_socket::assign +
+
basic_readable_pipe, basic_readable_pipe::assign +
+
basic_seq_packet_socket, basic_seq_packet_socket::assign +
+
basic_serial_port, basic_serial_port::assign +
+
basic_socket, basic_socket::assign +
+
basic_socket_acceptor, basic_socket_acceptor::assign +
+
basic_stream_file, basic_stream_file::assign +
+
basic_stream_socket, basic_stream_socket::assign +
+
basic_writable_pipe, basic_writable_pipe::assign +
+
cancellation_slot, cancellation_slot::assign +
+
posix::basic_descriptor, posix::basic_descriptor::assign +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::assign +
+
windows::basic_object_handle, windows::basic_object_handle::assign +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::assign +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::assign +
+
windows::basic_stream_handle, windows::basic_stream_handle::assign +
+
+
associated_allocator, associated_allocator +
+
associated_allocator< + reference_wrapper< T >, Allocator >, associated_allocator< + reference_wrapper< T >, Allocator > +
+
associated_allocator_t, associated_allocator_t +
+
associated_cancellation_slot, associated_cancellation_slot +
+
associated_cancellation_slot< + reference_wrapper< T >, CancellationSlot >, associated_cancellation_slot< + reference_wrapper< T >, CancellationSlot > +
+
associated_cancellation_slot_t, associated_cancellation_slot_t +
+
associated_executor, associated_executor +
+
associated_executor< + reference_wrapper< T >, Executor >, associated_executor< + reference_wrapper< T >, Executor > +
+
associated_executor_t, associated_executor_t +
+
associated_immediate_executor, associated_immediate_executor +
+
associated_immediate_executor< + reference_wrapper< T >, Executor >, associated_immediate_executor< + reference_wrapper< T >, Executor > +
+
associated_immediate_executor_t, associated_immediate_executor_t +
+
associator, associator +
+
async_accept
+
basic_socket_acceptor, basic_socket_acceptor::async_accept +
+
async_completion, async_completion +
+
async_completion, async_completion::async_completion +
+
async_compose, async_compose +
+
async_connect, async_connect +
+
+
basic_datagram_socket, basic_datagram_socket::async_connect +
+
basic_raw_socket, basic_raw_socket::async_connect +
+
basic_seq_packet_socket, basic_seq_packet_socket::async_connect +
+
basic_socket, basic_socket::async_connect +
+
basic_stream_socket, basic_stream_socket::async_connect +
+
+
async_fill
+
+
buffered_read_stream, buffered_read_stream::async_fill +
+
buffered_stream, buffered_stream::async_fill +
+
+
async_flush
+
+
buffered_stream, buffered_stream::async_flush +
+
buffered_write_stream, buffered_write_stream::async_flush +
+
+
async_handshake
+
ssl::stream, ssl::stream::async_handshake +
+
async_immediate, async_immediate +
+
async_initiate, async_initiate +
+
async_read, async_read +
+
async_read_at, async_read_at +
+
async_read_some
+
+
basic_readable_pipe, basic_readable_pipe::async_read_some +
+
basic_serial_port, basic_serial_port::async_read_some +
+
basic_stream_file, basic_stream_file::async_read_some +
+
basic_stream_socket, basic_stream_socket::async_read_some +
+
buffered_read_stream, buffered_read_stream::async_read_some +
+
buffered_stream, buffered_stream::async_read_some +
+
buffered_write_stream, buffered_write_stream::async_read_some +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::async_read_some +
+
ssl::stream, ssl::stream::async_read_some +
+
windows::basic_stream_handle, windows::basic_stream_handle::async_read_some +
+
+
async_read_some_at
+
+
basic_random_access_file, basic_random_access_file::async_read_some_at +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::async_read_some_at +
+
+
async_read_until, async_read_until +
+
async_receive
+
+
basic_datagram_socket, basic_datagram_socket::async_receive +
+
basic_raw_socket, basic_raw_socket::async_receive +
+
basic_seq_packet_socket, basic_seq_packet_socket::async_receive +
+
basic_stream_socket, basic_stream_socket::async_receive +
+
experimental::basic_channel, experimental::basic_channel::async_receive +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::async_receive +
+
+
async_receive_from
+
+
basic_datagram_socket, basic_datagram_socket::async_receive_from +
+
basic_raw_socket, basic_raw_socket::async_receive_from +
+
+
async_resolve
+
ip::basic_resolver, ip::basic_resolver::async_resolve +
+
async_result, async_result +
+
+
async_result, async_result::async_result +
+
async_result< + std::packaged_task< Result(Args...)>, Signature >, async_result< + std::packaged_task< Result(Args...)>, Signature >::async_result +
+
+
async_result< + std::packaged_task< Result(Args...)>, Signature >, async_result< + std::packaged_task< Result(Args...)>, Signature > +
+
async_resume
+
experimental::coro, experimental::coro::async_resume +
+
async_send
+
+
basic_datagram_socket, basic_datagram_socket::async_send +
+
basic_raw_socket, basic_raw_socket::async_send +
+
basic_seq_packet_socket, basic_seq_packet_socket::async_send +
+
basic_stream_socket, basic_stream_socket::async_send +
+
experimental::basic_channel, experimental::basic_channel::async_send +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::async_send +
+
+
async_send_to
+
+
basic_datagram_socket, basic_datagram_socket::async_send_to +
+
basic_raw_socket, basic_raw_socket::async_send_to +
+
+
async_shutdown
+
ssl::stream, ssl::stream::async_shutdown +
+
async_wait
+
+
basic_datagram_socket, basic_datagram_socket::async_wait +
+
basic_deadline_timer, basic_deadline_timer::async_wait +
+
basic_raw_socket, basic_raw_socket::async_wait +
+
basic_seq_packet_socket, basic_seq_packet_socket::async_wait +
+
basic_signal_set, basic_signal_set::async_wait +
+
basic_socket, basic_socket::async_wait +
+
basic_socket_acceptor, basic_socket_acceptor::async_wait +
+
basic_stream_socket, basic_stream_socket::async_wait +
+
basic_waitable_timer, basic_waitable_timer::async_wait +
+
experimental::parallel_group, experimental::parallel_group::async_wait +
+
experimental::ranged_parallel_group, experimental::ranged_parallel_group::async_wait +
+
posix::basic_descriptor, posix::basic_descriptor::async_wait +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::async_wait +
+
windows::basic_object_handle, windows::basic_object_handle::async_wait +
+
+
async_write, async_write +
+
async_write_at, async_write_at +
+
async_write_some
+
+
basic_serial_port, basic_serial_port::async_write_some +
+
basic_stream_file, basic_stream_file::async_write_some +
+
basic_stream_socket, basic_stream_socket::async_write_some +
+
basic_writable_pipe, basic_writable_pipe::async_write_some +
+
buffered_read_stream, buffered_read_stream::async_write_some +
+
buffered_stream, buffered_stream::async_write_some +
+
buffered_write_stream, buffered_write_stream::async_write_some +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::async_write_some +
+
ssl::stream, ssl::stream::async_write_some +
+
windows::basic_stream_handle, windows::basic_stream_handle::async_write_some +
+
+
async_write_some_at
+
+
basic_random_access_file, basic_random_access_file::async_write_some_at +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::async_write_some_at +
+
+
as_default_on
+
+
as_tuple_t, as_tuple_t::as_default_on +
+
deferred_t, deferred_t::as_default_on +
+
detached_t, detached_t::as_default_on +
+
experimental::as_single_t, experimental::as_single_t::as_default_on +
+
experimental::use_coro_t, experimental::use_coro_t::as_default_on +
+
experimental::use_promise_t, experimental::use_promise_t::as_default_on +
+
use_awaitable_t, use_awaitable_t::as_default_on +
+
+
as_default_on_t
+
+
as_tuple_t, as_tuple_t::as_default_on_t +
+
deferred_t, deferred_t::as_default_on_t +
+
detached_t, detached_t::as_default_on_t +
+
experimental::as_single_t, experimental::as_single_t::as_default_on_t +
+
experimental::use_coro_t, experimental::use_coro_t::as_default_on_t +
+
use_awaitable_t, use_awaitable_t::as_default_on_t +
+
+
as_single_t
+
experimental::as_single_t, experimental::as_single_t::as_single_t +
+
as_tuple, as_tuple +
+
as_tuple_t, as_tuple_t +
+
as_tuple_t, as_tuple_t::as_tuple_t +
+
as_tuple_t::default_constructor_tag, as_tuple_t::default_constructor_tag +
+
as_tuple_t::executor_with_default, as_tuple_t::executor_with_default +
+
at
+
buffer_registration, buffer_registration::at +
+
attach
+
thread_pool, thread_pool::attach +
+
at_mark
+
+
basic_datagram_socket, basic_datagram_socket::at_mark +
+
basic_raw_socket, basic_raw_socket::at_mark +
+
basic_seq_packet_socket, basic_seq_packet_socket::at_mark +
+
basic_socket, basic_socket::at_mark +
+
basic_stream_socket, basic_stream_socket::at_mark +
+
+
available
+
+
basic_datagram_socket, basic_datagram_socket::available +
+
basic_raw_socket, basic_raw_socket::available +
+
basic_seq_packet_socket, basic_seq_packet_socket::available +
+
basic_socket, basic_socket::available +
+
basic_stream_socket, basic_stream_socket::available +
+
+
awaitable, awaitable +
+
awaitable, awaitable::awaitable +
+
+
+
+

B

+
+
bad_address_cast
+
ip::bad_address_cast, ip::bad_address_cast::bad_address_cast +
+
bad_descriptor
+
error::basic_errors, error::basic_errors +
+
bad_executor, bad_executor +
+
+
bad_executor, bad_executor::bad_executor +
+
execution::bad_executor, execution::bad_executor::bad_executor +
+
+
basic_address_iterator
+
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::basic_address_iterator +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::basic_address_iterator +
+
+
basic_address_range
+
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::basic_address_range +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 >::basic_address_range +
+
+
basic_channel
+
experimental::basic_channel, experimental::basic_channel::basic_channel +
+
basic_concurrent_channel
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::basic_concurrent_channel +
+
basic_datagram_socket, basic_datagram_socket +
+
basic_datagram_socket, basic_datagram_socket::basic_datagram_socket +
+
basic_datagram_socket::rebind_executor, basic_datagram_socket::rebind_executor +
+
basic_deadline_timer, basic_deadline_timer +
+
basic_deadline_timer, basic_deadline_timer::basic_deadline_timer +
+
basic_deadline_timer::rebind_executor, basic_deadline_timer::rebind_executor +
+
basic_descriptor
+
posix::basic_descriptor, posix::basic_descriptor::basic_descriptor +
+
basic_endpoint
+
+
generic::basic_endpoint, generic::basic_endpoint::basic_endpoint +
+
ip::basic_endpoint, ip::basic_endpoint::basic_endpoint +
+
local::basic_endpoint, local::basic_endpoint::basic_endpoint +
+
+
basic_executor_type
+
+
io_context::basic_executor_type, io_context::basic_executor_type::basic_executor_type +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::basic_executor_type +
+
+
basic_file, basic_file +
+
basic_file, basic_file::basic_file +
+
basic_file::rebind_executor, basic_file::rebind_executor +
+
basic_io_object, basic_io_object +
+
+
basic_io_object, basic_io_object::basic_io_object +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::basic_io_object +
+
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true > +
+
basic_object_handle
+
windows::basic_object_handle, windows::basic_object_handle::basic_object_handle +
+
basic_overlapped_handle
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::basic_overlapped_handle +
+
basic_random_access_file, basic_random_access_file +
+
basic_random_access_file, basic_random_access_file::basic_random_access_file +
+
basic_random_access_file::rebind_executor, basic_random_access_file::rebind_executor +
+
basic_random_access_handle
+
windows::basic_random_access_handle, windows::basic_random_access_handle::basic_random_access_handle +
+
basic_raw_socket, basic_raw_socket +
+
basic_raw_socket, basic_raw_socket::basic_raw_socket +
+
basic_raw_socket::rebind_executor, basic_raw_socket::rebind_executor +
+
basic_readable_pipe, basic_readable_pipe +
+
basic_readable_pipe, basic_readable_pipe::basic_readable_pipe +
+
basic_readable_pipe::rebind_executor, basic_readable_pipe::rebind_executor +
+
basic_resolver
+
ip::basic_resolver, ip::basic_resolver::basic_resolver +
+
basic_resolver_entry
+
ip::basic_resolver_entry, ip::basic_resolver_entry::basic_resolver_entry +
+
basic_resolver_iterator
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::basic_resolver_iterator +
+
basic_resolver_query
+
ip::basic_resolver_query, ip::basic_resolver_query::basic_resolver_query +
+
basic_resolver_results
+
ip::basic_resolver_results, ip::basic_resolver_results::basic_resolver_results +
+
basic_seq_packet_socket, basic_seq_packet_socket +
+
basic_seq_packet_socket, basic_seq_packet_socket::basic_seq_packet_socket +
+
basic_seq_packet_socket::rebind_executor, basic_seq_packet_socket::rebind_executor +
+
basic_serial_port, basic_serial_port +
+
basic_serial_port, basic_serial_port::basic_serial_port +
+
basic_serial_port::rebind_executor, basic_serial_port::rebind_executor +
+
basic_signal_set, basic_signal_set +
+
basic_signal_set, basic_signal_set::basic_signal_set +
+
basic_signal_set::rebind_executor, basic_signal_set::rebind_executor +
+
basic_socket, basic_socket +
+
basic_socket, basic_socket::basic_socket +
+
basic_socket::rebind_executor, basic_socket::rebind_executor +
+
basic_socket_acceptor, basic_socket_acceptor +
+
basic_socket_acceptor, basic_socket_acceptor::basic_socket_acceptor +
+
basic_socket_acceptor::rebind_executor, basic_socket_acceptor::rebind_executor +
+
basic_socket_iostream, basic_socket_iostream +
+
basic_socket_iostream, basic_socket_iostream::basic_socket_iostream +
+
basic_socket_streambuf, basic_socket_streambuf +
+
basic_socket_streambuf, basic_socket_streambuf::basic_socket_streambuf +
+
basic_streambuf, basic_streambuf +
+
basic_streambuf, basic_streambuf::basic_streambuf +
+
basic_streambuf_ref, basic_streambuf_ref +
+
basic_streambuf_ref, basic_streambuf_ref::basic_streambuf_ref +
+
basic_stream_descriptor
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::basic_stream_descriptor +
+
basic_stream_file, basic_stream_file +
+
basic_stream_file, basic_stream_file::basic_stream_file +
+
basic_stream_file::rebind_executor, basic_stream_file::rebind_executor +
+
basic_stream_handle
+
windows::basic_stream_handle, windows::basic_stream_handle::basic_stream_handle +
+
basic_stream_socket, basic_stream_socket +
+
basic_stream_socket, basic_stream_socket::basic_stream_socket +
+
basic_stream_socket::rebind_executor, basic_stream_socket::rebind_executor +
+
basic_system_executor, basic_system_executor +
+
basic_system_executor, basic_system_executor::basic_system_executor +
+
basic_waitable_timer, basic_waitable_timer +
+
basic_waitable_timer, basic_waitable_timer::basic_waitable_timer +
+
basic_waitable_timer::rebind_executor, basic_waitable_timer::rebind_executor +
+
basic_writable_pipe, basic_writable_pipe +
+
basic_writable_pipe, basic_writable_pipe::basic_writable_pipe +
+
basic_writable_pipe::rebind_executor, basic_writable_pipe::rebind_executor +
+
basic_yield_context, basic_yield_context +
+
basic_yield_context, basic_yield_context::basic_yield_context +
+
baud_rate
+
serial_port_base::baud_rate, serial_port_base::baud_rate::baud_rate +
+
begin
+
+
buffers_iterator, buffers_iterator::begin +
+
buffer_registration, buffer_registration::begin +
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::begin +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 >::begin +
+
ip::basic_resolver_results, ip::basic_resolver_results::begin +
+
null_buffers, null_buffers::begin +
+
+
bind
+
+
basic_datagram_socket, basic_datagram_socket::bind +
+
basic_raw_socket, basic_raw_socket::bind +
+
basic_seq_packet_socket, basic_seq_packet_socket::bind +
+
basic_socket, basic_socket::bind +
+
basic_socket_acceptor, basic_socket_acceptor::bind +
+
basic_stream_socket, basic_stream_socket::bind +
+
+
bind_allocator, bind_allocator +
+
bind_cancellation_slot, bind_cancellation_slot +
+
bind_executor, bind_executor +
+
bind_immediate_executor, bind_immediate_executor +
+
blocking_adaptation_t
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::blocking_adaptation_t +
+
blocking_t
+
execution::blocking_t, execution::blocking_t::blocking_t +
+
broadcast
+
+
basic_datagram_socket, basic_datagram_socket::broadcast +
+
basic_raw_socket, basic_raw_socket::broadcast +
+
basic_seq_packet_socket, basic_seq_packet_socket::broadcast +
+
basic_socket, basic_socket::broadcast +
+
basic_socket_acceptor, basic_socket_acceptor::broadcast +
+
basic_stream_socket, basic_stream_socket::broadcast +
+
ip::address_v4, ip::address_v4::broadcast +
+
ip::network_v4, ip::network_v4::broadcast +
+
socket_base, socket_base::broadcast +
+
+
broken_pipe
+
error::basic_errors, error::basic_errors +
+
buffer, buffer +
+
+
const_registered_buffer, const_registered_buffer::buffer +
+
mutable_registered_buffer, mutable_registered_buffer::buffer +
+
+
buffered_read_stream, buffered_read_stream +
+
buffered_read_stream, buffered_read_stream::buffered_read_stream +
+
buffered_stream, buffered_stream +
+
buffered_stream, buffered_stream::buffered_stream +
+
buffered_write_stream, buffered_write_stream +
+
buffered_write_stream, buffered_write_stream::buffered_write_stream +
+
buffers_begin, buffers_begin +
+
buffers_end, buffers_end +
+
buffers_iterator, buffers_iterator +
+
buffers_iterator, buffers_iterator::buffers_iterator +
+
buffer_copy, buffer_copy +
+
buffer_literals::operator""_buf, buffer_literals::operator""_buf +
+
buffer_registration, buffer_registration +
+
buffer_registration, buffer_registration::buffer_registration +
+
buffer_sequence_begin, buffer_sequence_begin +
+
buffer_sequence_end, buffer_sequence_end +
+
buffer_size, buffer_size +
+
bytes_readable
+
+
basic_datagram_socket, basic_datagram_socket::bytes_readable +
+
basic_raw_socket, basic_raw_socket::bytes_readable +
+
basic_seq_packet_socket, basic_seq_packet_socket::bytes_readable +
+
basic_socket, basic_socket::bytes_readable +
+
basic_socket_acceptor, basic_socket_acceptor::bytes_readable +
+
basic_stream_socket, basic_stream_socket::bytes_readable +
+
posix::basic_descriptor, posix::basic_descriptor::bytes_readable +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::bytes_readable +
+
posix::descriptor_base, posix::descriptor_base::bytes_readable +
+
socket_base, socket_base::bytes_readable +
+
+
bytes_type
+
+
ip::address_v4, ip::address_v4::bytes_type +
+
ip::address_v6, ip::address_v6::bytes_type +
+
+
+
+
+

C

+
+
cancel
+
+
basic_datagram_socket, basic_datagram_socket::cancel +
+
basic_deadline_timer, basic_deadline_timer::cancel +
+
basic_file, basic_file::cancel +
+
basic_random_access_file, basic_random_access_file::cancel +
+
basic_raw_socket, basic_raw_socket::cancel +
+
basic_readable_pipe, basic_readable_pipe::cancel +
+
basic_seq_packet_socket, basic_seq_packet_socket::cancel +
+
basic_serial_port, basic_serial_port::cancel +
+
basic_signal_set, basic_signal_set::cancel +
+
basic_socket, basic_socket::cancel +
+
basic_socket_acceptor, basic_socket_acceptor::cancel +
+
basic_stream_file, basic_stream_file::cancel +
+
basic_stream_socket, basic_stream_socket::cancel +
+
basic_waitable_timer, basic_waitable_timer::cancel +
+
basic_writable_pipe, basic_writable_pipe::cancel +
+
experimental::basic_channel, experimental::basic_channel::cancel +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::cancel +
+
experimental::promise, experimental::promise::cancel +
+
ip::basic_resolver, ip::basic_resolver::cancel +
+
posix::basic_descriptor, posix::basic_descriptor::cancel +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::cancel +
+
windows::basic_object_handle, windows::basic_object_handle::cancel +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::cancel +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::cancel +
+
windows::basic_stream_handle, windows::basic_stream_handle::cancel +
+
+
cancellation_filter, cancellation_filter +
+
cancellation_signal, cancellation_signal +
+
cancellation_signal, cancellation_signal::cancellation_signal +
+
cancellation_slot, cancellation_slot +
+
cancellation_slot, cancellation_slot::cancellation_slot +
+
cancellation_slot_
+
partial_cancellation_slot_binder, partial_cancellation_slot_binder::cancellation_slot_ +
+
cancellation_slot_binder, cancellation_slot_binder +
+
cancellation_slot_binder, cancellation_slot_binder::cancellation_slot_binder +
+
cancellation_slot_type
+
+
any_completion_handler, any_completion_handler::cancellation_slot_type +
+
basic_yield_context, basic_yield_context::cancellation_slot_type +
+
cancellation_slot_binder, cancellation_slot_binder::cancellation_slot_type +
+
+
cancellation_state, cancellation_state +
+
cancellation_state, cancellation_state::cancellation_state +
+
cancellation_state_t
+
this_coro::cancellation_state_t, this_coro::cancellation_state_t::cancellation_state_t +
+
cancellation_type, cancellation_type +
+
cancellation_type_t, cancellation_type_t +
+
cancelled
+
+
basic_yield_context, basic_yield_context::cancelled +
+
cancellation_state, cancellation_state::cancelled +
+
+
cancel_after, cancel_after +
+
cancel_after_t, cancel_after_t +
+
cancel_after_t, cancel_after_t::cancel_after_t +
+
cancel_after_timer, cancel_after_timer +
+
cancel_after_timer, cancel_after_timer::cancel_after_timer +
+
cancel_at, cancel_at +
+
cancel_at_t, cancel_at_t +
+
cancel_at_t, cancel_at_t::cancel_at_t +
+
cancel_at_timer, cancel_at_timer +
+
cancel_at_timer, cancel_at_timer::cancel_at_timer +
+
cancel_one
+
+
basic_deadline_timer, basic_deadline_timer::cancel_one +
+
basic_waitable_timer, basic_waitable_timer::cancel_one +
+
+
cancel_type_
+
+
cancel_after_t, cancel_after_t::cancel_type_ +
+
cancel_after_timer, cancel_after_timer::cancel_type_ +
+
cancel_at_t, cancel_at_t::cancel_type_ +
+
cancel_at_timer, cancel_at_timer::cancel_type_ +
+
partial_cancel_after, partial_cancel_after::cancel_type_ +
+
partial_cancel_after_timer, partial_cancel_after_timer::cancel_type_ +
+
partial_cancel_at, partial_cancel_at::cancel_type_ +
+
partial_cancel_at_timer, partial_cancel_at_timer::cancel_type_ +
+
+
canonical
+
+
ip::network_v4, ip::network_v4::canonical +
+
ip::network_v6, ip::network_v6::canonical +
+
+
canonical_name
+
+
ip::basic_resolver, ip::basic_resolver::canonical_name +
+
ip::basic_resolver_query, ip::basic_resolver_query::canonical_name +
+
ip::resolver_base, ip::resolver_base::canonical_name +
+
ip::resolver_query_base, ip::resolver_query_base::canonical_name +
+
+
can_prefer, can_prefer +
+
can_query, can_query +
+
can_require, can_require +
+
can_require_concept, can_require_concept +
+
capacity
+
+
basic_streambuf, basic_streambuf::capacity +
+
basic_streambuf_ref, basic_streambuf_ref::capacity +
+
dynamic_string_buffer, dynamic_string_buffer::capacity +
+
dynamic_vector_buffer, dynamic_vector_buffer::capacity +
+
experimental::basic_channel, experimental::basic_channel::capacity +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::capacity +
+
generic::basic_endpoint, generic::basic_endpoint::capacity +
+
ip::basic_endpoint, ip::basic_endpoint::capacity +
+
local::basic_endpoint, local::basic_endpoint::capacity +
+
+
cbegin
+
+
buffer_registration, buffer_registration::cbegin +
+
ip::basic_resolver_results, ip::basic_resolver_results::cbegin +
+
+
cend
+
+
buffer_registration, buffer_registration::cend +
+
ip::basic_resolver_results, ip::basic_resolver_results::cend +
+
+
channel_cancelled
+
experimental::error::channel_errors, experimental::error::channel_errors +
+
channel_closed
+
experimental::error::channel_errors, experimental::error::channel_errors +
+
character_size
+
serial_port_base::character_size, serial_port_base::character_size::character_size +
+
clear
+
+
basic_signal_set, basic_signal_set::clear +
+
cancellation_slot, cancellation_slot::clear +
+
cancellation_state, cancellation_state::clear +
+
+
clear_options
+
ssl::context, ssl::context::clear_options +
+
client
+
+
ssl::stream, ssl::stream::handshake_type +
+
ssl::stream_base, ssl::stream_base::handshake_type +
+
+
clock_type
+
+
basic_socket_iostream, basic_socket_iostream::clock_type +
+
basic_socket_streambuf, basic_socket_streambuf::clock_type +
+
basic_waitable_timer, basic_waitable_timer::clock_type +
+
+
close
+
+
basic_datagram_socket, basic_datagram_socket::close +
+
basic_file, basic_file::close +
+
basic_random_access_file, basic_random_access_file::close +
+
basic_raw_socket, basic_raw_socket::close +
+
basic_readable_pipe, basic_readable_pipe::close +
+
basic_seq_packet_socket, basic_seq_packet_socket::close +
+
basic_serial_port, basic_serial_port::close +
+
basic_socket, basic_socket::close +
+
basic_socket_acceptor, basic_socket_acceptor::close +
+
basic_socket_iostream, basic_socket_iostream::close +
+
basic_socket_streambuf, basic_socket_streambuf::close +
+
basic_stream_file, basic_stream_file::close +
+
basic_stream_socket, basic_stream_socket::close +
+
basic_writable_pipe, basic_writable_pipe::close +
+
buffered_read_stream, buffered_read_stream::close +
+
buffered_stream, buffered_stream::close +
+
buffered_write_stream, buffered_write_stream::close +
+
experimental::basic_channel, experimental::basic_channel::close +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::close +
+
posix::basic_descriptor, posix::basic_descriptor::close +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::close +
+
windows::basic_object_handle, windows::basic_object_handle::close +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::close +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::close +
+
windows::basic_stream_handle, windows::basic_stream_handle::close +
+
+
commit
+
+
basic_streambuf, basic_streambuf::commit +
+
basic_streambuf_ref, basic_streambuf_ref::commit +
+
dynamic_string_buffer, dynamic_string_buffer::commit +
+
dynamic_vector_buffer, dynamic_vector_buffer::commit +
+
+
complete
+
windows::overlapped_ptr, windows::overlapped_ptr::complete +
+
completed
+
experimental::promise, experimental::promise::completed +
+
completion_handler
+
+
async_completion, async_completion::completion_handler +
+
experimental::coro, experimental::coro::completion_handler +
+
experimental::coro_traits, experimental::coro_traits::completion_handler +
+
+
completion_handler_type
+
+
async_completion, async_completion::completion_handler_type +
+
async_result, async_result::completion_handler_type +
+
async_result< + std::packaged_task< Result(Args...)>, Signature >, async_result< + std::packaged_task< Result(Args...)>, Signature >::completion_handler_type +
+
+
completion_signature_of, completion_signature_of +
+
completion_signature_of_t, completion_signature_of_t +
+
composed, composed +
+
config, config +
+
config, config::config +
+
config_from_concurrency_hint, config_from_concurrency_hint +
+
config_from_concurrency_hint, config_from_concurrency_hint::config_from_concurrency_hint +
+
config_from_env, config_from_env +
+
config_from_env, config_from_env::config_from_env +
+
config_from_string, config_from_string +
+
config_from_string, config_from_string::config_from_string +
+
config_service, config_service +
+
config_service, config_service::config_service +
+
connect, connect +
+
+
basic_datagram_socket, basic_datagram_socket::connect +
+
basic_raw_socket, basic_raw_socket::connect +
+
basic_seq_packet_socket, basic_seq_packet_socket::connect +
+
basic_socket, basic_socket::connect +
+
basic_socket_iostream, basic_socket_iostream::connect +
+
basic_socket_streambuf, basic_socket_streambuf::connect +
+
basic_stream_socket, basic_stream_socket::connect +
+
+
connection_aborted
+
error::basic_errors, error::basic_errors +
+
connection_refused
+
error::basic_errors, error::basic_errors +
+
connection_reset
+
error::basic_errors, error::basic_errors +
+
connect_pipe, connect_pipe +
+
consign, consign +
+
consign_t, consign_t +
+
consign_t, consign_t::consign_t +
+
const_buffer, const_buffer +
+
const_buffer, const_buffer::const_buffer +
+
const_buffers_type
+
+
basic_streambuf, basic_streambuf::const_buffers_type +
+
basic_streambuf_ref, basic_streambuf_ref::const_buffers_type +
+
dynamic_string_buffer, dynamic_string_buffer::const_buffers_type +
+
dynamic_vector_buffer, dynamic_vector_buffer::const_buffers_type +
+
+
const_iterator
+
+
buffer_registration, buffer_registration::const_iterator +
+
ip::basic_resolver_results, ip::basic_resolver_results::const_iterator +
+
null_buffers, null_buffers::const_iterator +
+
+
const_reference
+
ip::basic_resolver_results, ip::basic_resolver_results::const_reference +
+
const_registered_buffer, const_registered_buffer +
+
const_registered_buffer, const_registered_buffer::const_registered_buffer +
+
consume
+
+
basic_streambuf, basic_streambuf::consume +
+
basic_streambuf_ref, basic_streambuf_ref::consume +
+
dynamic_string_buffer, dynamic_string_buffer::consume +
+
dynamic_vector_buffer, dynamic_vector_buffer::consume +
+
+
context
+
+
any_completion_executor, any_completion_executor::context +
+
any_io_executor, any_io_executor::context +
+
basic_system_executor, basic_system_executor::context +
+
config_service, config_service::context +
+
execution::any_executor, execution::any_executor::context +
+
execution_context::service, execution_context::service::context +
+
executor, executor::context +
+
io_context::basic_executor_type, io_context::basic_executor_type::context +
+
io_context::service, io_context::service::context +
+
io_context::strand, io_context::strand::context +
+
ssl::context, ssl::context::context +
+
strand, strand::context +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::context +
+
+
continuation
+
execution::relationship_t, execution::relationship_t::continuation +
+
continuation_t
+
execution::relationship_t::continuation_t, execution::relationship_t::continuation_t::continuation_t +
+
coro
+
experimental::coro, experimental::coro::coro +
+
coroutine, coroutine +
+
coroutine, coroutine::coroutine +
+
count_type
+
io_context, io_context::count_type +
+
co_composed, co_composed +
+
co_spawn, co_spawn +
+
create
+
+
basic_file, basic_file::create +
+
basic_random_access_file, basic_random_access_file::create +
+
basic_stream_file, basic_stream_file::create +
+
file_base, file_base::create +
+
+
+
+
+

D

+
+
data
+
+
basic_streambuf, basic_streambuf::data +
+
basic_streambuf_ref, basic_streambuf_ref::data +
+
const_buffer, const_buffer::data +
+
const_registered_buffer, const_registered_buffer::data +
+
dynamic_string_buffer, dynamic_string_buffer::data +
+
dynamic_vector_buffer, dynamic_vector_buffer::data +
+
generic::basic_endpoint, generic::basic_endpoint::data +
+
ip::basic_endpoint, ip::basic_endpoint::data +
+
local::basic_endpoint, local::basic_endpoint::data +
+
mutable_buffer, mutable_buffer::data +
+
mutable_registered_buffer, mutable_registered_buffer::data +
+
+
datagram_protocol
+
generic::datagram_protocol, generic::datagram_protocol::datagram_protocol +
+
data_type
+
+
generic::basic_endpoint, generic::basic_endpoint::data_type +
+
ip::basic_endpoint, ip::basic_endpoint::data_type +
+
local::basic_endpoint, local::basic_endpoint::data_type +
+
+
deadline_timer, deadline_timer +
+
deallocate
+
+
any_completion_handler_allocator, any_completion_handler_allocator::deallocate +
+
execution_context::allocator, execution_context::allocator::deallocate +
+
execution_context::allocator_impl, execution_context::allocator_impl::deallocate +
+
execution_context::allocator_impl_base, execution_context::allocator_impl_base::deallocate +
+
recycling_allocator, recycling_allocator::deallocate +
+
+
debug
+
+
basic_datagram_socket, basic_datagram_socket::debug +
+
basic_raw_socket, basic_raw_socket::debug +
+
basic_seq_packet_socket, basic_seq_packet_socket::debug +
+
basic_socket, basic_socket::debug +
+
basic_socket_acceptor, basic_socket_acceptor::debug +
+
basic_stream_socket, basic_stream_socket::debug +
+
socket_base, socket_base::debug +
+
+
default_buffer_size
+
+
buffered_read_stream, buffered_read_stream::default_buffer_size +
+
buffered_write_stream, buffered_write_stream::default_buffer_size +
+
+
default_completion_token, default_completion_token +
+
default_completion_token_t, default_completion_token_t +
+
default_completion_token_type
+
+
as_tuple_t::executor_with_default, as_tuple_t::executor_with_default::default_completion_token_type +
+
deferred_t::executor_with_default, deferred_t::executor_with_default::default_completion_token_type +
+
detached_t::executor_with_default, detached_t::executor_with_default::default_completion_token_type +
+
experimental::as_single_t::executor_with_default, experimental::as_single_t::executor_with_default::default_completion_token_type +
+
experimental::use_coro_t::executor_with_default, experimental::use_coro_t::executor_with_default::default_completion_token_type +
+
experimental::use_promise_t::executor_with_default, experimental::use_promise_t::executor_with_default::default_completion_token_type +
+
use_awaitable_t::executor_with_default, use_awaitable_t::executor_with_default::default_completion_token_type +
+
+
default_workarounds
+
+
ssl::context, ssl::context::default_workarounds +
+
ssl::context_base, ssl::context_base::default_workarounds +
+
+
defer, defer +
+
+
basic_system_executor, basic_system_executor::defer +
+
executor, executor::defer +
+
io_context::basic_executor_type, io_context::basic_executor_type::defer +
+
io_context::strand, io_context::strand::defer +
+
strand, strand::defer +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::defer +
+
+
deferred, deferred +
+
deferred_async_operation, deferred_async_operation +
+
+
deferred_async_operation, deferred_async_operation::deferred_async_operation +
+
deferred_async_operation< + deferred_signatures< Signatures... >, Initiation, InitArgs... >, deferred_async_operation< + deferred_signatures< Signatures... >, Initiation, InitArgs... >::deferred_async_operation +
+
+
deferred_async_operation< + deferred_signatures< Signatures... >, Initiation, InitArgs... >, deferred_async_operation< + deferred_signatures< Signatures... >, Initiation, InitArgs... > +
+
deferred_conditional, deferred_conditional +
+
deferred_conditional, deferred_conditional::deferred_conditional +
+
deferred_function, deferred_function +
+
deferred_function, deferred_function::deferred_function +
+
deferred_init_tag, deferred_init_tag +
+
deferred_noop, deferred_noop +
+
deferred_sequence, deferred_sequence +
+
deferred_sequence, deferred_sequence::deferred_sequence +
+
deferred_signatures, deferred_signatures +
+
deferred_t, deferred_t +
+
deferred_t, deferred_t::deferred_t +
+
deferred_t::executor_with_default, deferred_t::executor_with_default +
+
deferred_values, deferred_values +
+
deferred_values, deferred_values::deferred_values +
+
deferred_values::initiate, deferred_values::initiate +
+
dereference
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::dereference +
+
destroy
+
+
execution_context, execution_context::destroy +
+
execution_context::allocator_impl, execution_context::allocator_impl::destroy +
+
execution_context::allocator_impl_base, execution_context::allocator_impl_base::destroy +
+
io_context, io_context::destroy +
+
system_context, system_context::destroy +
+
thread_pool, thread_pool::destroy +
+
+
detached, detached +
+
detached_t, detached_t +
+
detached_t, detached_t::detached_t +
+
detached_t::executor_with_default, detached_t::executor_with_default +
+
difference_type
+
+
buffers_iterator, buffers_iterator::difference_type +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::difference_type +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::difference_type +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::difference_type +
+
ip::basic_resolver_results, ip::basic_resolver_results::difference_type +
+
+
disable_cancellation, disable_cancellation +
+
disallowed
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::disallowed +
+
disallowed_t
+
execution::blocking_adaptation_t::disallowed_t, execution::blocking_adaptation_t::disallowed_t::disallowed_t +
+
dispatch, dispatch +
+
+
basic_system_executor, basic_system_executor::dispatch +
+
executor, executor::dispatch +
+
io_context::basic_executor_type, io_context::basic_executor_type::dispatch +
+
io_context::strand, io_context::strand::dispatch +
+
strand, strand::dispatch +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::dispatch +
+
+
disposition_traits, disposition_traits +
+
disposition_traits< + asio::error_code >, disposition_traits< + asio::error_code > +
+
disposition_traits< + no_error_t >, disposition_traits< + no_error_t > +
+
disposition_traits< + std::exception_ptr >, disposition_traits< + std::exception_ptr > +
+
dont_care
+
+
basic_signal_set, basic_signal_set::flags +
+
signal_set_base, signal_set_base::flags +
+
+
do_not_route
+
+
basic_datagram_socket, basic_datagram_socket::do_not_route +
+
basic_raw_socket, basic_raw_socket::do_not_route +
+
basic_seq_packet_socket, basic_seq_packet_socket::do_not_route +
+
basic_socket, basic_socket::do_not_route +
+
basic_socket_acceptor, basic_socket_acceptor::do_not_route +
+
basic_stream_socket, basic_stream_socket::do_not_route +
+
socket_base, socket_base::do_not_route +
+
+
duration
+
+
basic_socket_iostream, basic_socket_iostream::duration +
+
basic_socket_streambuf, basic_socket_streambuf::duration +
+
basic_waitable_timer, basic_waitable_timer::duration +
+
+
duration_type
+
+
basic_deadline_timer, basic_deadline_timer::duration_type +
+
time_traits< + boost::posix_time::ptime >, time_traits< + boost::posix_time::ptime >::duration_type +
+
+
dynamic_buffer, dynamic_buffer +
+
dynamic_string_buffer, dynamic_string_buffer +
+
dynamic_string_buffer, dynamic_string_buffer::dynamic_string_buffer +
+
dynamic_vector_buffer, dynamic_vector_buffer +
+
dynamic_vector_buffer, dynamic_vector_buffer::dynamic_vector_buffer +
+
+
+
+

E

+
+
ec_
+
+
partial_redirect_error, partial_redirect_error::ec_ +
+
redirect_error_t, redirect_error_t::ec_ +
+
+
emit
+
cancellation_signal, cancellation_signal::emit +
+
emplace
+
cancellation_slot, cancellation_slot::emplace +
+
empty
+
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::empty +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 >::empty +
+
ip::basic_resolver_results, ip::basic_resolver_results::empty +
+
+
enable_connection_aborted
+
+
basic_datagram_socket, basic_datagram_socket::enable_connection_aborted +
+
basic_raw_socket, basic_raw_socket::enable_connection_aborted +
+
basic_seq_packet_socket, basic_seq_packet_socket::enable_connection_aborted +
+
basic_socket, basic_socket::enable_connection_aborted +
+
basic_socket_acceptor, basic_socket_acceptor::enable_connection_aborted +
+
basic_stream_socket, basic_stream_socket::enable_connection_aborted +
+
socket_base, socket_base::enable_connection_aborted +
+
+
enable_partial_cancellation, enable_partial_cancellation +
+
enable_terminal_cancellation, enable_terminal_cancellation +
+
enable_total_cancellation, enable_total_cancellation +
+
end
+
+
buffers_iterator, buffers_iterator::end +
+
buffer_registration, buffer_registration::end +
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::end +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 >::end +
+
ip::basic_resolver_results, ip::basic_resolver_results::end +
+
null_buffers, null_buffers::end +
+
+
endpoint
+
+
generic::datagram_protocol, generic::datagram_protocol::endpoint +
+
generic::raw_protocol, generic::raw_protocol::endpoint +
+
generic::seq_packet_protocol, generic::seq_packet_protocol::endpoint +
+
generic::stream_protocol, generic::stream_protocol::endpoint +
+
ip::basic_resolver_entry, ip::basic_resolver_entry::endpoint +
+
ip::icmp, ip::icmp::endpoint +
+
ip::tcp, ip::tcp::endpoint +
+
ip::udp, ip::udp::endpoint +
+
local::datagram_protocol, local::datagram_protocol::endpoint +
+
local::seq_packet_protocol, local::seq_packet_protocol::endpoint +
+
local::stream_protocol, local::stream_protocol::endpoint +
+
+
endpoint_type
+
+
basic_datagram_socket, basic_datagram_socket::endpoint_type +
+
basic_raw_socket, basic_raw_socket::endpoint_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::endpoint_type +
+
basic_socket, basic_socket::endpoint_type +
+
basic_socket_acceptor, basic_socket_acceptor::endpoint_type +
+
basic_socket_iostream, basic_socket_iostream::endpoint_type +
+
basic_socket_streambuf, basic_socket_streambuf::endpoint_type +
+
basic_stream_socket, basic_stream_socket::endpoint_type +
+
ip::basic_resolver, ip::basic_resolver::endpoint_type +
+
ip::basic_resolver_entry, ip::basic_resolver_entry::endpoint_type +
+
ip::basic_resolver_results, ip::basic_resolver_results::endpoint_type +
+
+
eof
+
error::misc_errors, error::misc_errors +
+
equal
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::equal +
+
error
+
+
basic_socket_iostream, basic_socket_iostream::error +
+
basic_socket_streambuf, basic_socket_streambuf::error +
+
+
error::addrinfo_category, error::addrinfo_category +
+
error::addrinfo_errors, error::addrinfo_errors +
+
error::addrinfo_errors >, error::addrinfo_errors + > +
+
error::basic_errors, error::basic_errors +
+
error::basic_errors >, error::basic_errors + > +
+
error::clear, error::clear +
+
error::get_addrinfo_category, error::get_addrinfo_category +
+
error::get_misc_category, error::get_misc_category +
+
error::get_netdb_category, error::get_netdb_category +
+
error::get_ssl_category, error::get_ssl_category +
+
error::get_system_category, error::get_system_category +
+
error::make_error_code, error::make_error_code +
+
error::misc_category, error::misc_category +
+
error::misc_errors, error::misc_errors +
+
error::misc_errors >, error::misc_errors + > +
+
error::netdb_category, error::netdb_category +
+
error::netdb_errors, error::netdb_errors +
+
error::netdb_errors >, error::netdb_errors + > +
+
error::ssl_category, error::ssl_category +
+
error::ssl_errors, error::ssl_errors +
+
error::ssl_errors >, error::ssl_errors + > +
+
error::system_category, error::system_category +
+
error_category, error_category +
+
error_code, error_code +
+
error_type
+
+
experimental::coro, experimental::coro::error_type +
+
experimental::coro_traits, experimental::coro_traits::error_type +
+
+
even
+
serial_port_base::parity, serial_port_base::parity::type +
+
exclusive
+
+
basic_file, basic_file::exclusive +
+
basic_random_access_file, basic_random_access_file::exclusive +
+
basic_stream_file, basic_stream_file::exclusive +
+
file_base, file_base::exclusive +
+
+
execute
+
+
any_completion_executor, any_completion_executor::execute +
+
any_io_executor, any_io_executor::execute +
+
basic_system_executor, basic_system_executor::execute +
+
execution::any_executor, execution::any_executor::execute +
+
io_context::basic_executor_type, io_context::basic_executor_type::execute +
+
strand, strand::execute +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::execute +
+
+
execution::allocator, execution::allocator +
+
execution::allocator_t, execution::allocator_t +
+
execution::any_executor, execution::any_executor +
+
execution::bad_executor, execution::bad_executor +
+
execution::blocking, execution::blocking +
+
execution::blocking_adaptation, execution::blocking_adaptation +
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t +
+
execution::blocking_adaptation_t::allowed_t, execution::blocking_adaptation_t::allowed_t +
+
execution::blocking_adaptation_t::disallowed_t, execution::blocking_adaptation_t::disallowed_t +
+
execution::blocking_t, execution::blocking_t +
+
execution::blocking_t::always_t, execution::blocking_t::always_t +
+
execution::blocking_t::never_t, execution::blocking_t::never_t +
+
execution::blocking_t::possibly_t, execution::blocking_t::possibly_t +
+
execution::context, execution::context +
+
execution::context_as, execution::context_as +
+
execution::context_as_t, execution::context_as_t +
+
execution::context_t, execution::context_t +
+
execution::invocable_archetype, execution::invocable_archetype +
+
execution::is_executor, execution::is_executor +
+
execution::mapping, execution::mapping +
+
execution::mapping_t, execution::mapping_t +
+
execution::mapping_t::new_thread_t, execution::mapping_t::new_thread_t +
+
execution::mapping_t::other_t, execution::mapping_t::other_t +
+
execution::mapping_t::thread_t, execution::mapping_t::thread_t +
+
execution::occupancy, execution::occupancy +
+
execution::occupancy_t, execution::occupancy_t +
+
execution::outstanding_work, execution::outstanding_work +
+
execution::outstanding_work_t, execution::outstanding_work_t +
+
execution::outstanding_work_t::tracked_t, execution::outstanding_work_t::tracked_t +
+
execution::outstanding_work_t::untracked_t, execution::outstanding_work_t::untracked_t +
+
execution::prefer_only, execution::prefer_only +
+
execution::relationship, execution::relationship +
+
execution::relationship_t, execution::relationship_t +
+
execution::relationship_t::continuation_t, execution::relationship_t::continuation_t +
+
execution::relationship_t::fork_t, execution::relationship_t::fork_t +
+
execution_context, execution_context +
+
execution_context, execution_context::execution_context +
+
execution_context::allocator, execution_context::allocator +
+
execution_context::allocator::rebind, execution_context::allocator::rebind +
+
execution_context::allocator< + void >, execution_context::allocator< + void > +
+
execution_context::allocator< + void >::rebind, execution_context::allocator< + void >::rebind +
+
execution_context::allocator_impl, execution_context::allocator_impl +
+
execution_context::allocator_impl_base, execution_context::allocator_impl_base +
+
execution_context::auto_allocator_ptr, execution_context::auto_allocator_ptr +
+
execution_context::id, execution_context::id +
+
execution_context::service, execution_context::service +
+
execution_context::service_maker, execution_context::service_maker +
+
executor, executor +
+
+
executor, executor::executor +
+
thread_pool, thread_pool::executor +
+
+
executor::unspecified_bool_type_t, executor::unspecified_bool_type_t +
+
executor_
+
+
partial_executor_binder, partial_executor_binder::executor_ +
+
partial_immediate_executor_binder, partial_immediate_executor_binder::executor_ +
+
+
executor_arg, executor_arg +
+
executor_arg_t, executor_arg_t +
+
executor_arg_t, executor_arg_t::executor_arg_t +
+
executor_binder, executor_binder +
+
executor_binder, executor_binder::executor_binder +
+
executor_t
+
this_coro::executor_t, this_coro::executor_t::executor_t +
+
executor_type
+
+
awaitable, awaitable::executor_type +
+
basic_datagram_socket, basic_datagram_socket::executor_type +
+
basic_deadline_timer, basic_deadline_timer::executor_type +
+
basic_file, basic_file::executor_type +
+
basic_io_object, basic_io_object::executor_type +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::executor_type +
+
basic_random_access_file, basic_random_access_file::executor_type +
+
basic_raw_socket, basic_raw_socket::executor_type +
+
basic_readable_pipe, basic_readable_pipe::executor_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::executor_type +
+
basic_serial_port, basic_serial_port::executor_type +
+
basic_signal_set, basic_signal_set::executor_type +
+
basic_socket, basic_socket::executor_type +
+
basic_socket_acceptor, basic_socket_acceptor::executor_type +
+
basic_stream_file, basic_stream_file::executor_type +
+
basic_stream_socket, basic_stream_socket::executor_type +
+
basic_waitable_timer, basic_waitable_timer::executor_type +
+
basic_writable_pipe, basic_writable_pipe::executor_type +
+
basic_yield_context, basic_yield_context::executor_type +
+
buffered_read_stream, buffered_read_stream::executor_type +
+
buffered_stream, buffered_stream::executor_type +
+
buffered_write_stream, buffered_write_stream::executor_type +
+
executor_binder, executor_binder::executor_type +
+
executor_work_guard, executor_work_guard::executor_type +
+
experimental::basic_channel, experimental::basic_channel::executor_type +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::executor_type +
+
experimental::coro, experimental::coro::executor_type +
+
io_context, io_context::executor_type +
+
ip::basic_resolver, ip::basic_resolver::executor_type +
+
posix::basic_descriptor, posix::basic_descriptor::executor_type +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::executor_type +
+
ssl::stream, ssl::stream::executor_type +
+
system_context, system_context::executor_type +
+
thread_pool, thread_pool::executor_type +
+
windows::basic_object_handle, windows::basic_object_handle::executor_type +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::executor_type +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::executor_type +
+
windows::basic_stream_handle, windows::basic_stream_handle::executor_type +
+
+
executor_with_default
+
+
as_tuple_t::executor_with_default, as_tuple_t::executor_with_default::executor_with_default +
+
deferred_t::executor_with_default, deferred_t::executor_with_default::executor_with_default +
+
detached_t::executor_with_default, detached_t::executor_with_default::executor_with_default +
+
experimental::as_single_t::executor_with_default, experimental::as_single_t::executor_with_default::executor_with_default +
+
experimental::use_coro_t::executor_with_default, experimental::use_coro_t::executor_with_default::executor_with_default +
+
experimental::use_promise_t::executor_with_default, experimental::use_promise_t::executor_with_default::executor_with_default +
+
use_awaitable_t::executor_with_default, use_awaitable_t::executor_with_default::executor_with_default +
+
+
executor_work_guard, executor_work_guard +
+
executor_work_guard, executor_work_guard::executor_work_guard +
+
experimental::as_single, experimental::as_single +
+
experimental::as_single_t, experimental::as_single_t +
+
experimental::as_single_t::default_constructor_tag, experimental::as_single_t::default_constructor_tag +
+
experimental::as_single_t::executor_with_default, experimental::as_single_t::executor_with_default +
+
experimental::awaitable_operators::operator&&, experimental::awaitable_operators::operator&& +
+
experimental::awaitable_operators::operator||, experimental::awaitable_operators::operator|| +
+
experimental::basic_channel, experimental::basic_channel +
+
experimental::basic_channel::rebind_executor, experimental::basic_channel::rebind_executor +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel +
+
experimental::basic_concurrent_channel::rebind_executor, experimental::basic_concurrent_channel::rebind_executor +
+
experimental::channel, experimental::channel +
+
experimental::channel_traits, experimental::channel_traits +
+
experimental::channel_traits::container, experimental::channel_traits::container +
+
experimental::channel_traits::rebind, experimental::channel_traits::rebind +
+
experimental::concurrent_channel, experimental::concurrent_channel +
+
experimental::coro, experimental::coro +
+
experimental::coro_traits, experimental::coro_traits +
+
experimental::co_spawn, experimental::co_spawn +
+
experimental::error::channel_category, experimental::error::channel_category +
+
experimental::error::channel_errors, experimental::error::channel_errors +
+
experimental::error::channel_errors + >, experimental::error::channel_errors + > +
+
experimental::error::get_channel_category, experimental::error::get_channel_category +
+
experimental::error::make_error_code, experimental::error::make_error_code +
+
experimental::generator, experimental::generator +
+
experimental::is_async_operation_range, experimental::is_async_operation_range +
+
experimental::is_promise, experimental::is_promise +
+
experimental::is_promise< + promise< Ts... > >, experimental::is_promise< + promise< Ts... > > +
+
experimental::is_promise_v, experimental::is_promise_v +
+
experimental::make_parallel_group, experimental::make_parallel_group +
+
experimental::parallel_group, experimental::parallel_group +
+
experimental::promise, experimental::promise +
+
experimental::promise_value_type, experimental::promise_value_type +
+
experimental::promise_value_type< + T >, experimental::promise_value_type< + T > +
+
experimental::promise_value_type<>, experimental::promise_value_type<> +
+
experimental::ranged_parallel_group, experimental::ranged_parallel_group +
+
experimental::task, experimental::task +
+
experimental::use_coro, experimental::use_coro +
+
experimental::use_coro_t, experimental::use_coro_t +
+
experimental::use_coro_t::executor_with_default, experimental::use_coro_t::executor_with_default +
+
experimental::use_promise, experimental::use_promise +
+
experimental::use_promise_t, experimental::use_promise_t +
+
experimental::use_promise_t::executor_with_default, experimental::use_promise_t::executor_with_default +
+
experimental::wait_for_all, experimental::wait_for_all +
+
experimental::wait_for_one, experimental::wait_for_one +
+
experimental::wait_for_one_error, experimental::wait_for_one_error +
+
experimental::wait_for_one_success, experimental::wait_for_one_success +
+
expires_after
+
+
basic_socket_iostream, basic_socket_iostream::expires_after +
+
basic_socket_streambuf, basic_socket_streambuf::expires_after +
+
basic_waitable_timer, basic_waitable_timer::expires_after +
+
+
expires_at
+
+
basic_deadline_timer, basic_deadline_timer::expires_at +
+
basic_socket_iostream, basic_socket_iostream::expires_at +
+
basic_socket_streambuf, basic_socket_streambuf::expires_at +
+
basic_waitable_timer, basic_waitable_timer::expires_at +
+
+
expires_from_now
+
basic_deadline_timer, basic_deadline_timer::expires_from_now +
+
expiry
+
+
basic_socket_iostream, basic_socket_iostream::expiry +
+
basic_socket_streambuf, basic_socket_streambuf::expiry +
+
basic_waitable_timer, basic_waitable_timer::expiry +
+
+
expiry_
+
+
cancel_at_t, cancel_at_t::expiry_ +
+
cancel_at_timer, cancel_at_timer::expiry_ +
+
partial_cancel_at, partial_cancel_at::expiry_ +
+
partial_cancel_at_timer, partial_cancel_at_timer::expiry_ +
+
+
+
+
+

F

+
+
family
+
+
generic::datagram_protocol, generic::datagram_protocol::family +
+
generic::raw_protocol, generic::raw_protocol::family +
+
generic::seq_packet_protocol, generic::seq_packet_protocol::family +
+
generic::stream_protocol, generic::stream_protocol::family +
+
ip::icmp, ip::icmp::family +
+
ip::tcp, ip::tcp::family +
+
ip::udp, ip::udp::family +
+
local::datagram_protocol, local::datagram_protocol::family +
+
local::seq_packet_protocol, local::seq_packet_protocol::family +
+
local::stream_protocol, local::stream_protocol::family +
+
+
fault
+
error::basic_errors, error::basic_errors +
+
fd_set_failure
+
error::misc_errors, error::misc_errors +
+
file_base, file_base +
+
file_format
+
+
ssl::context, ssl::context::file_format +
+
ssl::context_base, ssl::context_base::file_format +
+
+
fill
+
+
buffered_read_stream, buffered_read_stream::fill +
+
buffered_stream, buffered_stream::fill +
+
+
find
+
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::find +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 >::find +
+
+
first_argument_type
+
+
allocator_binder, allocator_binder::first_argument_type +
+
cancellation_slot_binder, cancellation_slot_binder::first_argument_type +
+
executor_binder, executor_binder::first_argument_type +
+
immediate_executor_binder, immediate_executor_binder::first_argument_type +
+
+
first_exception
+
multiple_exceptions, multiple_exceptions::first_exception +
+
flags
+
+
basic_file, basic_file::flags +
+
basic_random_access_file, basic_random_access_file::flags +
+
basic_signal_set, basic_signal_set::flags +
+
basic_stream_file, basic_stream_file::flags +
+
file_base, file_base::flags +
+
ip::basic_resolver, ip::basic_resolver::flags +
+
ip::basic_resolver_query, ip::basic_resolver_query::flags +
+
ip::resolver_base, ip::resolver_base::flags +
+
ip::resolver_query_base, ip::resolver_query_base::flags +
+
signal_set_base, signal_set_base::flags +
+
+
flags_t
+
+
basic_signal_set, basic_signal_set::flags_t +
+
signal_set_base, signal_set_base::flags_t +
+
+
flow_control
+
serial_port_base::flow_control, serial_port_base::flow_control::flow_control +
+
flush
+
+
buffered_stream, buffered_stream::flush +
+
buffered_write_stream, buffered_write_stream::flush +
+
+
fork
+
execution::relationship_t, execution::relationship_t::fork +
+
fork_child
+
+
execution_context, execution_context::fork_event +
+
io_context, io_context::fork_event +
+
system_context, system_context::fork_event +
+
thread_pool, thread_pool::fork_event +
+
+
fork_event
+
+
execution_context, execution_context::fork_event +
+
io_context, io_context::fork_event +
+
system_context, system_context::fork_event +
+
thread_pool, thread_pool::fork_event +
+
+
fork_parent
+
+
execution_context, execution_context::fork_event +
+
io_context, io_context::fork_event +
+
system_context, system_context::fork_event +
+
thread_pool, thread_pool::fork_event +
+
+
fork_prepare
+
+
execution_context, execution_context::fork_event +
+
io_context, io_context::fork_event +
+
system_context, system_context::fork_event +
+
thread_pool, thread_pool::fork_event +
+
+
fork_t
+
execution::relationship_t::fork_t, execution::relationship_t::fork_t::fork_t +
+
for_reading
+
+
ssl::context, ssl::context::password_purpose +
+
ssl::context_base, ssl::context_base::password_purpose +
+
+
for_writing
+
+
ssl::context, ssl::context::password_purpose +
+
ssl::context_base, ssl::context_base::password_purpose +
+
+
function_
+
deferred_function, deferred_function::function_ +
+
+
+
+

G

+
+
generic::basic_endpoint, generic::basic_endpoint +
+
generic::datagram_protocol, generic::datagram_protocol +
+
generic::raw_protocol, generic::raw_protocol +
+
generic::seq_packet_protocol, generic::seq_packet_protocol +
+
generic::stream_protocol, generic::stream_protocol +
+
get
+
+
allocator_binder, allocator_binder::get +
+
associated_allocator, associated_allocator::get +
+
associated_allocator< + reference_wrapper< T >, Allocator >, associated_allocator< + reference_wrapper< T >, Allocator >::get +
+
associated_cancellation_slot, associated_cancellation_slot::get +
+
associated_cancellation_slot< + reference_wrapper< T >, CancellationSlot >, associated_cancellation_slot< + reference_wrapper< T >, CancellationSlot >::get +
+
associated_executor, associated_executor::get +
+
associated_executor< + reference_wrapper< T >, Executor >, associated_executor< + reference_wrapper< T >, Executor >::get +
+
associated_immediate_executor, associated_immediate_executor::get +
+
associated_immediate_executor< + reference_wrapper< T >, Executor >, associated_immediate_executor< + reference_wrapper< T >, Executor >::get +
+
async_result, async_result::get +
+
async_result< + std::packaged_task< Result(Args...)>, Signature >, async_result< + std::packaged_task< Result(Args...)>, Signature >::get +
+
cancellation_slot_binder, cancellation_slot_binder::get +
+
config, config::get +
+
executor_binder, executor_binder::get +
+
immediate_executor_binder, immediate_executor_binder::get +
+
windows::overlapped_ptr, windows::overlapped_ptr::get +
+
+
get_allocator
+
+
allocator_binder, allocator_binder::get_allocator +
+
any_completion_handler, any_completion_handler::get_allocator +
+
experimental::coro, experimental::coro::get_allocator +
+
experimental::use_coro_t, experimental::use_coro_t::get_allocator +
+
experimental::use_promise_t, experimental::use_promise_t::get_allocator +
+
use_future_t, use_future_t::get_allocator +
+
+
get_associated_allocator, get_associated_allocator +
+
get_associated_cancellation_slot, get_associated_cancellation_slot +
+
get_associated_executor, get_associated_executor +
+
get_associated_immediate_executor, get_associated_immediate_executor +
+
get_cancellation_slot
+
+
any_completion_handler, any_completion_handler::get_cancellation_slot +
+
basic_yield_context, basic_yield_context::get_cancellation_slot +
+
cancellation_slot_binder, cancellation_slot_binder::get_cancellation_slot +
+
+
get_cancellation_state
+
basic_yield_context, basic_yield_context::get_cancellation_state +
+
get_executor
+
+
basic_datagram_socket, basic_datagram_socket::get_executor +
+
basic_deadline_timer, basic_deadline_timer::get_executor +
+
basic_file, basic_file::get_executor +
+
basic_io_object, basic_io_object::get_executor +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::get_executor +
+
basic_random_access_file, basic_random_access_file::get_executor +
+
basic_raw_socket, basic_raw_socket::get_executor +
+
basic_readable_pipe, basic_readable_pipe::get_executor +
+
basic_seq_packet_socket, basic_seq_packet_socket::get_executor +
+
basic_serial_port, basic_serial_port::get_executor +
+
basic_signal_set, basic_signal_set::get_executor +
+
basic_socket, basic_socket::get_executor +
+
basic_socket_acceptor, basic_socket_acceptor::get_executor +
+
basic_stream_file, basic_stream_file::get_executor +
+
basic_stream_socket, basic_stream_socket::get_executor +
+
basic_waitable_timer, basic_waitable_timer::get_executor +
+
basic_writable_pipe, basic_writable_pipe::get_executor +
+
basic_yield_context, basic_yield_context::get_executor +
+
buffered_read_stream, buffered_read_stream::get_executor +
+
buffered_stream, buffered_stream::get_executor +
+
buffered_write_stream, buffered_write_stream::get_executor +
+
executor_binder, executor_binder::get_executor +
+
executor_work_guard, executor_work_guard::get_executor +
+
experimental::basic_channel, experimental::basic_channel::get_executor +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::get_executor +
+
experimental::coro, experimental::coro::get_executor +
+
io_context, io_context::get_executor +
+
ip::basic_resolver, ip::basic_resolver::get_executor +
+
posix::basic_descriptor, posix::basic_descriptor::get_executor +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::get_executor +
+
ssl::stream, ssl::stream::get_executor +
+
system_context, system_context::get_executor +
+
thread_pool, thread_pool::get_executor +
+
windows::basic_object_handle, windows::basic_object_handle::get_executor +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::get_executor +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::get_executor +
+
windows::basic_stream_handle, windows::basic_stream_handle::get_executor +
+
+
get_immediate_executor
+
immediate_executor_binder, immediate_executor_binder::get_immediate_executor +
+
get_implementation
+
+
basic_io_object, basic_io_object::get_implementation +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::get_implementation +
+
+
get_inner_executor
+
strand, strand::get_inner_executor +
+
get_io_context
+
+
basic_io_object, basic_io_object::get_io_context +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::get_io_context +
+
io_context::service, io_context::service::get_io_context +
+
+
get_io_service
+
+
basic_io_object, basic_io_object::get_io_service +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::get_io_service +
+
+
get_option
+
+
basic_datagram_socket, basic_datagram_socket::get_option +
+
basic_raw_socket, basic_raw_socket::get_option +
+
basic_seq_packet_socket, basic_seq_packet_socket::get_option +
+
basic_serial_port, basic_serial_port::get_option +
+
basic_socket, basic_socket::get_option +
+
basic_socket_acceptor, basic_socket_acceptor::get_option +
+
basic_stream_socket, basic_stream_socket::get_option +
+
+
get_service
+
+
basic_io_object, basic_io_object::get_service +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::get_service +
+
+
get_value
+
config_service, config_service::get_value +
+
grow
+
+
dynamic_string_buffer, dynamic_string_buffer::grow +
+
dynamic_vector_buffer, dynamic_vector_buffer::grow +
+
+
+
+
+

H

+
+
handshake
+
ssl::stream, ssl::stream::handshake +
+
handshake_type
+
+
ssl::stream, ssl::stream::handshake_type +
+
ssl::stream_base, ssl::stream_base::handshake_type +
+
+
hardware
+
serial_port_base::flow_control, serial_port_base::flow_control::type +
+
has_handler
+
cancellation_slot, cancellation_slot::has_handler +
+
has_service
+
execution_context, execution_context::has_service +
+
high_resolution_timer, high_resolution_timer +
+
hints
+
ip::basic_resolver_query, ip::basic_resolver_query::hints +
+
hosts
+
+
ip::network_v4, ip::network_v4::hosts +
+
ip::network_v6, ip::network_v6::hosts +
+
+
host_name
+
+
ip::basic_resolver_entry, ip::basic_resolver_entry::host_name +
+
ip::basic_resolver_query, ip::basic_resolver_query::host_name +
+
+
host_name_verification
+
ssl::host_name_verification, ssl::host_name_verification::host_name_verification +
+
host_not_found
+
error::netdb_errors, error::netdb_errors +
+
host_not_found_try_again
+
error::netdb_errors, error::netdb_errors +
+
host_unreachable
+
error::basic_errors, error::basic_errors +
+
+
+
+

I

+
+
id
+
+
const_registered_buffer, const_registered_buffer::id +
+
execution_context::id, execution_context::id::id +
+
mutable_registered_buffer, mutable_registered_buffer::id +
+
+
immediate_executor_binder, immediate_executor_binder +
+
immediate_executor_binder, immediate_executor_binder::immediate_executor_binder +
+
immediate_executor_type
+
immediate_executor_binder, immediate_executor_binder::immediate_executor_type +
+
implementation_type
+
+
basic_io_object, basic_io_object::implementation_type +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::implementation_type +
+
+
increment
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::increment +
+
index_
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::index_ +
+
initiate
+
async_result, async_result::initiate +
+
inner_executor_type
+
strand, strand::inner_executor_type +
+
input_type
+
+
experimental::coro, experimental::coro::input_type +
+
experimental::coro_traits, experimental::coro_traits::input_type +
+
+
interrupted
+
error::basic_errors, error::basic_errors +
+
invalid_argument
+
error::basic_errors, error::basic_errors +
+
invalid_service_owner, invalid_service_owner +
+
invalid_service_owner, invalid_service_owner::invalid_service_owner +
+
invoke_receive_cancelled
+
experimental::channel_traits, experimental::channel_traits::invoke_receive_cancelled +
+
invoke_receive_closed
+
experimental::channel_traits, experimental::channel_traits::invoke_receive_closed +
+
in_avail
+
+
buffered_read_stream, buffered_read_stream::in_avail +
+
buffered_stream, buffered_stream::in_avail +
+
buffered_write_stream, buffered_write_stream::in_avail +
+
+
in_progress
+
error::basic_errors, error::basic_errors +
+
iostream
+
+
generic::stream_protocol, generic::stream_protocol::iostream +
+
ip::tcp, ip::tcp::iostream +
+
local::stream_protocol, local::stream_protocol::iostream +
+
+
io_context, io_context +
+
io_context, io_context::io_context +
+
io_context::basic_executor_type, io_context::basic_executor_type +
+
io_context::service, io_context::service +
+
io_context::strand, io_context::strand +
+
io_control
+
+
basic_datagram_socket, basic_datagram_socket::io_control +
+
basic_raw_socket, basic_raw_socket::io_control +
+
basic_seq_packet_socket, basic_seq_packet_socket::io_control +
+
basic_socket, basic_socket::io_control +
+
basic_socket_acceptor, basic_socket_acceptor::io_control +
+
basic_stream_socket, basic_stream_socket::io_control +
+
posix::basic_descriptor, posix::basic_descriptor::io_control +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::io_control +
+
+
ip::address, ip::address +
+
ip::address >, ip::address > +
+
ip::address_v4, ip::address_v4 +
+
ip::address_v4 >, ip::address_v4 > +
+
ip::address_v4_iterator, ip::address_v4_iterator +
+
ip::address_v4_range, ip::address_v4_range +
+
ip::address_v6, ip::address_v6 +
+
ip::address_v6 >, ip::address_v6 > +
+
ip::address_v6_iterator, ip::address_v6_iterator +
+
ip::address_v6_range, ip::address_v6_range +
+
ip::bad_address_cast, ip::bad_address_cast +
+
ip::basic_address_iterator, ip::basic_address_iterator +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 > +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 > +
+
ip::basic_address_range, ip::basic_address_range +
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 > +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 > +
+
ip::basic_endpoint, ip::basic_endpoint +
+
ip::basic_endpoint< + InternetProtocol > >, ip::basic_endpoint< + InternetProtocol > > +
+
ip::basic_resolver, ip::basic_resolver +
+
ip::basic_resolver::rebind_executor, ip::basic_resolver::rebind_executor +
+
ip::basic_resolver_entry, ip::basic_resolver_entry +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator +
+
ip::basic_resolver_query, ip::basic_resolver_query +
+
ip::basic_resolver_results, ip::basic_resolver_results +
+
ip::host_name, ip::host_name +
+
ip::icmp, ip::icmp +
+
ip::multicast::enable_loopback, ip::multicast::enable_loopback +
+
ip::multicast::hops, ip::multicast::hops +
+
ip::multicast::join_group, ip::multicast::join_group +
+
ip::multicast::leave_group, ip::multicast::leave_group +
+
ip::multicast::outbound_interface, ip::multicast::outbound_interface +
+
ip::network_v4, ip::network_v4 +
+
ip::network_v6, ip::network_v6 +
+
ip::port_type, ip::port_type +
+
ip::resolver_base, ip::resolver_base +
+
ip::resolver_query_base, ip::resolver_query_base +
+
ip::scope_id_type, ip::scope_id_type +
+
ip::tcp, ip::tcp +
+
ip::udp, ip::udp +
+
ip::unicast::hops, ip::unicast::hops +
+
ip::v4_mapped_t, ip::v4_mapped_t +
+
ip::v6_only, ip::v6_only +
+
is_applicable_property, is_applicable_property +
+
is_applicable_property_v
+
+
execution::allocator_t, execution::allocator_t::is_applicable_property_v +
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::is_applicable_property_v +
+
execution::blocking_adaptation_t::allowed_t, execution::blocking_adaptation_t::allowed_t::is_applicable_property_v +
+
execution::blocking_adaptation_t::disallowed_t, execution::blocking_adaptation_t::disallowed_t::is_applicable_property_v +
+
execution::blocking_t, execution::blocking_t::is_applicable_property_v +
+
execution::blocking_t::always_t, execution::blocking_t::always_t::is_applicable_property_v +
+
execution::blocking_t::never_t, execution::blocking_t::never_t::is_applicable_property_v +
+
execution::blocking_t::possibly_t, execution::blocking_t::possibly_t::is_applicable_property_v +
+
execution::context_as_t, execution::context_as_t::is_applicable_property_v +
+
execution::context_t, execution::context_t::is_applicable_property_v +
+
execution::mapping_t, execution::mapping_t::is_applicable_property_v +
+
execution::mapping_t::new_thread_t, execution::mapping_t::new_thread_t::is_applicable_property_v +
+
execution::mapping_t::other_t, execution::mapping_t::other_t::is_applicable_property_v +
+
execution::mapping_t::thread_t, execution::mapping_t::thread_t::is_applicable_property_v +
+
execution::occupancy_t, execution::occupancy_t::is_applicable_property_v +
+
execution::outstanding_work_t, execution::outstanding_work_t::is_applicable_property_v +
+
execution::outstanding_work_t::tracked_t, execution::outstanding_work_t::tracked_t::is_applicable_property_v +
+
execution::outstanding_work_t::untracked_t, execution::outstanding_work_t::untracked_t::is_applicable_property_v +
+
execution::prefer_only, execution::prefer_only::is_applicable_property_v +
+
execution::relationship_t, execution::relationship_t::is_applicable_property_v +
+
execution::relationship_t::continuation_t, execution::relationship_t::continuation_t::is_applicable_property_v +
+
execution::relationship_t::fork_t, execution::relationship_t::fork_t::is_applicable_property_v +
+
+
is_async_operation, is_async_operation +
+
is_child
+
coroutine, coroutine::is_child +
+
is_complete
+
coroutine, coroutine::is_complete +
+
is_completion_condition, is_completion_condition +
+
is_connected
+
cancellation_slot, cancellation_slot::is_connected +
+
is_connect_condition, is_connect_condition +
+
is_const_buffer_sequence, is_const_buffer_sequence +
+
is_contiguous_iterator, is_contiguous_iterator +
+
is_deferred, is_deferred +
+
is_disposition, is_disposition +
+
is_dynamic_buffer, is_dynamic_buffer +
+
is_dynamic_buffer_v1, is_dynamic_buffer_v1 +
+
is_dynamic_buffer_v2, is_dynamic_buffer_v2 +
+
is_endpoint_sequence, is_endpoint_sequence +
+
is_executor, is_executor +
+
is_host
+
+
ip::network_v4, ip::network_v4::is_host +
+
ip::network_v6, ip::network_v6::is_host +
+
+
is_link_local
+
ip::address_v6, ip::address_v6::is_link_local +
+
is_loopback
+
+
ip::address, ip::address::is_loopback +
+
ip::address_v4, ip::address_v4::is_loopback +
+
ip::address_v6, ip::address_v6::is_loopback +
+
+
is_match_condition, is_match_condition +
+
is_multicast
+
+
ip::address, ip::address::is_multicast +
+
ip::address_v4, ip::address_v4::is_multicast +
+
ip::address_v6, ip::address_v6::is_multicast +
+
+
is_multicast_global
+
ip::address_v6, ip::address_v6::is_multicast_global +
+
is_multicast_link_local
+
ip::address_v6, ip::address_v6::is_multicast_link_local +
+
is_multicast_node_local
+
ip::address_v6, ip::address_v6::is_multicast_node_local +
+
is_multicast_org_local
+
ip::address_v6, ip::address_v6::is_multicast_org_local +
+
is_multicast_site_local
+
ip::address_v6, ip::address_v6::is_multicast_site_local +
+
is_mutable_buffer_sequence, is_mutable_buffer_sequence +
+
is_noexcept
+
+
experimental::coro, experimental::coro::is_noexcept +
+
experimental::coro_traits, experimental::coro_traits::is_noexcept +
+
+
is_nothrow_prefer, is_nothrow_prefer +
+
is_nothrow_query, is_nothrow_query +
+
is_nothrow_require, is_nothrow_require +
+
is_nothrow_require_concept, is_nothrow_require_concept +
+
is_open
+
+
basic_datagram_socket, basic_datagram_socket::is_open +
+
basic_file, basic_file::is_open +
+
basic_random_access_file, basic_random_access_file::is_open +
+
basic_raw_socket, basic_raw_socket::is_open +
+
basic_readable_pipe, basic_readable_pipe::is_open +
+
basic_seq_packet_socket, basic_seq_packet_socket::is_open +
+
basic_serial_port, basic_serial_port::is_open +
+
basic_socket, basic_socket::is_open +
+
basic_socket_acceptor, basic_socket_acceptor::is_open +
+
basic_stream_file, basic_stream_file::is_open +
+
basic_stream_socket, basic_stream_socket::is_open +
+
basic_writable_pipe, basic_writable_pipe::is_open +
+
experimental::basic_channel, experimental::basic_channel::is_open +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::is_open +
+
experimental::coro, experimental::coro::is_open +
+
posix::basic_descriptor, posix::basic_descriptor::is_open +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::is_open +
+
windows::basic_object_handle, windows::basic_object_handle::is_open +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::is_open +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::is_open +
+
windows::basic_stream_handle, windows::basic_stream_handle::is_open +
+
+
is_parent
+
coroutine, coroutine::is_parent +
+
is_preferable
+
+
execution::allocator_t, execution::allocator_t::is_preferable +
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::is_preferable +
+
execution::blocking_adaptation_t::allowed_t, execution::blocking_adaptation_t::allowed_t::is_preferable +
+
execution::blocking_adaptation_t::disallowed_t, execution::blocking_adaptation_t::disallowed_t::is_preferable +
+
execution::blocking_t, execution::blocking_t::is_preferable +
+
execution::blocking_t::always_t, execution::blocking_t::always_t::is_preferable +
+
execution::blocking_t::never_t, execution::blocking_t::never_t::is_preferable +
+
execution::blocking_t::possibly_t, execution::blocking_t::possibly_t::is_preferable +
+
execution::context_as_t, execution::context_as_t::is_preferable +
+
execution::context_t, execution::context_t::is_preferable +
+
execution::mapping_t, execution::mapping_t::is_preferable +
+
execution::mapping_t::new_thread_t, execution::mapping_t::new_thread_t::is_preferable +
+
execution::mapping_t::other_t, execution::mapping_t::other_t::is_preferable +
+
execution::mapping_t::thread_t, execution::mapping_t::thread_t::is_preferable +
+
execution::occupancy_t, execution::occupancy_t::is_preferable +
+
execution::outstanding_work_t, execution::outstanding_work_t::is_preferable +
+
execution::outstanding_work_t::tracked_t, execution::outstanding_work_t::tracked_t::is_preferable +
+
execution::outstanding_work_t::untracked_t, execution::outstanding_work_t::untracked_t::is_preferable +
+
execution::prefer_only, execution::prefer_only::is_preferable +
+
execution::relationship_t, execution::relationship_t::is_preferable +
+
execution::relationship_t::continuation_t, execution::relationship_t::continuation_t::is_preferable +
+
execution::relationship_t::fork_t, execution::relationship_t::fork_t::is_preferable +
+
+
is_read_buffered, is_read_buffered +
+
is_requirable
+
+
execution::allocator_t, execution::allocator_t::is_requirable +
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::is_requirable +
+
execution::blocking_adaptation_t::allowed_t, execution::blocking_adaptation_t::allowed_t::is_requirable +
+
execution::blocking_adaptation_t::disallowed_t, execution::blocking_adaptation_t::disallowed_t::is_requirable +
+
execution::blocking_t, execution::blocking_t::is_requirable +
+
execution::blocking_t::always_t, execution::blocking_t::always_t::is_requirable +
+
execution::blocking_t::never_t, execution::blocking_t::never_t::is_requirable +
+
execution::blocking_t::possibly_t, execution::blocking_t::possibly_t::is_requirable +
+
execution::context_as_t, execution::context_as_t::is_requirable +
+
execution::context_t, execution::context_t::is_requirable +
+
execution::mapping_t, execution::mapping_t::is_requirable +
+
execution::mapping_t::new_thread_t, execution::mapping_t::new_thread_t::is_requirable +
+
execution::mapping_t::other_t, execution::mapping_t::other_t::is_requirable +
+
execution::mapping_t::thread_t, execution::mapping_t::thread_t::is_requirable +
+
execution::occupancy_t, execution::occupancy_t::is_requirable +
+
execution::outstanding_work_t, execution::outstanding_work_t::is_requirable +
+
execution::outstanding_work_t::tracked_t, execution::outstanding_work_t::tracked_t::is_requirable +
+
execution::outstanding_work_t::untracked_t, execution::outstanding_work_t::untracked_t::is_requirable +
+
execution::prefer_only, execution::prefer_only::is_requirable +
+
execution::relationship_t, execution::relationship_t::is_requirable +
+
execution::relationship_t::continuation_t, execution::relationship_t::continuation_t::is_requirable +
+
execution::relationship_t::fork_t, execution::relationship_t::fork_t::is_requirable +
+
+
is_site_local
+
ip::address_v6, ip::address_v6::is_site_local +
+
is_subnet_of
+
+
ip::network_v4, ip::network_v4::is_subnet_of +
+
ip::network_v6, ip::network_v6::is_subnet_of +
+
+
is_unspecified
+
+
ip::address, ip::address::is_unspecified +
+
ip::address_v4, ip::address_v4::is_unspecified +
+
ip::address_v6, ip::address_v6::is_unspecified +
+
+
is_v4
+
ip::address, ip::address::is_v4 +
+
is_v4_mapped
+
ip::address_v6, ip::address_v6::is_v4_mapped +
+
is_v6
+
ip::address, ip::address::is_v6 +
+
is_write_buffered, is_write_buffered +
+
iterator
+
+
buffer_registration, buffer_registration::iterator +
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::iterator +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 >::iterator +
+
ip::basic_resolver_results, ip::basic_resolver_results::iterator +
+
+
iterator_category
+
+
buffers_iterator, buffers_iterator::iterator_category +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::iterator_category +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::iterator_category +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::iterator_category +
+
+
+
+
+

J

+
+
join
+
+
system_context, system_context::join +
+
thread, thread::join +
+
thread_pool, thread_pool::join +
+
+
+
+
+

K

+
+
keep_alive
+
+
basic_datagram_socket, basic_datagram_socket::keep_alive +
+
basic_raw_socket, basic_raw_socket::keep_alive +
+
basic_seq_packet_socket, basic_seq_packet_socket::keep_alive +
+
basic_socket, basic_socket::keep_alive +
+
basic_socket_acceptor, basic_socket_acceptor::keep_alive +
+
basic_stream_socket, basic_stream_socket::keep_alive +
+
socket_base, socket_base::keep_alive +
+
+
key_type
+
config_service, config_service::key_type +
+
+
+
+

L

+
+
less_than
+
time_traits< + boost::posix_time::ptime >, time_traits< + boost::posix_time::ptime >::less_than +
+
linger
+
+
basic_datagram_socket, basic_datagram_socket::linger +
+
basic_raw_socket, basic_raw_socket::linger +
+
basic_seq_packet_socket, basic_seq_packet_socket::linger +
+
basic_socket, basic_socket::linger +
+
basic_socket_acceptor, basic_socket_acceptor::linger +
+
basic_stream_socket, basic_stream_socket::linger +
+
socket_base, socket_base::linger +
+
+
listen
+
basic_socket_acceptor, basic_socket_acceptor::listen +
+
load
+
+
serial_port_base::baud_rate, serial_port_base::baud_rate::load +
+
serial_port_base::character_size, serial_port_base::character_size::load +
+
serial_port_base::flow_control, serial_port_base::flow_control::load +
+
serial_port_base::parity, serial_port_base::parity::load +
+
serial_port_base::stop_bits, serial_port_base::stop_bits::load +
+
+
load_verify_file
+
ssl::context, ssl::context::load_verify_file +
+
local::basic_endpoint, local::basic_endpoint +
+
local::connect_pair, local::connect_pair +
+
local::datagram_protocol, local::datagram_protocol +
+
local::seq_packet_protocol, local::seq_packet_protocol +
+
local::stream_protocol, local::stream_protocol +
+
local_endpoint
+
+
basic_datagram_socket, basic_datagram_socket::local_endpoint +
+
basic_raw_socket, basic_raw_socket::local_endpoint +
+
basic_seq_packet_socket, basic_seq_packet_socket::local_endpoint +
+
basic_socket, basic_socket::local_endpoint +
+
basic_socket_acceptor, basic_socket_acceptor::local_endpoint +
+
basic_stream_socket, basic_stream_socket::local_endpoint +
+
+
loopback
+
+
ip::address_v4, ip::address_v4::loopback +
+
ip::address_v6, ip::address_v6::loopback +
+
+
lowest_layer
+
+
basic_datagram_socket, basic_datagram_socket::lowest_layer +
+
basic_raw_socket, basic_raw_socket::lowest_layer +
+
basic_readable_pipe, basic_readable_pipe::lowest_layer +
+
basic_seq_packet_socket, basic_seq_packet_socket::lowest_layer +
+
basic_serial_port, basic_serial_port::lowest_layer +
+
basic_socket, basic_socket::lowest_layer +
+
basic_stream_socket, basic_stream_socket::lowest_layer +
+
basic_writable_pipe, basic_writable_pipe::lowest_layer +
+
buffered_read_stream, buffered_read_stream::lowest_layer +
+
buffered_stream, buffered_stream::lowest_layer +
+
buffered_write_stream, buffered_write_stream::lowest_layer +
+
posix::basic_descriptor, posix::basic_descriptor::lowest_layer +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::lowest_layer +
+
ssl::stream, ssl::stream::lowest_layer +
+
windows::basic_object_handle, windows::basic_object_handle::lowest_layer +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::lowest_layer +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::lowest_layer +
+
windows::basic_stream_handle, windows::basic_stream_handle::lowest_layer +
+
+
lowest_layer_type
+
+
basic_datagram_socket, basic_datagram_socket::lowest_layer_type +
+
basic_raw_socket, basic_raw_socket::lowest_layer_type +
+
basic_readable_pipe, basic_readable_pipe::lowest_layer_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::lowest_layer_type +
+
basic_serial_port, basic_serial_port::lowest_layer_type +
+
basic_socket, basic_socket::lowest_layer_type +
+
basic_stream_socket, basic_stream_socket::lowest_layer_type +
+
basic_writable_pipe, basic_writable_pipe::lowest_layer_type +
+
buffered_read_stream, buffered_read_stream::lowest_layer_type +
+
buffered_stream, buffered_stream::lowest_layer_type +
+
buffered_write_stream, buffered_write_stream::lowest_layer_type +
+
posix::basic_descriptor, posix::basic_descriptor::lowest_layer_type +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::lowest_layer_type +
+
ssl::stream, ssl::stream::lowest_layer_type +
+
windows::basic_object_handle, windows::basic_object_handle::lowest_layer_type +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::lowest_layer_type +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::lowest_layer_type +
+
windows::basic_stream_handle, windows::basic_stream_handle::lowest_layer_type +
+
+
+
+
+

M

+
+
make
+
+
config_from_concurrency_hint, config_from_concurrency_hint::make +
+
config_from_env, config_from_env::make +
+
config_from_string, config_from_string::make +
+
execution_context::service_maker, execution_context::service_maker::make +
+
+
make_address
+
ip::address, ip::address::make_address +
+
make_address_v4
+
ip::address_v4, ip::address_v4::make_address_v4 +
+
make_address_v6
+
ip::address_v6, ip::address_v6::make_address_v6 +
+
make_network_v4
+
+
ip::address_v4, ip::address_v4::make_network_v4 +
+
ip::network_v4, ip::network_v4::make_network_v4 +
+
+
make_network_v6
+
+
ip::address_v6, ip::address_v6::make_network_v6 +
+
ip::network_v6, ip::network_v6::make_network_v6 +
+
+
make_service
+
execution_context, execution_context::make_service +
+
make_strand, make_strand +
+
make_work_guard, make_work_guard +
+
mapping_t
+
execution::mapping_t, execution::mapping_t::mapping_t +
+
max_listen_connections
+
+
basic_datagram_socket, basic_datagram_socket::max_listen_connections +
+
basic_raw_socket, basic_raw_socket::max_listen_connections +
+
basic_seq_packet_socket, basic_seq_packet_socket::max_listen_connections +
+
basic_socket, basic_socket::max_listen_connections +
+
basic_socket_acceptor, basic_socket_acceptor::max_listen_connections +
+
basic_stream_socket, basic_stream_socket::max_listen_connections +
+
socket_base, socket_base::max_listen_connections +
+
+
max_size
+
+
basic_streambuf, basic_streambuf::max_size +
+
basic_streambuf_ref, basic_streambuf_ref::max_size +
+
dynamic_string_buffer, dynamic_string_buffer::max_size +
+
dynamic_vector_buffer, dynamic_vector_buffer::max_size +
+
ip::basic_resolver_results, ip::basic_resolver_results::max_size +
+
+
message_do_not_route
+
+
basic_datagram_socket, basic_datagram_socket::message_do_not_route +
+
basic_raw_socket, basic_raw_socket::message_do_not_route +
+
basic_seq_packet_socket, basic_seq_packet_socket::message_do_not_route +
+
basic_socket, basic_socket::message_do_not_route +
+
basic_socket_acceptor, basic_socket_acceptor::message_do_not_route +
+
basic_stream_socket, basic_stream_socket::message_do_not_route +
+
socket_base, socket_base::message_do_not_route +
+
+
message_end_of_record
+
+
basic_datagram_socket, basic_datagram_socket::message_end_of_record +
+
basic_raw_socket, basic_raw_socket::message_end_of_record +
+
basic_seq_packet_socket, basic_seq_packet_socket::message_end_of_record +
+
basic_socket, basic_socket::message_end_of_record +
+
basic_socket_acceptor, basic_socket_acceptor::message_end_of_record +
+
basic_stream_socket, basic_stream_socket::message_end_of_record +
+
socket_base, socket_base::message_end_of_record +
+
+
message_flags
+
+
basic_datagram_socket, basic_datagram_socket::message_flags +
+
basic_raw_socket, basic_raw_socket::message_flags +
+
basic_seq_packet_socket, basic_seq_packet_socket::message_flags +
+
basic_socket, basic_socket::message_flags +
+
basic_socket_acceptor, basic_socket_acceptor::message_flags +
+
basic_stream_socket, basic_stream_socket::message_flags +
+
socket_base, socket_base::message_flags +
+
+
message_out_of_band
+
+
basic_datagram_socket, basic_datagram_socket::message_out_of_band +
+
basic_raw_socket, basic_raw_socket::message_out_of_band +
+
basic_seq_packet_socket, basic_seq_packet_socket::message_out_of_band +
+
basic_socket, basic_socket::message_out_of_band +
+
basic_socket_acceptor, basic_socket_acceptor::message_out_of_band +
+
basic_stream_socket, basic_stream_socket::message_out_of_band +
+
socket_base, socket_base::message_out_of_band +
+
+
message_peek
+
+
basic_datagram_socket, basic_datagram_socket::message_peek +
+
basic_raw_socket, basic_raw_socket::message_peek +
+
basic_seq_packet_socket, basic_seq_packet_socket::message_peek +
+
basic_socket, basic_socket::message_peek +
+
basic_socket_acceptor, basic_socket_acceptor::message_peek +
+
basic_stream_socket, basic_stream_socket::message_peek +
+
socket_base, socket_base::message_peek +
+
+
message_size
+
error::basic_errors, error::basic_errors +
+
method
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
multiple_exceptions, multiple_exceptions +
+
multiple_exceptions, multiple_exceptions::multiple_exceptions +
+
mutable_buffer, mutable_buffer +
+
mutable_buffer, mutable_buffer::mutable_buffer +
+
mutable_buffers_type
+
+
basic_streambuf, basic_streambuf::mutable_buffers_type +
+
basic_streambuf_ref, basic_streambuf_ref::mutable_buffers_type +
+
dynamic_string_buffer, dynamic_string_buffer::mutable_buffers_type +
+
dynamic_vector_buffer, dynamic_vector_buffer::mutable_buffers_type +
+
+
mutable_registered_buffer, mutable_registered_buffer +
+
mutable_registered_buffer, mutable_registered_buffer::mutable_registered_buffer +
+
+
+
+

N

+
+
name_too_long
+
error::basic_errors, error::basic_errors +
+
native_handle
+
+
basic_datagram_socket, basic_datagram_socket::native_handle +
+
basic_file, basic_file::native_handle +
+
basic_random_access_file, basic_random_access_file::native_handle +
+
basic_raw_socket, basic_raw_socket::native_handle +
+
basic_readable_pipe, basic_readable_pipe::native_handle +
+
basic_seq_packet_socket, basic_seq_packet_socket::native_handle +
+
basic_serial_port, basic_serial_port::native_handle +
+
basic_socket, basic_socket::native_handle +
+
basic_socket_acceptor, basic_socket_acceptor::native_handle +
+
basic_stream_file, basic_stream_file::native_handle +
+
basic_stream_socket, basic_stream_socket::native_handle +
+
basic_writable_pipe, basic_writable_pipe::native_handle +
+
posix::basic_descriptor, posix::basic_descriptor::native_handle +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::native_handle +
+
registered_buffer_id, registered_buffer_id::native_handle +
+
ssl::context, ssl::context::native_handle +
+
ssl::stream, ssl::stream::native_handle +
+
ssl::verify_context, ssl::verify_context::native_handle +
+
windows::basic_object_handle, windows::basic_object_handle::native_handle +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::native_handle +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::native_handle +
+
windows::basic_stream_handle, windows::basic_stream_handle::native_handle +
+
+
native_handle_type
+
+
basic_datagram_socket, basic_datagram_socket::native_handle_type +
+
basic_file, basic_file::native_handle_type +
+
basic_random_access_file, basic_random_access_file::native_handle_type +
+
basic_raw_socket, basic_raw_socket::native_handle_type +
+
basic_readable_pipe, basic_readable_pipe::native_handle_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::native_handle_type +
+
basic_serial_port, basic_serial_port::native_handle_type +
+
basic_socket, basic_socket::native_handle_type +
+
basic_socket_acceptor, basic_socket_acceptor::native_handle_type +
+
basic_stream_file, basic_stream_file::native_handle_type +
+
basic_stream_socket, basic_stream_socket::native_handle_type +
+
basic_writable_pipe, basic_writable_pipe::native_handle_type +
+
posix::basic_descriptor, posix::basic_descriptor::native_handle_type +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::native_handle_type +
+
registered_buffer_id, registered_buffer_id::native_handle_type +
+
ssl::context, ssl::context::native_handle_type +
+
ssl::stream, ssl::stream::native_handle_type +
+
ssl::verify_context, ssl::verify_context::native_handle_type +
+
windows::basic_object_handle, windows::basic_object_handle::native_handle_type +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::native_handle_type +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::native_handle_type +
+
windows::basic_stream_handle, windows::basic_stream_handle::native_handle_type +
+
+
native_non_blocking
+
+
basic_datagram_socket, basic_datagram_socket::native_non_blocking +
+
basic_raw_socket, basic_raw_socket::native_non_blocking +
+
basic_seq_packet_socket, basic_seq_packet_socket::native_non_blocking +
+
basic_socket, basic_socket::native_non_blocking +
+
basic_socket_acceptor, basic_socket_acceptor::native_non_blocking +
+
basic_stream_socket, basic_stream_socket::native_non_blocking +
+
posix::basic_descriptor, posix::basic_descriptor::native_non_blocking +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::native_non_blocking +
+
+
netmask
+
ip::network_v4, ip::network_v4::netmask +
+
network
+
+
ip::network_v4, ip::network_v4::network +
+
ip::network_v6, ip::network_v6::network +
+
+
network_down
+
error::basic_errors, error::basic_errors +
+
network_reset
+
error::basic_errors, error::basic_errors +
+
network_unreachable
+
error::basic_errors, error::basic_errors +
+
network_v4
+
ip::network_v4, ip::network_v4::network_v4 +
+
network_v6
+
ip::network_v6, ip::network_v6::network_v6 +
+
never
+
execution::blocking_t, execution::blocking_t::never +
+
never_t
+
execution::blocking_t::never_t, execution::blocking_t::never_t::never_t +
+
new_thread
+
execution::mapping_t, execution::mapping_t::new_thread +
+
new_thread_t
+
execution::mapping_t::new_thread_t, execution::mapping_t::new_thread_t::new_thread_t +
+
next_layer
+
+
buffered_read_stream, buffered_read_stream::next_layer +
+
buffered_stream, buffered_stream::next_layer +
+
buffered_write_stream, buffered_write_stream::next_layer +
+
ssl::stream, ssl::stream::next_layer +
+
+
next_layer_type
+
+
buffered_read_stream, buffered_read_stream::next_layer_type +
+
buffered_stream, buffered_stream::next_layer_type +
+
buffered_write_stream, buffered_write_stream::next_layer_type +
+
ssl::stream, ssl::stream::next_layer_type +
+
+
none
+
+
basic_signal_set, basic_signal_set::flags +
+
cancellation_type, cancellation_type +
+
serial_port_base::flow_control, serial_port_base::flow_control::type +
+
serial_port_base::parity, serial_port_base::parity::type +
+
signal_set_base, signal_set_base::flags +
+
+
non_blocking
+
+
basic_datagram_socket, basic_datagram_socket::non_blocking +
+
basic_raw_socket, basic_raw_socket::non_blocking +
+
basic_seq_packet_socket, basic_seq_packet_socket::non_blocking +
+
basic_socket, basic_socket::non_blocking +
+
basic_socket_acceptor, basic_socket_acceptor::non_blocking +
+
basic_stream_socket, basic_stream_socket::non_blocking +
+
posix::basic_descriptor, posix::basic_descriptor::non_blocking +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::non_blocking +
+
+
notify_fork
+
+
execution_context, execution_context::notify_fork +
+
execution_context::service, execution_context::service::notify_fork +
+
io_context, io_context::notify_fork +
+
system_context, system_context::notify_fork +
+
thread_pool, thread_pool::notify_fork +
+
+
not_an_error
+
+
disposition_traits, disposition_traits::not_an_error +
+
disposition_traits< + asio::error_code >, disposition_traits< + asio::error_code >::not_an_error +
+
disposition_traits< + no_error_t >, disposition_traits< + no_error_t >::not_an_error +
+
disposition_traits< + std::exception_ptr >, disposition_traits< + std::exception_ptr >::not_an_error +
+
+
not_connected
+
error::basic_errors, error::basic_errors +
+
not_found
+
error::misc_errors, error::misc_errors +
+
not_socket
+
error::basic_errors, error::basic_errors +
+
now
+
time_traits< boost::posix_time::ptime + >, time_traits< + boost::posix_time::ptime >::now +
+
no_buffer_space
+
error::basic_errors, error::basic_errors +
+
no_child_stop
+
+
basic_signal_set, basic_signal_set::flags +
+
signal_set_base, signal_set_base::flags +
+
+
no_child_wait
+
+
basic_signal_set, basic_signal_set::flags +
+
signal_set_base, signal_set_base::flags +
+
+
no_compression
+
+
ssl::context, ssl::context::no_compression +
+
ssl::context_base, ssl::context_base::no_compression +
+
+
no_data
+
error::netdb_errors, error::netdb_errors +
+
no_delay
+
ip::tcp, ip::tcp::no_delay +
+
no_descriptors
+
error::basic_errors, error::basic_errors +
+
no_error, no_error +
+
no_error_t, no_error_t +
+
no_error_t, no_error_t::no_error_t +
+
no_memory
+
error::basic_errors, error::basic_errors +
+
no_permission
+
error::basic_errors, error::basic_errors +
+
no_protocol_option
+
error::basic_errors, error::basic_errors +
+
no_recovery
+
error::netdb_errors, error::netdb_errors +
+
no_sslv2
+
+
ssl::context, ssl::context::no_sslv2 +
+
ssl::context_base, ssl::context_base::no_sslv2 +
+
+
no_sslv3
+
+
ssl::context, ssl::context::no_sslv3 +
+
ssl::context_base, ssl::context_base::no_sslv3 +
+
+
no_such_device
+
error::basic_errors, error::basic_errors +
+
no_tlsv1
+
+
ssl::context, ssl::context::no_tlsv1 +
+
ssl::context_base, ssl::context_base::no_tlsv1 +
+
+
no_tlsv1_1
+
+
ssl::context, ssl::context::no_tlsv1_1 +
+
ssl::context_base, ssl::context_base::no_tlsv1_1 +
+
+
no_tlsv1_2
+
+
ssl::context, ssl::context::no_tlsv1_2 +
+
ssl::context_base, ssl::context_base::no_tlsv1_2 +
+
+
no_tlsv1_3
+
+
ssl::context, ssl::context::no_tlsv1_3 +
+
ssl::context_base, ssl::context_base::no_tlsv1_3 +
+
+
null_buffers, null_buffers +
+
numeric_host
+
+
ip::basic_resolver, ip::basic_resolver::numeric_host +
+
ip::basic_resolver_query, ip::basic_resolver_query::numeric_host +
+
ip::resolver_base, ip::resolver_base::numeric_host +
+
ip::resolver_query_base, ip::resolver_query_base::numeric_host +
+
+
numeric_service
+
+
ip::basic_resolver, ip::basic_resolver::numeric_service +
+
ip::basic_resolver_query, ip::basic_resolver_query::numeric_service +
+
ip::resolver_base, ip::resolver_base::numeric_service +
+
ip::resolver_query_base, ip::resolver_query_base::numeric_service +
+
+
+
+
+

O

+
+
odd
+
serial_port_base::parity, serial_port_base::parity::type +
+
one
+
serial_port_base::stop_bits, serial_port_base::stop_bits::type +
+
onepointfive
+
serial_port_base::stop_bits, serial_port_base::stop_bits::type +
+
on_work_finished
+
+
basic_system_executor, basic_system_executor::on_work_finished +
+
executor, executor::on_work_finished +
+
io_context::basic_executor_type, io_context::basic_executor_type::on_work_finished +
+
io_context::strand, io_context::strand::on_work_finished +
+
strand, strand::on_work_finished +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::on_work_finished +
+
+
on_work_started
+
+
basic_system_executor, basic_system_executor::on_work_started +
+
executor, executor::on_work_started +
+
io_context::basic_executor_type, io_context::basic_executor_type::on_work_started +
+
io_context::strand, io_context::strand::on_work_started +
+
strand, strand::on_work_started +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::on_work_started +
+
+
open
+
+
basic_datagram_socket, basic_datagram_socket::open +
+
basic_file, basic_file::open +
+
basic_random_access_file, basic_random_access_file::open +
+
basic_raw_socket, basic_raw_socket::open +
+
basic_seq_packet_socket, basic_seq_packet_socket::open +
+
basic_serial_port, basic_serial_port::open +
+
basic_socket, basic_socket::open +
+
basic_socket_acceptor, basic_socket_acceptor::open +
+
basic_stream_file, basic_stream_file::open +
+
basic_stream_socket, basic_stream_socket::open +
+
+
operation_aborted
+
error::basic_errors, error::basic_errors +
+
operation_not_supported
+
error::basic_errors, error::basic_errors +
+
operator bool
+
+
any_completion_executor, any_completion_executor::operator + bool +
+
any_completion_handler, any_completion_handler::operator + bool +
+
any_io_executor, any_io_executor::operator + bool +
+
execution::any_executor, execution::any_executor::operator + bool +
+
experimental::coro, experimental::coro::operator + bool +
+
+
operator co_await
+
experimental::coro, experimental::coro::operator + co_await +
+
operator + endpoint_type
+
ip::basic_resolver_entry, ip::basic_resolver_entry::operator + endpoint_type +
+
operator unspecified_bool_type
+
executor, executor::operator + unspecified_bool_type +
+
operator!
+
any_completion_handler, any_completion_handler::operator! +
+
operator!=
+
+
any_completion_executor, any_completion_executor::operator!= +
+
any_completion_handler, any_completion_handler::operator!= +
+
any_completion_handler_allocator, any_completion_handler_allocator::operator!= +
+
any_completion_handler_allocator< + void, Signatures... >, any_completion_handler_allocator< + void, Signatures... >::operator!= +
+
any_io_executor, any_io_executor::operator!= +
+
basic_system_executor, basic_system_executor::operator!= +
+
buffers_iterator, buffers_iterator::operator!= +
+
cancellation_slot, cancellation_slot::operator!= +
+
execution::any_executor, execution::any_executor::operator!= +
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::operator!= +
+
execution::blocking_t, execution::blocking_t::operator!= +
+
execution::mapping_t, execution::mapping_t::operator!= +
+
execution::outstanding_work_t, execution::outstanding_work_t::operator!= +
+
execution::relationship_t, execution::relationship_t::operator!= +
+
execution_context::allocator, execution_context::allocator::operator!= +
+
execution_context::allocator< + void >, execution_context::allocator< + void >::operator!= +
+
executor, executor::operator!= +
+
generic::basic_endpoint, generic::basic_endpoint::operator!= +
+
generic::datagram_protocol, generic::datagram_protocol::operator!= +
+
generic::raw_protocol, generic::raw_protocol::operator!= +
+
generic::seq_packet_protocol, generic::seq_packet_protocol::operator!= +
+
generic::stream_protocol, generic::stream_protocol::operator!= +
+
io_context::basic_executor_type, io_context::basic_executor_type::operator!= +
+
io_context::strand, io_context::strand::operator!= +
+
ip::address, ip::address::operator!= +
+
ip::address_v4, ip::address_v4::operator!= +
+
ip::address_v6, ip::address_v6::operator!= +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::operator!= +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::operator!= +
+
ip::basic_endpoint, ip::basic_endpoint::operator!= +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::operator!= +
+
ip::basic_resolver_results, ip::basic_resolver_results::operator!= +
+
ip::icmp, ip::icmp::operator!= +
+
ip::network_v4, ip::network_v4::operator!= +
+
ip::network_v6, ip::network_v6::operator!= +
+
ip::tcp, ip::tcp::operator!= +
+
ip::udp, ip::udp::operator!= +
+
local::basic_endpoint, local::basic_endpoint::operator!= +
+
no_error_t, no_error_t::operator!= +
+
recycling_allocator, recycling_allocator::operator!= +
+
recycling_allocator< + void >, recycling_allocator< + void >::operator!= +
+
registered_buffer_id, registered_buffer_id::operator!= +
+
strand, strand::operator!= +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::operator!= +
+
+
operator()
+
+
allocator_binder, allocator_binder::operator() +
+
any_completion_handler, any_completion_handler::operator() +
+
cancellation_filter, cancellation_filter::operator() +
+
cancellation_slot_binder, cancellation_slot_binder::operator() +
+
deferred_async_operation, deferred_async_operation::operator() +
+
deferred_async_operation< + deferred_signatures< Signatures... >, Initiation, InitArgs... >, deferred_async_operation< + deferred_signatures< Signatures... >, Initiation, InitArgs... >::operator() +
+
deferred_conditional, deferred_conditional::operator() +
+
deferred_function, deferred_function::operator() +
+
deferred_noop, deferred_noop::operator() +
+
deferred_sequence, deferred_sequence::operator() +
+
deferred_t, deferred_t::operator() +
+
deferred_values, deferred_values::operator() +
+
deferred_values::initiate, deferred_values::initiate::operator() +
+
execution::invocable_archetype, execution::invocable_archetype::operator() +
+
executor_binder, executor_binder::operator() +
+
experimental::coro, experimental::coro::operator() +
+
experimental::promise, experimental::promise::operator() +
+
experimental::wait_for_all, experimental::wait_for_all::operator() +
+
experimental::wait_for_one, experimental::wait_for_one::operator() +
+
experimental::wait_for_one_error, experimental::wait_for_one_error::operator() +
+
experimental::wait_for_one_success, experimental::wait_for_one_success::operator() +
+
immediate_executor_binder, immediate_executor_binder::operator() +
+
ip::address >, ip::address + >::operator() +
+
ip::address_v4 + >, ip::address_v4 + >::operator() +
+
ip::address_v6 + >, ip::address_v6 + >::operator() +
+
ip::basic_endpoint< + InternetProtocol > >, ip::basic_endpoint< + InternetProtocol > >::operator() +
+
partial_allocator_binder, partial_allocator_binder::operator() +
+
partial_as_tuple, partial_as_tuple::operator() +
+
partial_cancellation_slot_binder, partial_cancellation_slot_binder::operator() +
+
partial_cancel_after, partial_cancel_after::operator() +
+
partial_cancel_after_timer, partial_cancel_after_timer::operator() +
+
partial_cancel_at, partial_cancel_at::operator() +
+
partial_cancel_at_timer, partial_cancel_at_timer::operator() +
+
partial_executor_binder, partial_executor_binder::operator() +
+
partial_immediate_executor_binder, partial_immediate_executor_binder::operator() +
+
partial_redirect_error, partial_redirect_error::operator() +
+
ssl::host_name_verification, ssl::host_name_verification::operator() +
+
use_future_t, use_future_t::operator() +
+
+
operator*
+
+
buffers_iterator, buffers_iterator::operator* +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::operator* +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::operator* +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::operator* +
+
+
operator+
+
+
buffers_iterator, buffers_iterator::operator+ +
+
const_buffer, const_buffer::operator+ +
+
const_registered_buffer, const_registered_buffer::operator+ +
+
mutable_buffer, mutable_buffer::operator+ +
+
mutable_registered_buffer, mutable_registered_buffer::operator+ +
+
+
operator++
+
+
buffers_iterator, buffers_iterator::operator++ +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::operator++ +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::operator++ +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::operator++ +
+
+
operator+=
+
+
buffers_iterator, buffers_iterator::operator+= +
+
const_buffer, const_buffer::operator+= +
+
const_registered_buffer, const_registered_buffer::operator+= +
+
mutable_buffer, mutable_buffer::operator+= +
+
mutable_registered_buffer, mutable_registered_buffer::operator+= +
+
+
operator-
+
buffers_iterator, buffers_iterator::operator- +
+
operator--
+
+
buffers_iterator, buffers_iterator::operator-- +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::operator-- +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::operator-- +
+
+
operator-=
+
buffers_iterator, buffers_iterator::operator-= +
+
operator->
+
+
buffers_iterator, buffers_iterator::operator-> +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::operator-> +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::operator-> +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::operator-> +
+
+
operator<
+
+
buffers_iterator, buffers_iterator::operator< +
+
generic::basic_endpoint, generic::basic_endpoint::operator< +
+
ip::address, ip::address::operator< +
+
ip::address_v4, ip::address_v4::operator< +
+
ip::address_v6, ip::address_v6::operator< +
+
ip::basic_endpoint, ip::basic_endpoint::operator< +
+
local::basic_endpoint, local::basic_endpoint::operator< +
+
+
operator<<
+
+
ip::address, ip::address::operator<< +
+
ip::address_v4, ip::address_v4::operator<< +
+
ip::address_v6, ip::address_v6::operator<< +
+
ip::basic_endpoint, ip::basic_endpoint::operator<< +
+
local::basic_endpoint, local::basic_endpoint::operator<< +
+
+
operator<=
+
+
buffers_iterator, buffers_iterator::operator<= +
+
generic::basic_endpoint, generic::basic_endpoint::operator<= +
+
ip::address, ip::address::operator<= +
+
ip::address_v4, ip::address_v4::operator<= +
+
ip::address_v6, ip::address_v6::operator<= +
+
ip::basic_endpoint, ip::basic_endpoint::operator<= +
+
local::basic_endpoint, local::basic_endpoint::operator<= +
+
+
operator=
+
+
any_completion_executor, any_completion_executor::operator= +
+
any_completion_handler, any_completion_handler::operator= +
+
any_io_executor, any_io_executor::operator= +
+
awaitable, awaitable::operator= +
+
basic_datagram_socket, basic_datagram_socket::operator= +
+
basic_deadline_timer, basic_deadline_timer::operator= +
+
basic_file, basic_file::operator= +
+
basic_io_object, basic_io_object::operator= +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::operator= +
+
basic_random_access_file, basic_random_access_file::operator= +
+
basic_raw_socket, basic_raw_socket::operator= +
+
basic_readable_pipe, basic_readable_pipe::operator= +
+
basic_seq_packet_socket, basic_seq_packet_socket::operator= +
+
basic_serial_port, basic_serial_port::operator= +
+
basic_socket, basic_socket::operator= +
+
basic_socket_acceptor, basic_socket_acceptor::operator= +
+
basic_socket_iostream, basic_socket_iostream::operator= +
+
basic_socket_streambuf, basic_socket_streambuf::operator= +
+
basic_stream_file, basic_stream_file::operator= +
+
basic_stream_socket, basic_stream_socket::operator= +
+
basic_waitable_timer, basic_waitable_timer::operator= +
+
basic_writable_pipe, basic_writable_pipe::operator= +
+
buffer_registration, buffer_registration::operator= +
+
execution::any_executor, execution::any_executor::operator= +
+
executor, executor::operator= +
+
experimental::basic_channel, experimental::basic_channel::operator= +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::operator= +
+
experimental::coro, experimental::coro::operator= +
+
generic::basic_endpoint, generic::basic_endpoint::operator= +
+
io_context::basic_executor_type, io_context::basic_executor_type::operator= +
+
ip::address, ip::address::operator= +
+
ip::address_v4, ip::address_v4::operator= +
+
ip::address_v6, ip::address_v6::operator= +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::operator= +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::operator= +
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::operator= +
+
ip::basic_address_range< + address_v6 >, ip::basic_address_range< + address_v6 >::operator= +
+
ip::basic_endpoint, ip::basic_endpoint::operator= +
+
ip::basic_resolver, ip::basic_resolver::operator= +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::operator= +
+
ip::basic_resolver_results, ip::basic_resolver_results::operator= +
+
ip::network_v4, ip::network_v4::operator= +
+
ip::network_v6, ip::network_v6::operator= +
+
local::basic_endpoint, local::basic_endpoint::operator= +
+
posix::basic_descriptor, posix::basic_descriptor::operator= +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::operator= +
+
ssl::context, ssl::context::operator= +
+
ssl::stream, ssl::stream::operator= +
+
strand, strand::operator= +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::operator= +
+
windows::basic_object_handle, windows::basic_object_handle::operator= +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::operator= +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::operator= +
+
windows::basic_stream_handle, windows::basic_stream_handle::operator= +
+
+
operator==
+
+
any_completion_executor, any_completion_executor::operator== +
+
any_completion_handler, any_completion_handler::operator== +
+
any_completion_handler_allocator, any_completion_handler_allocator::operator== +
+
any_completion_handler_allocator< + void, Signatures... >, any_completion_handler_allocator< + void, Signatures... >::operator== +
+
any_io_executor, any_io_executor::operator== +
+
basic_system_executor, basic_system_executor::operator== +
+
buffers_iterator, buffers_iterator::operator== +
+
cancellation_slot, cancellation_slot::operator== +
+
execution::any_executor, execution::any_executor::operator== +
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::operator== +
+
execution::blocking_t, execution::blocking_t::operator== +
+
execution::mapping_t, execution::mapping_t::operator== +
+
execution::outstanding_work_t, execution::outstanding_work_t::operator== +
+
execution::relationship_t, execution::relationship_t::operator== +
+
execution_context::allocator, execution_context::allocator::operator== +
+
execution_context::allocator< + void >, execution_context::allocator< + void >::operator== +
+
executor, executor::operator== +
+
generic::basic_endpoint, generic::basic_endpoint::operator== +
+
generic::datagram_protocol, generic::datagram_protocol::operator== +
+
generic::raw_protocol, generic::raw_protocol::operator== +
+
generic::seq_packet_protocol, generic::seq_packet_protocol::operator== +
+
generic::stream_protocol, generic::stream_protocol::operator== +
+
io_context::basic_executor_type, io_context::basic_executor_type::operator== +
+
io_context::strand, io_context::strand::operator== +
+
ip::address, ip::address::operator== +
+
ip::address_v4, ip::address_v4::operator== +
+
ip::address_v6, ip::address_v6::operator== +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::operator== +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::operator== +
+
ip::basic_endpoint, ip::basic_endpoint::operator== +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::operator== +
+
ip::basic_resolver_results, ip::basic_resolver_results::operator== +
+
ip::icmp, ip::icmp::operator== +
+
ip::network_v4, ip::network_v4::operator== +
+
ip::network_v6, ip::network_v6::operator== +
+
ip::tcp, ip::tcp::operator== +
+
ip::udp, ip::udp::operator== +
+
local::basic_endpoint, local::basic_endpoint::operator== +
+
no_error_t, no_error_t::operator== +
+
recycling_allocator, recycling_allocator::operator== +
+
recycling_allocator< + void >, recycling_allocator< + void >::operator== +
+
registered_buffer_id, registered_buffer_id::operator== +
+
strand, strand::operator== +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::operator== +
+
+
operator>
+
+
buffers_iterator, buffers_iterator::operator> +
+
generic::basic_endpoint, generic::basic_endpoint::operator> +
+
ip::address, ip::address::operator> +
+
ip::address_v4, ip::address_v4::operator> +
+
ip::address_v6, ip::address_v6::operator> +
+
ip::basic_endpoint, ip::basic_endpoint::operator> +
+
local::basic_endpoint, local::basic_endpoint::operator> +
+
+
operator>=
+
+
buffers_iterator, buffers_iterator::operator>= +
+
generic::basic_endpoint, generic::basic_endpoint::operator>= +
+
ip::address, ip::address::operator>= +
+
ip::address_v4, ip::address_v4::operator>= +
+
ip::address_v6, ip::address_v6::operator>= +
+
ip::basic_endpoint, ip::basic_endpoint::operator>= +
+
local::basic_endpoint, local::basic_endpoint::operator>= +
+
+
operator[]
+
+
basic_yield_context, basic_yield_context::operator[] +
+
buffers_iterator, buffers_iterator::operator[] +
+
buffer_registration, buffer_registration::operator[] +
+
+
operator|, operator| +
+
options
+
+
ssl::context, ssl::context::options +
+
ssl::context_base, ssl::context_base::options +
+
+
other
+
+
any_completion_handler_allocator::rebind, any_completion_handler_allocator::rebind::other +
+
any_completion_handler_allocator< + void, Signatures... >::rebind, any_completion_handler_allocator< + void, Signatures... >::rebind::other +
+
basic_datagram_socket::rebind_executor, basic_datagram_socket::rebind_executor::other +
+
basic_deadline_timer::rebind_executor, basic_deadline_timer::rebind_executor::other +
+
basic_file::rebind_executor, basic_file::rebind_executor::other +
+
basic_random_access_file::rebind_executor, basic_random_access_file::rebind_executor::other +
+
basic_raw_socket::rebind_executor, basic_raw_socket::rebind_executor::other +
+
basic_readable_pipe::rebind_executor, basic_readable_pipe::rebind_executor::other +
+
basic_seq_packet_socket::rebind_executor, basic_seq_packet_socket::rebind_executor::other +
+
basic_serial_port::rebind_executor, basic_serial_port::rebind_executor::other +
+
basic_signal_set::rebind_executor, basic_signal_set::rebind_executor::other +
+
basic_socket::rebind_executor, basic_socket::rebind_executor::other +
+
basic_socket_acceptor::rebind_executor, basic_socket_acceptor::rebind_executor::other +
+
basic_stream_file::rebind_executor, basic_stream_file::rebind_executor::other +
+
basic_stream_socket::rebind_executor, basic_stream_socket::rebind_executor::other +
+
basic_waitable_timer::rebind_executor, basic_waitable_timer::rebind_executor::other +
+
basic_writable_pipe::rebind_executor, basic_writable_pipe::rebind_executor::other +
+
execution::mapping_t, execution::mapping_t::other +
+
execution_context::allocator::rebind, execution_context::allocator::rebind::other +
+
execution_context::allocator< + void >::rebind, execution_context::allocator< + void >::rebind::other +
+
experimental::basic_channel::rebind_executor, experimental::basic_channel::rebind_executor::other +
+
experimental::basic_concurrent_channel::rebind_executor, experimental::basic_concurrent_channel::rebind_executor::other +
+
experimental::channel_traits::rebind, experimental::channel_traits::rebind::other +
+
ip::basic_resolver::rebind_executor, ip::basic_resolver::rebind_executor::other +
+
posix::basic_descriptor::rebind_executor, posix::basic_descriptor::rebind_executor::other +
+
posix::basic_stream_descriptor::rebind_executor, posix::basic_stream_descriptor::rebind_executor::other +
+
recycling_allocator::rebind, recycling_allocator::rebind::other +
+
recycling_allocator< + void >::rebind, recycling_allocator< + void >::rebind::other +
+
windows::basic_object_handle::rebind_executor, windows::basic_object_handle::rebind_executor::other +
+
windows::basic_overlapped_handle::rebind_executor, windows::basic_overlapped_handle::rebind_executor::other +
+
windows::basic_random_access_handle::rebind_executor, windows::basic_random_access_handle::rebind_executor::other +
+
windows::basic_stream_handle::rebind_executor, windows::basic_stream_handle::rebind_executor::other +
+
+
otherwise
+
deferred_conditional, deferred_conditional::otherwise +
+
other_t
+
execution::mapping_t::other_t, execution::mapping_t::other_t::other_t +
+
outstanding_work_t
+
execution::outstanding_work_t, execution::outstanding_work_t::outstanding_work_t +
+
out_of_band_inline
+
+
basic_datagram_socket, basic_datagram_socket::out_of_band_inline +
+
basic_raw_socket, basic_raw_socket::out_of_band_inline +
+
basic_seq_packet_socket, basic_seq_packet_socket::out_of_band_inline +
+
basic_socket, basic_socket::out_of_band_inline +
+
basic_socket_acceptor, basic_socket_acceptor::out_of_band_inline +
+
basic_stream_socket, basic_stream_socket::out_of_band_inline +
+
socket_base, socket_base::out_of_band_inline +
+
+
overflow
+
+
basic_socket_streambuf, basic_socket_streambuf::overflow +
+
basic_streambuf, basic_streambuf::overflow +
+
+
overlapped_ptr
+
windows::overlapped_ptr, windows::overlapped_ptr::overlapped_ptr +
+
owns_work
+
executor_work_guard, executor_work_guard::owns_work +
+
+
+
+

P

+
+
parallel_group
+
experimental::parallel_group, experimental::parallel_group::parallel_group +
+
parity
+
serial_port_base::parity, serial_port_base::parity::parity +
+
partial
+
cancellation_type, cancellation_type +
+
partial_allocator_binder, partial_allocator_binder +
+
partial_allocator_binder, partial_allocator_binder::partial_allocator_binder +
+
partial_as_tuple, partial_as_tuple +
+
partial_as_tuple, partial_as_tuple::partial_as_tuple +
+
partial_cancellation_slot_binder, partial_cancellation_slot_binder +
+
partial_cancellation_slot_binder, partial_cancellation_slot_binder::partial_cancellation_slot_binder +
+
partial_cancel_after, partial_cancel_after +
+
partial_cancel_after, partial_cancel_after::partial_cancel_after +
+
partial_cancel_after_timer, partial_cancel_after_timer +
+
partial_cancel_after_timer, partial_cancel_after_timer::partial_cancel_after_timer +
+
partial_cancel_at, partial_cancel_at +
+
partial_cancel_at, partial_cancel_at::partial_cancel_at +
+
partial_cancel_at_timer, partial_cancel_at_timer +
+
partial_cancel_at_timer, partial_cancel_at_timer::partial_cancel_at_timer +
+
partial_executor_binder, partial_executor_binder +
+
partial_executor_binder, partial_executor_binder::partial_executor_binder +
+
partial_immediate_executor_binder, partial_immediate_executor_binder +
+
partial_immediate_executor_binder, partial_immediate_executor_binder::partial_immediate_executor_binder +
+
partial_redirect_error, partial_redirect_error +
+
partial_redirect_error, partial_redirect_error::partial_redirect_error +
+
passive
+
+
ip::basic_resolver, ip::basic_resolver::passive +
+
ip::basic_resolver_query, ip::basic_resolver_query::passive +
+
ip::resolver_base, ip::resolver_base::passive +
+
ip::resolver_query_base, ip::resolver_query_base::passive +
+
+
password_purpose
+
+
ssl::context, ssl::context::password_purpose +
+
ssl::context_base, ssl::context_base::password_purpose +
+
+
path
+
local::basic_endpoint, local::basic_endpoint::path +
+
peek
+
+
buffered_read_stream, buffered_read_stream::peek +
+
buffered_stream, buffered_stream::peek +
+
buffered_write_stream, buffered_write_stream::peek +
+
+
pem
+
+
ssl::context, ssl::context::file_format +
+
ssl::context_base, ssl::context_base::file_format +
+
+
placeholders::bytes_transferred, placeholders::bytes_transferred +
+
placeholders::endpoint, placeholders::endpoint +
+
placeholders::error, placeholders::error +
+
placeholders::iterator, placeholders::iterator +
+
placeholders::results, placeholders::results +
+
placeholders::signal_number, placeholders::signal_number +
+
pointer
+
+
buffers_iterator, buffers_iterator::pointer +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::pointer +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::pointer +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::pointer +
+
+
poll
+
io_context, io_context::poll +
+
poll_one
+
io_context, io_context::poll_one +
+
polymorphic_query_result_type
+
+
execution::blocking_adaptation_t, execution::blocking_adaptation_t::polymorphic_query_result_type +
+
execution::blocking_adaptation_t::allowed_t, execution::blocking_adaptation_t::allowed_t::polymorphic_query_result_type +
+
execution::blocking_adaptation_t::disallowed_t, execution::blocking_adaptation_t::disallowed_t::polymorphic_query_result_type +
+
execution::blocking_t, execution::blocking_t::polymorphic_query_result_type +
+
execution::blocking_t::always_t, execution::blocking_t::always_t::polymorphic_query_result_type +
+
execution::blocking_t::never_t, execution::blocking_t::never_t::polymorphic_query_result_type +
+
execution::blocking_t::possibly_t, execution::blocking_t::possibly_t::polymorphic_query_result_type +
+
execution::context_as_t, execution::context_as_t::polymorphic_query_result_type +
+
execution::context_t, execution::context_t::polymorphic_query_result_type +
+
execution::mapping_t, execution::mapping_t::polymorphic_query_result_type +
+
execution::mapping_t::new_thread_t, execution::mapping_t::new_thread_t::polymorphic_query_result_type +
+
execution::mapping_t::other_t, execution::mapping_t::other_t::polymorphic_query_result_type +
+
execution::mapping_t::thread_t, execution::mapping_t::thread_t::polymorphic_query_result_type +
+
execution::occupancy_t, execution::occupancy_t::polymorphic_query_result_type +
+
execution::outstanding_work_t, execution::outstanding_work_t::polymorphic_query_result_type +
+
execution::outstanding_work_t::tracked_t, execution::outstanding_work_t::tracked_t::polymorphic_query_result_type +
+
execution::outstanding_work_t::untracked_t, execution::outstanding_work_t::untracked_t::polymorphic_query_result_type +
+
execution::prefer_only, execution::prefer_only::polymorphic_query_result_type +
+
execution::relationship_t, execution::relationship_t::polymorphic_query_result_type +
+
execution::relationship_t::continuation_t, execution::relationship_t::continuation_t::polymorphic_query_result_type +
+
execution::relationship_t::fork_t, execution::relationship_t::fork_t::polymorphic_query_result_type +
+
+
port
+
ip::basic_endpoint, ip::basic_endpoint::port +
+
posix::basic_descriptor, posix::basic_descriptor +
+
posix::basic_descriptor::rebind_executor, posix::basic_descriptor::rebind_executor +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor +
+
posix::basic_stream_descriptor::rebind_executor, posix::basic_stream_descriptor::rebind_executor +
+
posix::descriptor, posix::descriptor +
+
posix::descriptor_base, posix::descriptor_base +
+
posix::stream_descriptor, posix::stream_descriptor +
+
possibly
+
execution::blocking_t, execution::blocking_t::possibly +
+
possibly_t
+
execution::blocking_t::possibly_t, execution::blocking_t::possibly_t::possibly_t +
+
post, post +
+
+
basic_system_executor, basic_system_executor::post +
+
executor, executor::post +
+
io_context::basic_executor_type, io_context::basic_executor_type::post +
+
io_context::strand, io_context::strand::post +
+
strand, strand::post +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::post +
+
+
prefer, prefer +
+
+
any_completion_executor, any_completion_executor::prefer +
+
any_io_executor, any_io_executor::prefer +
+
execution::any_executor, execution::any_executor::prefer +
+
strand, strand::prefer +
+
+
prefer_result, prefer_result +
+
prefix_length
+
+
ip::network_v4, ip::network_v4::prefix_length +
+
ip::network_v6, ip::network_v6::prefix_length +
+
+
prepare
+
+
basic_streambuf, basic_streambuf::prepare +
+
basic_streambuf_ref, basic_streambuf_ref::prepare +
+
dynamic_string_buffer, dynamic_string_buffer::prepare +
+
dynamic_vector_buffer, dynamic_vector_buffer::prepare +
+
+
prepend, prepend +
+
prepend_t, prepend_t +
+
prepend_t, prepend_t::prepend_t +
+
promise
+
experimental::promise, experimental::promise::promise +
+
promise_type
+
experimental::coro, experimental::coro::promise_type +
+
protocol
+
+
generic::basic_endpoint, generic::basic_endpoint::protocol +
+
generic::datagram_protocol, generic::datagram_protocol::protocol +
+
generic::raw_protocol, generic::raw_protocol::protocol +
+
generic::seq_packet_protocol, generic::seq_packet_protocol::protocol +
+
generic::stream_protocol, generic::stream_protocol::protocol +
+
ip::basic_endpoint, ip::basic_endpoint::protocol +
+
ip::icmp, ip::icmp::protocol +
+
ip::tcp, ip::tcp::protocol +
+
ip::udp, ip::udp::protocol +
+
local::basic_endpoint, local::basic_endpoint::protocol +
+
local::datagram_protocol, local::datagram_protocol::protocol +
+
local::seq_packet_protocol, local::seq_packet_protocol::protocol +
+
local::stream_protocol, local::stream_protocol::protocol +
+
+
protocol_type
+
+
basic_datagram_socket, basic_datagram_socket::protocol_type +
+
basic_raw_socket, basic_raw_socket::protocol_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::protocol_type +
+
basic_socket, basic_socket::protocol_type +
+
basic_socket_acceptor, basic_socket_acceptor::protocol_type +
+
basic_socket_iostream, basic_socket_iostream::protocol_type +
+
basic_socket_streambuf, basic_socket_streambuf::protocol_type +
+
basic_stream_socket, basic_stream_socket::protocol_type +
+
generic::basic_endpoint, generic::basic_endpoint::protocol_type +
+
ip::basic_endpoint, ip::basic_endpoint::protocol_type +
+
ip::basic_resolver, ip::basic_resolver::protocol_type +
+
ip::basic_resolver_entry, ip::basic_resolver_entry::protocol_type +
+
ip::basic_resolver_query, ip::basic_resolver_query::protocol_type +
+
ip::basic_resolver_results, ip::basic_resolver_results::protocol_type +
+
local::basic_endpoint, local::basic_endpoint::protocol_type +
+
+
ptr_
+
execution_context::auto_allocator_ptr, execution_context::auto_allocator_ptr::ptr_ +
+
+
+
+

Q

+
+
query, query +
+
+
any_completion_executor, any_completion_executor::query +
+
any_io_executor, any_io_executor::query +
+
basic_system_executor, basic_system_executor::query, basic_system_executor::query +
+
execution::any_executor, execution::any_executor::query +
+
io_context::basic_executor_type, io_context::basic_executor_type::query, io_context::basic_executor_type::query +
+
strand, strand::query +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::query, thread_pool::basic_executor_type::query +
+
+
query_result, query_result +
+
+
+
+

R

+
+
random_access_file, random_access_file +
+
ranged_parallel_group
+
experimental::ranged_parallel_group, experimental::ranged_parallel_group::ranged_parallel_group +
+
raw_protocol
+
generic::raw_protocol, generic::raw_protocol::raw_protocol +
+
rdbuf
+
basic_socket_iostream, basic_socket_iostream::rdbuf +
+
read, read +
+
readable_pipe, readable_pipe +
+
ready
+
+
experimental::basic_channel, experimental::basic_channel::ready +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::ready +
+
+
read_at, read_at +
+
read_only
+
+
basic_file, basic_file::read_only +
+
basic_random_access_file, basic_random_access_file::read_only +
+
basic_stream_file, basic_stream_file::read_only +
+
file_base, file_base::read_only +
+
+
read_some
+
+
basic_readable_pipe, basic_readable_pipe::read_some +
+
basic_serial_port, basic_serial_port::read_some +
+
basic_stream_file, basic_stream_file::read_some +
+
basic_stream_socket, basic_stream_socket::read_some +
+
buffered_read_stream, buffered_read_stream::read_some +
+
buffered_stream, buffered_stream::read_some +
+
buffered_write_stream, buffered_write_stream::read_some +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::read_some +
+
ssl::stream, ssl::stream::read_some +
+
windows::basic_stream_handle, windows::basic_stream_handle::read_some +
+
+
read_some_at
+
+
basic_random_access_file, basic_random_access_file::read_some_at +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::read_some_at +
+
+
read_until, read_until +
+
read_write
+
+
basic_file, basic_file::read_write +
+
basic_random_access_file, basic_random_access_file::read_write +
+
basic_stream_file, basic_stream_file::read_write +
+
file_base, file_base::read_write +
+
+
rebind
+
+
experimental::use_coro_t, experimental::use_coro_t::rebind +
+
experimental::use_promise_t, experimental::use_promise_t::rebind +
+
use_future_t, use_future_t::rebind +
+
+
receive
+
+
basic_datagram_socket, basic_datagram_socket::receive +
+
basic_raw_socket, basic_raw_socket::receive +
+
basic_seq_packet_socket, basic_seq_packet_socket::receive +
+
basic_stream_socket, basic_stream_socket::receive +
+
+
receive_buffer_size
+
+
basic_datagram_socket, basic_datagram_socket::receive_buffer_size +
+
basic_raw_socket, basic_raw_socket::receive_buffer_size +
+
basic_seq_packet_socket, basic_seq_packet_socket::receive_buffer_size +
+
basic_socket, basic_socket::receive_buffer_size +
+
basic_socket_acceptor, basic_socket_acceptor::receive_buffer_size +
+
basic_stream_socket, basic_stream_socket::receive_buffer_size +
+
socket_base, socket_base::receive_buffer_size +
+
+
receive_cancelled_signature
+
experimental::channel_traits, experimental::channel_traits::receive_cancelled_signature +
+
receive_closed_signature
+
experimental::channel_traits, experimental::channel_traits::receive_closed_signature +
+
receive_from
+
+
basic_datagram_socket, basic_datagram_socket::receive_from +
+
basic_raw_socket, basic_raw_socket::receive_from +
+
+
receive_low_watermark
+
+
basic_datagram_socket, basic_datagram_socket::receive_low_watermark +
+
basic_raw_socket, basic_raw_socket::receive_low_watermark +
+
basic_seq_packet_socket, basic_seq_packet_socket::receive_low_watermark +
+
basic_socket, basic_socket::receive_low_watermark +
+
basic_socket_acceptor, basic_socket_acceptor::receive_low_watermark +
+
basic_stream_socket, basic_stream_socket::receive_low_watermark +
+
socket_base, socket_base::receive_low_watermark +
+
+
recycling_allocator, recycling_allocator +
+
+
recycling_allocator, recycling_allocator::recycling_allocator +
+
recycling_allocator< + void >, recycling_allocator< + void >::recycling_allocator +
+
+
recycling_allocator::rebind, recycling_allocator::rebind +
+
recycling_allocator< void + >, recycling_allocator< + void > +
+
recycling_allocator< + void >::rebind, recycling_allocator< + void >::rebind +
+
redirect_error, redirect_error +
+
redirect_error_t, redirect_error_t +
+
redirect_error_t, redirect_error_t::redirect_error_t +
+
reference
+
+
buffers_iterator, buffers_iterator::reference +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::reference +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::reference +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::reference +
+
ip::basic_resolver_results, ip::basic_resolver_results::reference +
+
+
registered_buffer_id, registered_buffer_id +
+
registered_buffer_id, registered_buffer_id::registered_buffer_id +
+
register_buffers, register_buffers +
+
relationship_t
+
execution::relationship_t, execution::relationship_t::relationship_t +
+
release
+
+
basic_datagram_socket, basic_datagram_socket::release +
+
basic_file, basic_file::release +
+
basic_random_access_file, basic_random_access_file::release +
+
basic_raw_socket, basic_raw_socket::release +
+
basic_readable_pipe, basic_readable_pipe::release +
+
basic_seq_packet_socket, basic_seq_packet_socket::release +
+
basic_socket, basic_socket::release +
+
basic_socket_acceptor, basic_socket_acceptor::release +
+
basic_stream_file, basic_stream_file::release +
+
basic_stream_socket, basic_stream_socket::release +
+
basic_writable_pipe, basic_writable_pipe::release +
+
posix::basic_descriptor, posix::basic_descriptor::release +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::release +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle::release +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::release +
+
windows::basic_stream_handle, windows::basic_stream_handle::release +
+
windows::overlapped_ptr, windows::overlapped_ptr::release +
+
+
remote_endpoint
+
+
basic_datagram_socket, basic_datagram_socket::remote_endpoint +
+
basic_raw_socket, basic_raw_socket::remote_endpoint +
+
basic_seq_packet_socket, basic_seq_packet_socket::remote_endpoint +
+
basic_socket, basic_socket::remote_endpoint +
+
basic_stream_socket, basic_stream_socket::remote_endpoint +
+
+
remove
+
basic_signal_set, basic_signal_set::remove +
+
require, require +
+
+
any_completion_executor, any_completion_executor::require +
+
any_io_executor, any_io_executor::require +
+
basic_system_executor, basic_system_executor::require +
+
execution::any_executor, execution::any_executor::require +
+
io_context::basic_executor_type, io_context::basic_executor_type::require +
+
strand, strand::require +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::require +
+
+
require_concept, require_concept +
+
require_concept_result, require_concept_result +
+
require_result, require_result +
+
reserve
+
basic_streambuf, basic_streambuf::reserve +
+
reset
+
+
executor_work_guard, executor_work_guard::reset +
+
experimental::basic_channel, experimental::basic_channel::reset +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::reset +
+
windows::overlapped_ptr, windows::overlapped_ptr::reset +
+
+
reset_cancellation_state
+
basic_yield_context, basic_yield_context::reset_cancellation_state +
+
resize
+
+
basic_file, basic_file::resize +
+
basic_random_access_file, basic_random_access_file::resize +
+
basic_stream_file, basic_stream_file::resize +
+
generic::basic_endpoint, generic::basic_endpoint::resize +
+
ip::basic_endpoint, ip::basic_endpoint::resize +
+
local::basic_endpoint, local::basic_endpoint::resize +
+
+
resolve
+
ip::basic_resolver, ip::basic_resolver::resolve +
+
resolver
+
+
ip::icmp, ip::icmp::resolver +
+
ip::tcp, ip::tcp::resolver +
+
ip::udp, ip::udp::resolver +
+
+
resolver_errc::try_again, resolver_errc::try_again +
+
restart
+
+
basic_signal_set, basic_signal_set::flags +
+
io_context, io_context::restart +
+
signal_set_base, signal_set_base::flags +
+
+
result
+
async_completion, async_completion::result +
+
results_type
+
ip::basic_resolver, ip::basic_resolver::results_type +
+
result_type
+
+
allocator_binder, allocator_binder::result_type +
+
cancellation_slot_binder, cancellation_slot_binder::result_type +
+
executor_binder, executor_binder::result_type +
+
experimental::coro, experimental::coro::result_type +
+
experimental::coro_traits, experimental::coro_traits::result_type +
+
immediate_executor_binder, immediate_executor_binder::result_type +
+
ssl::host_name_verification, ssl::host_name_verification::result_type +
+
+
return_type
+
+
async_result, async_result::return_type +
+
async_result< + std::packaged_task< Result(Args...)>, Signature >, async_result< + std::packaged_task< Result(Args...)>, Signature >::return_type +
+
experimental::coro, experimental::coro::return_type +
+
experimental::coro_traits, experimental::coro_traits::return_type +
+
+
reuse_address
+
+
basic_datagram_socket, basic_datagram_socket::reuse_address +
+
basic_raw_socket, basic_raw_socket::reuse_address +
+
basic_seq_packet_socket, basic_seq_packet_socket::reuse_address +
+
basic_socket, basic_socket::reuse_address +
+
basic_socket_acceptor, basic_socket_acceptor::reuse_address +
+
basic_stream_socket, basic_stream_socket::reuse_address +
+
socket_base, socket_base::reuse_address +
+
+
run
+
io_context, io_context::run +
+
running_in_this_thread
+
+
io_context::basic_executor_type, io_context::basic_executor_type::running_in_this_thread +
+
io_context::strand, io_context::strand::running_in_this_thread +
+
strand, strand::running_in_this_thread +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type::running_in_this_thread +
+
+
run_for
+
io_context, io_context::run_for +
+
run_one
+
io_context, io_context::run_one +
+
run_one_for
+
io_context, io_context::run_one_for +
+
run_one_until
+
io_context, io_context::run_one_until +
+
run_until
+
io_context, io_context::run_until +
+
+
+
+

S

+
+
scope_id
+
ip::address_v6, ip::address_v6::scope_id +
+
second_argument_type
+
+
allocator_binder, allocator_binder::second_argument_type +
+
cancellation_slot_binder, cancellation_slot_binder::second_argument_type +
+
executor_binder, executor_binder::second_argument_type +
+
immediate_executor_binder, immediate_executor_binder::second_argument_type +
+
+
seek
+
basic_stream_file, basic_stream_file::seek +
+
seek_basis
+
+
basic_file, basic_file::seek_basis +
+
basic_random_access_file, basic_random_access_file::seek_basis +
+
basic_stream_file, basic_stream_file::seek_basis +
+
file_base, file_base::seek_basis +
+
+
seek_cur
+
+
basic_file, basic_file::seek_basis +
+
basic_random_access_file, basic_random_access_file::seek_basis +
+
basic_stream_file, basic_stream_file::seek_basis +
+
file_base, file_base::seek_basis +
+
+
seek_end
+
+
basic_file, basic_file::seek_basis +
+
basic_random_access_file, basic_random_access_file::seek_basis +
+
basic_stream_file, basic_stream_file::seek_basis +
+
file_base, file_base::seek_basis +
+
+
seek_set
+
+
basic_file, basic_file::seek_basis +
+
basic_random_access_file, basic_random_access_file::seek_basis +
+
basic_stream_file, basic_stream_file::seek_basis +
+
file_base, file_base::seek_basis +
+
+
send
+
+
basic_datagram_socket, basic_datagram_socket::send +
+
basic_raw_socket, basic_raw_socket::send +
+
basic_seq_packet_socket, basic_seq_packet_socket::send +
+
basic_stream_socket, basic_stream_socket::send +
+
+
send_break
+
basic_serial_port, basic_serial_port::send_break +
+
send_buffer_size
+
+
basic_datagram_socket, basic_datagram_socket::send_buffer_size +
+
basic_raw_socket, basic_raw_socket::send_buffer_size +
+
basic_seq_packet_socket, basic_seq_packet_socket::send_buffer_size +
+
basic_socket, basic_socket::send_buffer_size +
+
basic_socket_acceptor, basic_socket_acceptor::send_buffer_size +
+
basic_stream_socket, basic_stream_socket::send_buffer_size +
+
socket_base, socket_base::send_buffer_size +
+
+
send_low_watermark
+
+
basic_datagram_socket, basic_datagram_socket::send_low_watermark +
+
basic_raw_socket, basic_raw_socket::send_low_watermark +
+
basic_seq_packet_socket, basic_seq_packet_socket::send_low_watermark +
+
basic_socket, basic_socket::send_low_watermark +
+
basic_socket_acceptor, basic_socket_acceptor::send_low_watermark +
+
basic_stream_socket, basic_stream_socket::send_low_watermark +
+
socket_base, socket_base::send_low_watermark +
+
+
send_to
+
+
basic_datagram_socket, basic_datagram_socket::send_to +
+
basic_raw_socket, basic_raw_socket::send_to +
+
+
seq_packet_protocol
+
generic::seq_packet_protocol, generic::seq_packet_protocol::seq_packet_protocol +
+
serial_port, serial_port +
+
serial_port_base, serial_port_base +
+
serial_port_base::baud_rate, serial_port_base::baud_rate +
+
serial_port_base::character_size, serial_port_base::character_size +
+
serial_port_base::flow_control, serial_port_base::flow_control +
+
serial_port_base::parity, serial_port_base::parity +
+
serial_port_base::stop_bits, serial_port_base::stop_bits +
+
server
+
+
ssl::stream, ssl::stream::handshake_type +
+
ssl::stream_base, ssl::stream_base::handshake_type +
+
+
service
+
+
execution_context::service, execution_context::service::service +
+
io_context::service, io_context::service::service +
+
+
service_already_exists, service_already_exists +
+
service_already_exists, service_already_exists::service_already_exists +
+
service_name
+
+
ip::basic_resolver_entry, ip::basic_resolver_entry::service_name +
+
ip::basic_resolver_query, ip::basic_resolver_query::service_name +
+
+
service_not_found
+
error::addrinfo_errors, error::addrinfo_errors +
+
service_type
+
+
basic_io_object, basic_io_object::service_type +
+
basic_io_object< + IoObjectService, true >, basic_io_object< + IoObjectService, true >::service_type +
+
+
setbuf
+
basic_socket_streambuf, basic_socket_streambuf::setbuf +
+
set_default_verify_paths
+
ssl::context, ssl::context::set_default_verify_paths +
+
set_option
+
+
basic_datagram_socket, basic_datagram_socket::set_option +
+
basic_raw_socket, basic_raw_socket::set_option +
+
basic_seq_packet_socket, basic_seq_packet_socket::set_option +
+
basic_serial_port, basic_serial_port::set_option +
+
basic_socket, basic_socket::set_option +
+
basic_socket_acceptor, basic_socket_acceptor::set_option +
+
basic_stream_socket, basic_stream_socket::set_option +
+
+
set_options
+
ssl::context, ssl::context::set_options +
+
set_password_callback
+
ssl::context, ssl::context::set_password_callback +
+
set_verify_callback
+
+
ssl::context, ssl::context::set_verify_callback +
+
ssl::stream, ssl::stream::set_verify_callback +
+
+
set_verify_depth
+
+
ssl::context, ssl::context::set_verify_depth +
+
ssl::stream, ssl::stream::set_verify_depth +
+
+
set_verify_mode
+
+
ssl::context, ssl::context::set_verify_mode +
+
ssl::stream, ssl::stream::set_verify_mode +
+
+
shrink
+
+
dynamic_string_buffer, dynamic_string_buffer::shrink +
+
dynamic_vector_buffer, dynamic_vector_buffer::shrink +
+
+
shutdown
+
+
basic_datagram_socket, basic_datagram_socket::shutdown +
+
basic_raw_socket, basic_raw_socket::shutdown +
+
basic_seq_packet_socket, basic_seq_packet_socket::shutdown +
+
basic_socket, basic_socket::shutdown +
+
basic_stream_socket, basic_stream_socket::shutdown +
+
config_service, config_service::shutdown +
+
execution_context, execution_context::shutdown +
+
execution_context::service, execution_context::service::shutdown +
+
io_context, io_context::shutdown +
+
ssl::stream, ssl::stream::shutdown +
+
system_context, system_context::shutdown +
+
thread_pool, thread_pool::shutdown +
+
+
shutdown_both
+
+
basic_datagram_socket, basic_datagram_socket::shutdown_type +
+
basic_raw_socket, basic_raw_socket::shutdown_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::shutdown_type +
+
basic_socket, basic_socket::shutdown_type +
+
basic_socket_acceptor, basic_socket_acceptor::shutdown_type +
+
basic_stream_socket, basic_stream_socket::shutdown_type +
+
socket_base, socket_base::shutdown_type +
+
+
shutdown_receive
+
+
basic_datagram_socket, basic_datagram_socket::shutdown_type +
+
basic_raw_socket, basic_raw_socket::shutdown_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::shutdown_type +
+
basic_socket, basic_socket::shutdown_type +
+
basic_socket_acceptor, basic_socket_acceptor::shutdown_type +
+
basic_stream_socket, basic_stream_socket::shutdown_type +
+
socket_base, socket_base::shutdown_type +
+
+
shutdown_send
+
+
basic_datagram_socket, basic_datagram_socket::shutdown_type +
+
basic_raw_socket, basic_raw_socket::shutdown_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::shutdown_type +
+
basic_socket, basic_socket::shutdown_type +
+
basic_socket_acceptor, basic_socket_acceptor::shutdown_type +
+
basic_stream_socket, basic_stream_socket::shutdown_type +
+
socket_base, socket_base::shutdown_type +
+
+
shutdown_type
+
+
basic_datagram_socket, basic_datagram_socket::shutdown_type +
+
basic_raw_socket, basic_raw_socket::shutdown_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::shutdown_type +
+
basic_socket, basic_socket::shutdown_type +
+
basic_socket_acceptor, basic_socket_acceptor::shutdown_type +
+
basic_stream_socket, basic_stream_socket::shutdown_type +
+
socket_base, socket_base::shutdown_type +
+
+
shut_down
+
error::basic_errors, error::basic_errors +
+
signal_set, signal_set +
+
signal_set_base, signal_set_base +
+
signature
+
+
experimental::parallel_group, experimental::parallel_group::signature +
+
experimental::ranged_parallel_group, experimental::ranged_parallel_group::signature +
+
+
signature_type
+
+
experimental::coro, experimental::coro::signature_type +
+
experimental::coro_traits, experimental::coro_traits::signature_type +
+
+
single_dh_use
+
+
ssl::context, ssl::context::single_dh_use +
+
ssl::context_base, ssl::context_base::single_dh_use +
+
+
size
+
+
basic_file, basic_file::size +
+
basic_random_access_file, basic_random_access_file::size +
+
basic_streambuf, basic_streambuf::size +
+
basic_streambuf_ref, basic_streambuf_ref::size +
+
basic_stream_file, basic_stream_file::size +
+
buffer_registration, buffer_registration::size +
+
const_buffer, const_buffer::size +
+
const_registered_buffer, const_registered_buffer::size +
+
dynamic_string_buffer, dynamic_string_buffer::size +
+
dynamic_vector_buffer, dynamic_vector_buffer::size +
+
generic::basic_endpoint, generic::basic_endpoint::size +
+
ip::basic_address_range< + address_v4 >, ip::basic_address_range< + address_v4 >::size +
+
ip::basic_endpoint, ip::basic_endpoint::size +
+
ip::basic_resolver_results, ip::basic_resolver_results::size +
+
local::basic_endpoint, local::basic_endpoint::size +
+
mutable_buffer, mutable_buffer::size +
+
mutable_registered_buffer, mutable_registered_buffer::size +
+
+
size_type
+
ip::basic_resolver_results, ip::basic_resolver_results::size_type +
+
slot
+
+
cancellation_signal, cancellation_signal::slot +
+
cancellation_state, cancellation_state::slot +
+
+
socket
+
+
basic_socket_iostream, basic_socket_iostream::socket +
+
basic_socket_streambuf, basic_socket_streambuf::socket +
+
generic::datagram_protocol, generic::datagram_protocol::socket +
+
generic::raw_protocol, generic::raw_protocol::socket +
+
generic::seq_packet_protocol, generic::seq_packet_protocol::socket +
+
generic::stream_protocol, generic::stream_protocol::socket +
+
ip::icmp, ip::icmp::socket +
+
ip::tcp, ip::tcp::socket +
+
ip::udp, ip::udp::socket +
+
local::datagram_protocol, local::datagram_protocol::socket +
+
local::seq_packet_protocol, local::seq_packet_protocol::socket +
+
local::stream_protocol, local::stream_protocol::socket +
+
+
socket_base, socket_base +
+
socket_type_not_supported
+
error::addrinfo_errors, error::addrinfo_errors +
+
software
+
serial_port_base::flow_control, serial_port_base::flow_control::type +
+
spawn, spawn +
+
ssl
+
ssl::stream::impl_struct, ssl::stream::impl_struct::ssl +
+
ssl::context, ssl::context +
+
ssl::context_base, ssl::context_base +
+
ssl::error::get_stream_category, ssl::error::get_stream_category +
+
ssl::error::make_error_code, ssl::error::make_error_code +
+
ssl::error::stream_category, ssl::error::stream_category +
+
ssl::error::stream_errors, ssl::error::stream_errors +
+
ssl::error::stream_errors >, ssl::error::stream_errors + > +
+
ssl::host_name_verification, ssl::host_name_verification +
+
ssl::stream, ssl::stream +
+
ssl::stream::impl_struct, ssl::stream::impl_struct +
+
ssl::stream_base, ssl::stream_base +
+
ssl::verify_client_once, ssl::verify_client_once +
+
ssl::verify_context, ssl::verify_context +
+
ssl::verify_fail_if_no_peer_cert, ssl::verify_fail_if_no_peer_cert +
+
ssl::verify_mode, ssl::verify_mode +
+
ssl::verify_none, ssl::verify_none +
+
ssl::verify_peer, ssl::verify_peer +
+
sslv2
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv23
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv23_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv23_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv2_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv2_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv3
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv3_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
sslv3_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
static_thread_pool, static_thread_pool +
+
steady_timer, steady_timer +
+
stop
+
+
io_context, io_context::stop +
+
system_context, system_context::stop +
+
thread_pool, thread_pool::stop +
+
+
stopped
+
+
io_context, io_context::stopped +
+
system_context, system_context::stopped +
+
+
stop_bits
+
serial_port_base::stop_bits, serial_port_base::stop_bits::stop_bits +
+
store
+
+
serial_port_base::baud_rate, serial_port_base::baud_rate::store +
+
serial_port_base::character_size, serial_port_base::character_size::store +
+
serial_port_base::flow_control, serial_port_base::flow_control::store +
+
serial_port_base::parity, serial_port_base::parity::store +
+
serial_port_base::stop_bits, serial_port_base::stop_bits::store +
+
+
strand, strand +
+
+
io_context::strand, io_context::strand::strand +
+
strand, strand::strand +
+
+
stream
+
ssl::stream, ssl::stream::stream +
+
streambuf, streambuf +
+
stream_file, stream_file +
+
stream_protocol
+
generic::stream_protocol, generic::stream_protocol::stream_protocol +
+
stream_truncated
+
ssl::error::stream_errors, ssl::error::stream_errors +
+
subtract
+
time_traits< + boost::posix_time::ptime >, time_traits< + boost::posix_time::ptime >::subtract +
+
swap
+
+
any_completion_executor, any_completion_executor::swap +
+
any_completion_handler, any_completion_handler::swap +
+
any_io_executor, any_io_executor::swap +
+
execution::any_executor, execution::any_executor::swap +
+
ip::basic_resolver_results, ip::basic_resolver_results::swap +
+
+
sync
+
basic_socket_streambuf, basic_socket_streambuf::sync +
+
sync_all
+
+
basic_file, basic_file::sync_all +
+
basic_random_access_file, basic_random_access_file::sync_all +
+
basic_stream_file, basic_stream_file::sync_all +
+
+
sync_all_on_write
+
+
basic_file, basic_file::sync_all_on_write +
+
basic_random_access_file, basic_random_access_file::sync_all_on_write +
+
basic_stream_file, basic_stream_file::sync_all_on_write +
+
file_base, file_base::sync_all_on_write +
+
+
sync_data
+
+
basic_file, basic_file::sync_data +
+
basic_random_access_file, basic_random_access_file::sync_data +
+
basic_stream_file, basic_stream_file::sync_data +
+
+
system_category, system_category +
+
system_context, system_context +
+
system_error, system_error +
+
system_executor, system_executor +
+
system_timer, system_timer +
+
+
+
+

T

+
+
target
+
+
any_completion_executor, any_completion_executor::target +
+
any_io_executor, any_io_executor::target +
+
execution::any_executor, execution::any_executor::target +
+
executor, executor::target +
+
+
target_type
+
+
allocator_binder, allocator_binder::target_type +
+
any_completion_executor, any_completion_executor::target_type +
+
any_io_executor, any_io_executor::target_type +
+
cancellation_slot_binder, cancellation_slot_binder::target_type +
+
execution::any_executor, execution::any_executor::target_type +
+
executor, executor::target_type +
+
executor_binder, executor_binder::target_type +
+
immediate_executor_binder, immediate_executor_binder::target_type +
+
+
terminal
+
cancellation_type, cancellation_type +
+
then
+
deferred_conditional, deferred_conditional::then +
+
this_coro::cancellation_state, this_coro::cancellation_state +
+
this_coro::cancellation_state_t, this_coro::cancellation_state_t +
+
this_coro::executor, this_coro::executor +
+
this_coro::executor_t, this_coro::executor_t +
+
this_coro::reset_cancellation_state, this_coro::reset_cancellation_state +
+
this_coro::throw_if_cancelled, this_coro::throw_if_cancelled +
+
thread, thread +
+
+
execution::mapping_t, execution::mapping_t::thread +
+
thread, thread::thread +
+
+
thread_pool, thread_pool +
+
thread_pool, thread_pool::thread_pool +
+
thread_pool::basic_executor_type, thread_pool::basic_executor_type +
+
thread_t
+
execution::mapping_t::thread_t, execution::mapping_t::thread_t::thread_t +
+
throw_exception, throw_exception +
+
+
disposition_traits, disposition_traits::throw_exception +
+
disposition_traits< + asio::error_code >, disposition_traits< + asio::error_code >::throw_exception +
+
disposition_traits< + no_error_t >, disposition_traits< + no_error_t >::throw_exception +
+
disposition_traits< + std::exception_ptr >, disposition_traits< + std::exception_ptr >::throw_exception +
+
+
throw_if_cancelled
+
basic_yield_context, basic_yield_context::throw_if_cancelled +
+
timed_out
+
error::basic_errors, error::basic_errors +
+
timeout_
+
+
cancel_after_t, cancel_after_t::timeout_ +
+
cancel_after_timer, cancel_after_timer::timeout_ +
+
partial_cancel_after, partial_cancel_after::timeout_ +
+
partial_cancel_after_timer, partial_cancel_after_timer::timeout_ +
+
+
timer_
+
+
cancel_after_timer, cancel_after_timer::timer_ +
+
cancel_at_timer, cancel_at_timer::timer_ +
+
partial_cancel_after_timer, partial_cancel_after_timer::timer_ +
+
partial_cancel_at_timer, partial_cancel_at_timer::timer_ +
+
+
time_point
+
+
basic_socket_iostream, basic_socket_iostream::time_point +
+
basic_socket_streambuf, basic_socket_streambuf::time_point +
+
basic_waitable_timer, basic_waitable_timer::time_point +
+
+
time_traits, time_traits +
+
time_traits< boost::posix_time::ptime + >, time_traits< + boost::posix_time::ptime > +
+
time_type
+
+
basic_deadline_timer, basic_deadline_timer::time_type +
+
time_traits< + boost::posix_time::ptime >, time_traits< + boost::posix_time::ptime >::time_type +
+
+
tls
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv1
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv11
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv11_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv11_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv12
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv12_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv12_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv13
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv13_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv13_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv1_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tlsv1_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tls_client
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
tls_server
+
+
ssl::context, ssl::context::method +
+
ssl::context_base, ssl::context_base::method +
+
+
token_
+
+
append_t, append_t::token_ +
+
as_tuple_t, as_tuple_t::token_ +
+
cancel_after_t, cancel_after_t::token_ +
+
cancel_after_timer, cancel_after_timer::token_ +
+
cancel_at_t, cancel_at_t::token_ +
+
cancel_at_timer, cancel_at_timer::token_ +
+
experimental::as_single_t, experimental::as_single_t::token_ +
+
prepend_t, prepend_t::token_ +
+
redirect_error_t, redirect_error_t::token_ +
+
+
total
+
cancellation_type, cancellation_type +
+
to_bytes
+
+
ip::address_v4, ip::address_v4::to_bytes +
+
ip::address_v6, ip::address_v6::to_bytes +
+
+
to_exception_ptr, to_exception_ptr +
+
+
disposition_traits, disposition_traits::to_exception_ptr +
+
disposition_traits< + asio::error_code >, disposition_traits< + asio::error_code >::to_exception_ptr +
+
disposition_traits< + no_error_t >, disposition_traits< + no_error_t >::to_exception_ptr +
+
disposition_traits< + std::exception_ptr >, disposition_traits< + std::exception_ptr >::to_exception_ptr +
+
+
to_posix_duration
+
time_traits< + boost::posix_time::ptime >, time_traits< + boost::posix_time::ptime >::to_posix_duration +
+
to_string
+
+
ip::address, ip::address::to_string +
+
ip::address_v4, ip::address_v4::to_string +
+
ip::address_v6, ip::address_v6::to_string +
+
ip::network_v4, ip::network_v4::to_string +
+
ip::network_v6, ip::network_v6::to_string +
+
+
to_uint
+
ip::address_v4, ip::address_v4::to_uint +
+
to_v4
+
ip::address, ip::address::to_v4 +
+
to_v6
+
ip::address, ip::address::to_v6 +
+
to_wait_duration
+
wait_traits, wait_traits::to_wait_duration +
+
tracked
+
execution::outstanding_work_t, execution::outstanding_work_t::tracked +
+
tracked_t
+
execution::outstanding_work_t::tracked_t, execution::outstanding_work_t::tracked_t::tracked_t +
+
traits
+
experimental::coro, experimental::coro::traits +
+
traits_type
+
+
basic_deadline_timer, basic_deadline_timer::traits_type +
+
basic_waitable_timer, basic_waitable_timer::traits_type +
+
experimental::basic_channel, experimental::basic_channel::traits_type +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::traits_type +
+
+
transfer_all, transfer_all +
+
transfer_at_least, transfer_at_least +
+
transfer_exactly, transfer_exactly +
+
truncate
+
+
basic_file, basic_file::truncate +
+
basic_random_access_file, basic_random_access_file::truncate +
+
basic_stream_file, basic_stream_file::truncate +
+
file_base, file_base::truncate +
+
+
try_again
+
error::basic_errors, error::basic_errors +
+
try_receive
+
+
experimental::basic_channel, experimental::basic_channel::try_receive +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::try_receive +
+
+
try_send
+
+
experimental::basic_channel, experimental::basic_channel::try_send +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::try_send +
+
+
try_send_n
+
+
experimental::basic_channel, experimental::basic_channel::try_send_n +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::try_send_n +
+
+
try_send_n_via_dispatch
+
+
experimental::basic_channel, experimental::basic_channel::try_send_n_via_dispatch +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::try_send_n_via_dispatch +
+
+
try_send_via_dispatch
+
+
experimental::basic_channel, experimental::basic_channel::try_send_via_dispatch +
+
experimental::basic_concurrent_channel, experimental::basic_concurrent_channel::try_send_via_dispatch +
+
+
two
+
serial_port_base::stop_bits, serial_port_base::stop_bits::type +
+
type
+
+
associated_allocator, associated_allocator::type +
+
associated_allocator< + reference_wrapper< T >, Allocator >, associated_allocator< + reference_wrapper< T >, Allocator >::type +
+
associated_cancellation_slot, associated_cancellation_slot::type +
+
associated_cancellation_slot< + reference_wrapper< T >, CancellationSlot >, associated_cancellation_slot< + reference_wrapper< T >, CancellationSlot >::type +
+
associated_executor, associated_executor::type +
+
associated_executor< + reference_wrapper< T >, Executor >, associated_executor< + reference_wrapper< T >, Executor >::type +
+
associated_immediate_executor, associated_immediate_executor::type +
+
associated_immediate_executor< + reference_wrapper< T >, Executor >, associated_immediate_executor< + reference_wrapper< T >, Executor >::type +
+
completion_signature_of, completion_signature_of::type +
+
default_completion_token, default_completion_token::type +
+
experimental::channel_traits::container, experimental::channel_traits::container::type +
+
experimental::promise_value_type, experimental::promise_value_type::type +
+
experimental::promise_value_type< + T >, experimental::promise_value_type< + T >::type +
+
experimental::promise_value_type<>, experimental::promise_value_type<>::type +
+
generic::datagram_protocol, generic::datagram_protocol::type +
+
generic::raw_protocol, generic::raw_protocol::type +
+
generic::seq_packet_protocol, generic::seq_packet_protocol::type +
+
generic::stream_protocol, generic::stream_protocol::type +
+
ip::icmp, ip::icmp::type +
+
ip::tcp, ip::tcp::type +
+
ip::udp, ip::udp::type +
+
local::datagram_protocol, local::datagram_protocol::type +
+
local::seq_packet_protocol, local::seq_packet_protocol::type +
+
local::stream_protocol, local::stream_protocol::type +
+
prefer_result, prefer_result::type +
+
query_result, query_result::type +
+
require_concept_result, require_concept_result::type +
+
require_result, require_result::type +
+
serial_port_base::flow_control, serial_port_base::flow_control::type +
+
serial_port_base::parity, serial_port_base::parity::type +
+
serial_port_base::stop_bits, serial_port_base::stop_bits::type +
+
+
+
+
+

U

+
+
uint_type
+
ip::address_v4, ip::address_v4::uint_type +
+
underflow
+
+
basic_socket_streambuf, basic_socket_streambuf::underflow +
+
basic_streambuf, basic_streambuf::underflow +
+
+
unexpected_result
+
ssl::error::stream_errors, ssl::error::stream_errors +
+
unspecified_bool_true
+
executor, executor::unspecified_bool_true +
+
unspecified_bool_type
+
executor, executor::unspecified_bool_type +
+
unspecified_system_error
+
ssl::error::stream_errors, ssl::error::stream_errors +
+
untracked
+
execution::outstanding_work_t, execution::outstanding_work_t::untracked +
+
untracked_t
+
execution::outstanding_work_t::untracked_t, execution::outstanding_work_t::untracked_t::untracked_t +
+
uses_executor, uses_executor +
+
use_awaitable, use_awaitable +
+
use_awaitable_t, use_awaitable_t +
+
use_awaitable_t, use_awaitable_t::use_awaitable_t +
+
use_awaitable_t::executor_with_default, use_awaitable_t::executor_with_default +
+
use_certificate
+
ssl::context, ssl::context::use_certificate +
+
use_certificate_chain
+
ssl::context, ssl::context::use_certificate_chain +
+
use_certificate_chain_file
+
ssl::context, ssl::context::use_certificate_chain_file +
+
use_certificate_file
+
ssl::context, ssl::context::use_certificate_file +
+
use_coro_t
+
experimental::use_coro_t, experimental::use_coro_t::use_coro_t +
+
use_future, use_future +
+
use_future_t, use_future_t +
+
use_future_t, use_future_t::use_future_t +
+
use_private_key
+
ssl::context, ssl::context::use_private_key +
+
use_private_key_file
+
ssl::context, ssl::context::use_private_key_file +
+
use_promise_t
+
experimental::use_promise_t, experimental::use_promise_t::use_promise_t +
+
use_rsa_private_key
+
ssl::context, ssl::context::use_rsa_private_key +
+
use_rsa_private_key_file
+
ssl::context, ssl::context::use_rsa_private_key_file +
+
use_service
+
+
execution_context, execution_context::use_service +
+
io_context, io_context::use_service +
+
+
use_tmp_dh
+
ssl::context, ssl::context::use_tmp_dh +
+
use_tmp_dh_file
+
ssl::context, ssl::context::use_tmp_dh_file +
+
+
+
+

V

+
+
v4
+
+
ip::icmp, ip::icmp::v4 +
+
ip::tcp, ip::tcp::v4 +
+
ip::udp, ip::udp::v4 +
+
+
v4_mapped
+
+
ip::basic_resolver, ip::basic_resolver::v4_mapped +
+
ip::basic_resolver_query, ip::basic_resolver_query::v4_mapped +
+
ip::resolver_base, ip::resolver_base::v4_mapped +
+
ip::resolver_query_base, ip::resolver_query_base::v4_mapped +
+
ip::v4_mapped_t, ip::v4_mapped_t +
+
+
v6
+
+
ip::icmp, ip::icmp::v6 +
+
ip::tcp, ip::tcp::v6 +
+
ip::udp, ip::udp::v6 +
+
+
valid
+
awaitable, awaitable::valid +
+
value
+
+
error::addrinfo_errors + >, error::addrinfo_errors + >::value +
+
error::basic_errors >, error::basic_errors + >::value +
+
error::misc_errors >, error::misc_errors + >::value +
+
error::netdb_errors >, error::netdb_errors + >::value +
+
error::ssl_errors >, error::ssl_errors + >::value +
+
execution::allocator_t, execution::allocator_t::value +
+
execution::blocking_adaptation_t::allowed_t, execution::blocking_adaptation_t::allowed_t::value +
+
execution::blocking_adaptation_t::disallowed_t, execution::blocking_adaptation_t::disallowed_t::value +
+
execution::blocking_t::always_t, execution::blocking_t::always_t::value +
+
execution::blocking_t::never_t, execution::blocking_t::never_t::value +
+
execution::blocking_t::possibly_t, execution::blocking_t::possibly_t::value +
+
execution::mapping_t::new_thread_t, execution::mapping_t::new_thread_t::value +
+
execution::mapping_t::other_t, execution::mapping_t::other_t::value +
+
execution::mapping_t::thread_t, execution::mapping_t::thread_t::value +
+
execution::outstanding_work_t::tracked_t, execution::outstanding_work_t::tracked_t::value +
+
execution::outstanding_work_t::untracked_t, execution::outstanding_work_t::untracked_t::value +
+
execution::relationship_t::continuation_t, execution::relationship_t::continuation_t::value +
+
execution::relationship_t::fork_t, execution::relationship_t::fork_t::value +
+
experimental::error::channel_errors + >, experimental::error::channel_errors + >::value +
+
experimental::is_async_operation_range, experimental::is_async_operation_range::value +
+
is_completion_condition, is_completion_condition::value +
+
is_connect_condition, is_connect_condition::value +
+
is_endpoint_sequence, is_endpoint_sequence::value +
+
is_match_condition, is_match_condition::value +
+
is_read_buffered, is_read_buffered::value +
+
is_write_buffered, is_write_buffered::value +
+
serial_port_base::baud_rate, serial_port_base::baud_rate::value +
+
serial_port_base::character_size, serial_port_base::character_size::value +
+
serial_port_base::flow_control, serial_port_base::flow_control::value +
+
serial_port_base::parity, serial_port_base::parity::value +
+
serial_port_base::stop_bits, serial_port_base::stop_bits::value +
+
ssl::error::stream_errors + >, ssl::error::stream_errors + >::value +
+
+
values
+
deferred_t, deferred_t::values +
+
values_
+
+
append_t, append_t::values_ +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::values_ +
+
prepend_t, prepend_t::values_ +
+
+
value_type
+
+
any_completion_handler_allocator, any_completion_handler_allocator::value_type +
+
any_completion_handler_allocator< + void, Signatures... >, any_completion_handler_allocator< + void, Signatures... >::value_type +
+
awaitable, awaitable::value_type +
+
buffers_iterator, buffers_iterator::value_type +
+
execution_context::allocator, execution_context::allocator::value_type +
+
execution_context::allocator< + void >, execution_context::allocator< + void >::value_type +
+
experimental::promise, experimental::promise::value_type +
+
ip::basic_address_iterator< + address_v4 >, ip::basic_address_iterator< + address_v4 >::value_type +
+
ip::basic_address_iterator< + address_v6 >, ip::basic_address_iterator< + address_v6 >::value_type +
+
ip::basic_resolver_iterator, ip::basic_resolver_iterator::value_type +
+
ip::basic_resolver_results, ip::basic_resolver_results::value_type +
+
null_buffers, null_buffers::value_type +
+
recycling_allocator, recycling_allocator::value_type +
+
recycling_allocator< + void >, recycling_allocator< + void >::value_type +
+
+
verify_context
+
ssl::verify_context, ssl::verify_context::verify_context +
+
+
+
+

W

+
+
wait
+
+
basic_datagram_socket, basic_datagram_socket::wait +
+
basic_deadline_timer, basic_deadline_timer::wait +
+
basic_raw_socket, basic_raw_socket::wait +
+
basic_seq_packet_socket, basic_seq_packet_socket::wait +
+
basic_socket, basic_socket::wait +
+
basic_socket_acceptor, basic_socket_acceptor::wait +
+
basic_stream_socket, basic_stream_socket::wait +
+
basic_waitable_timer, basic_waitable_timer::wait +
+
posix::basic_descriptor, posix::basic_descriptor::wait +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::wait +
+
thread_pool, thread_pool::wait +
+
windows::basic_object_handle, windows::basic_object_handle::wait +
+
+
wait_error
+
+
basic_datagram_socket, basic_datagram_socket::wait_type +
+
basic_raw_socket, basic_raw_socket::wait_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::wait_type +
+
basic_socket, basic_socket::wait_type +
+
basic_socket_acceptor, basic_socket_acceptor::wait_type +
+
basic_stream_socket, basic_stream_socket::wait_type +
+
posix::basic_descriptor, posix::basic_descriptor::wait_type +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::wait_type +
+
posix::descriptor_base, posix::descriptor_base::wait_type +
+
socket_base, socket_base::wait_type +
+
+
wait_for_one
+
experimental::wait_for_one, experimental::wait_for_one::wait_for_one +
+
wait_for_one_error
+
experimental::wait_for_one_error, experimental::wait_for_one_error::wait_for_one_error +
+
wait_for_one_success
+
experimental::wait_for_one_success, experimental::wait_for_one_success::wait_for_one_success +
+
wait_read
+
+
basic_datagram_socket, basic_datagram_socket::wait_type +
+
basic_raw_socket, basic_raw_socket::wait_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::wait_type +
+
basic_socket, basic_socket::wait_type +
+
basic_socket_acceptor, basic_socket_acceptor::wait_type +
+
basic_stream_socket, basic_stream_socket::wait_type +
+
posix::basic_descriptor, posix::basic_descriptor::wait_type +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::wait_type +
+
posix::descriptor_base, posix::descriptor_base::wait_type +
+
socket_base, socket_base::wait_type +
+
+
wait_traits, wait_traits +
+
wait_type
+
+
basic_datagram_socket, basic_datagram_socket::wait_type +
+
basic_raw_socket, basic_raw_socket::wait_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::wait_type +
+
basic_socket, basic_socket::wait_type +
+
basic_socket_acceptor, basic_socket_acceptor::wait_type +
+
basic_stream_socket, basic_stream_socket::wait_type +
+
posix::basic_descriptor, posix::basic_descriptor::wait_type +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::wait_type +
+
posix::descriptor_base, posix::descriptor_base::wait_type +
+
socket_base, socket_base::wait_type +
+
+
wait_write
+
+
basic_datagram_socket, basic_datagram_socket::wait_type +
+
basic_raw_socket, basic_raw_socket::wait_type +
+
basic_seq_packet_socket, basic_seq_packet_socket::wait_type +
+
basic_socket, basic_socket::wait_type +
+
basic_socket_acceptor, basic_socket_acceptor::wait_type +
+
basic_stream_socket, basic_stream_socket::wait_type +
+
posix::basic_descriptor, posix::basic_descriptor::wait_type +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::wait_type +
+
posix::descriptor_base, posix::descriptor_base::wait_type +
+
socket_base, socket_base::wait_type +
+
+
what
+
+
bad_executor, bad_executor::what +
+
execution::bad_executor, execution::bad_executor::what +
+
ip::bad_address_cast, ip::bad_address_cast::what +
+
multiple_exceptions, multiple_exceptions::what +
+
+
when
+
deferred_t, deferred_t::when +
+
windows::basic_object_handle, windows::basic_object_handle +
+
windows::basic_object_handle::rebind_executor, windows::basic_object_handle::rebind_executor +
+
windows::basic_overlapped_handle, windows::basic_overlapped_handle +
+
windows::basic_overlapped_handle::rebind_executor, windows::basic_overlapped_handle::rebind_executor +
+
windows::basic_random_access_handle, windows::basic_random_access_handle +
+
windows::basic_random_access_handle::rebind_executor, windows::basic_random_access_handle::rebind_executor +
+
windows::basic_stream_handle, windows::basic_stream_handle +
+
windows::basic_stream_handle::rebind_executor, windows::basic_stream_handle::rebind_executor +
+
windows::object_handle, windows::object_handle +
+
windows::overlapped_handle, windows::overlapped_handle +
+
windows::overlapped_ptr, windows::overlapped_ptr +
+
windows::random_access_handle, windows::random_access_handle +
+
windows::stream_handle, windows::stream_handle +
+
would_block
+
error::basic_errors, error::basic_errors +
+
wrap
+
+
io_context, io_context::wrap +
+
io_context::strand, io_context::strand::wrap +
+
+
writable_pipe, writable_pipe +
+
write, write +
+
write_at, write_at +
+
write_only
+
+
basic_file, basic_file::write_only +
+
basic_random_access_file, basic_random_access_file::write_only +
+
basic_stream_file, basic_stream_file::write_only +
+
file_base, file_base::write_only +
+
+
write_some
+
+
basic_serial_port, basic_serial_port::write_some +
+
basic_stream_file, basic_stream_file::write_some +
+
basic_stream_socket, basic_stream_socket::write_some +
+
basic_writable_pipe, basic_writable_pipe::write_some +
+
buffered_read_stream, buffered_read_stream::write_some +
+
buffered_stream, buffered_stream::write_some +
+
buffered_write_stream, buffered_write_stream::write_some +
+
posix::basic_stream_descriptor, posix::basic_stream_descriptor::write_some +
+
ssl::stream, ssl::stream::write_some +
+
windows::basic_stream_handle, windows::basic_stream_handle::write_some +
+
+
write_some_at
+
+
basic_random_access_file, basic_random_access_file::write_some_at +
+
windows::basic_random_access_handle, windows::basic_random_access_handle::write_some_at +
+
+
+
+
+

Y

+
+
yield_context, yield_context +
+
yield_type
+
+
experimental::coro, experimental::coro::yield_type +
+
experimental::coro_traits, experimental::coro_traits::yield_type +
+
+
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHome +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/net_ts.html b/Packages/asio-1.36.0/doc/asio/net_ts.html new file mode 100644 index 0000000..3ed7dca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/net_ts.html @@ -0,0 +1,1221 @@ + + + +Networking TS compatibility + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio now provides the interfaces and functionality specified by the "C++ + Extensions for Networking" Technical Specification. In addition to access + via the usual Asio header files, this functionality may be accessed through + special headers that correspond to the header files defined in the TS. These + are listed in the table below: +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Networking TS header +

+ 		+

+ Asio header +

+
+

+ #include <buffer> +

+ 		+

+ #include <asio/ts/buffer.hpp> +

+
+

+ #include <executor> +

+ 		+

+ #include <asio/ts/executor.hpp> +

+
+

+ #include <internet> +

+ 		+

+ #include <asio/ts/internet.hpp> +

+
+

+ #include <io_context> +

+ 		+

+ #include <asio/ts/io_context.hpp> +

+
+

+ #include <net> +

+ 		+

+ #include <asio/ts/net.hpp> +

+
+

+ #include <netfwd> +

+ 		+

+ #include <asio/ts/netfwd.hpp> +

+
+

+ #include <socket> +

+ 		+

+ #include <asio/ts/socket.hpp> +

+
+

+ #include <timer> +

+ 		+

+ #include <asio/ts/timer.hpp> +

+
+

+ In some cases the new Networking TS compatible interfaces supersede older Asio + facilities. In these cases the older interfaces have been deprecated. The table + below shows the new Networking TS interfaces and the facilities they replace: +

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ New interface +

+ 		+

+ Old interface +

+ 		+

+ Notes +

+
+

+ io_context +

+ 		+

+ io_service +

+ 		+

+ The name io_service + is retained as a typedef. +

+
+

+ dispatch +

+ 		+

+ io_service::dispatch +

+ 		+

+ The dispatch free + function can be used to submit functions to any Executor + or ExecutionContext. +

+
+

+ post +

+ 		+

+ io_service::post +

+ 		+

+ The post free function + can be used to submit functions to any Executor + or ExecutionContext. +

+
+

+ defer +

+ 		+

+ io_service::post when the asio_handler_is_continuation + hook returns true +

+ 		+

+ The defer free function + can be used to submit functions to any Executor + or ExecutionContext. +

+
+

+ io_context::poll +

+ 		+

+ io_service::poll overload that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ io_context::poll_one +

+ 		+

+ io_service::poll_one overload that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ io_context::run +

+ 		+

+ io_service::run overload that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ io_context::run_one +

+ 		+

+ io_service::run_one overload that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ io_context::run_for, + io_context::run_until, io_context::run_one_for, and io_context::run_one_until +

+ 		+ +

+ These functions add the ability to run an io_context + for a limited time. +

+
+

+ io_context::restart +

+ 		+

+ io_service::reset +

+ 		+
+

+ io_context constructor + concurrency_hint + parameter is type int +

+ 		+

+ io_context constructor + concurrency_hint + parameter is type std::size_t +

+ 		+
+

+ execution_context, + execution_context::service, and execution_context::id +

+ 		+

+ io_service, io_service::service, and io_service::id +

+ 		+

+ The service-related functionality has been moved to the execution_context base class. This + may also be used as a base for creating custom execution contexts. +

+
+

+ make_service +

+ 		+

+ add_service +

+ 		+
+

+ strand +

+ 		+

+ io_service::strand +

+ 		+

+ This template works with any valid executor, and is itself a valid + executor. +

+
+

+ executor_work_guard and + make_work_guard +

+ 		+

+ io_service::work +

+ 		+

+ Work tracking is now covered by the Executor + requirements. These templates work with any valid executor. +

+
+

+ executor_binder + and bind_executor +

+ 		+

+ io_service::wrap and io_service::strand::wrap +

+ 		+

+ These templates work with any valid executor. +

+
+

+ async_result + with CompletionToken + and Signature template + parameters +

+ 		+

+ handler_type and + single parameter async_result +

+ 		+

+ The async_result + trait is now the single point of customisation for asynchronous operation + completion handlers and return type. +

+
+

+ associated_executor and + get_associated_executor +

+ 		+

+ asio_handler_invoke +

+ 		+

+ The handler invocation hook has been replaced by the new Executor + requirements and the associated executor traits. +

+
+

+ associated_allocator and + get_associated_allocator +

+ 		+

+ asio_handler_allocate + and asio_handler_deallocate +

+ 		+

+ The handler allocation hooks have been replaced by the standard Allocator + requirements and the associated allocator traits. +

+
+

+ const_buffer::data + and mutable_buffer::data +

+ 		+

+ buffer_cast +

+ 		+
+

+ const_buffer::size + and mutable_buffer::size +

+ 		+

+ buffer_size + for single buffers +

+ 		+

+ buffer_size is not + deprecated for single buffers as const_buffer + and mutable_buffer + now satisfy the buffer sequence requirements +

+
+

+ const_buffer +

+ 		+

+ const_buffers_1 +

+ 		+

+ The ConstBufferSequence + requirements have been modified such that const_buffer + now satisfies them. +

+
+

+ mutable_buffer +

+ 		+

+ mutable_buffers_1 +

+ 		+

+ The MutableBufferSequence + requirements have been modified such that mutable_buffer + now satisfies them. +

+
+

+ basic_socket::get_executor (and corresponding + member for I/O objects such as timers, serial ports, etc.) +

+ 		+

+ basic_io_object::get_io_service +

+ 		+

+ Use get_executor().context() to obtain the associated io_context. +

+
+

+ socket_base::max_listen_connections +

+ 		+

+ socket_base::max_connections +

+ 		+
+

+ socket_base::wait_type, basic_socket::wait, basic_socket::async_wait, basic_socket_acceptor::wait, and basic_socket_acceptor::async_wait +

+ 		+

+ null_buffers +

+ 		+

+ Operations for reactive I/O. +

+
+

+ basic_socket_acceptor::accept returns a socket +

+ 		+

+ basic_socket_acceptor::accept takes a socket by + reference +

+ 		+

+ Uses move support so requires C++11 or later. To accept a connection + into a socket object on a different io_context, + pass the destination context to accept. +

+
+

+ basic_socket_acceptor::async_accept passes socket + to handler +

+ 		+

+ basic_socket_acceptor::async_accept takes a socket + by reference +

+ 		+

+ Uses move support so requires C++11 or later. To accept a connection + into a socket object on a different io_context, + pass the destination context to async_accept. +

+
+

+ connect + overloads that take a range +

+ 		+

+ connect + overloads that take a single iterator +

+ 		+

+ The ip::basic_resolver::resolve function now returns + a range. When the resolve + function's result is passed directly to connect, + the range overload will be selected. +

+
+

+ async_connect + overloads that take a range +

+ 		+

+ async_connect + overloads that take a single iterator +

+ 		+

+ The ip::basic_resolver::resolve function now returns + a range. When the resolve + function's result is passed directly to async_connect, + the range overload will be selected. +

+
+

+ basic_socket_streambuf::duration +

+ 		+

+ basic_socket_streambuf::duration_type +

+ 		+
+

+ basic_socket_streambuf::time_point +

+ 		+

+ basic_socket_streambuf::time_type +

+ 		+
+

+ basic_socket_streambuf::expiry +

+ 		+

+ basic_socket_streambuf::expires_at + and basic_socket_streambuf::expires_from_now + getters +

+ 		+
+

+ basic_socket_streambuf::expires_after +

+ 		+

+ basic_socket_streambuf::expires_from_now + setter +

+ 		+
+

+ basic_socket_streambuf::error +

+ 		+

+ basic_socket_streambuf::puberror +

+ 		+
+

+ basic_socket_iostream::duration +

+ 		+

+ basic_socket_iostream::duration_type +

+ 		+
+

+ basic_socket_iostream::time_point +

+ 		+

+ basic_socket_iostream::time_type +

+ 		+
+

+ basic_socket_iostream::expiry +

+ 		+

+ basic_socket_iostream::expires_at + and basic_socket_iostream::expires_from_now + getters +

+ 		+
+

+ basic_socket_iostream::expires_after +

+ 		+

+ basic_socket_iostream::expires_from_now + setter +

+ 		+
+

+ basic_waitable_timer::cancel +

+ 		+

+ basic_waitable_timer::cancel + overload that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ basic_waitable_timer::cancel_one +

+ 		+

+ basic_waitable_timer::cancel_one + overload that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ basic_waitable_timer::expires_at setter +

+ 		+

+ basic_waitable_timer::expires_at + setter that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ basic_waitable_timer::expiry +

+ 		+

+ basic_waitable_timer::expires_at + and basic_waitable_timer::expires_from_now + getters +

+ 		+
+

+ basic_waitable_timer::expires_after +

+ 		+

+ basic_waitable_timer::expires_from_now + setter +

+ 		+
+

+ ip::make_address +

+ 		+

+ ip::address::from_string +

+ 		+
+

+ ip::make_address_v4 +

+ 		+

+ ip::address_v4::from_string and ip::address_v6::to_v4 +

+ 		+
+

+ ip::make_address_v6 +

+ 		+

+ ip::address_v6::from_string and ip::address_v6::v4_mapped +

+ 		+
+

+ ip::address::to_string +

+ 		+

+ ip::address::to_string that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ ip::address_v4::to_string +

+ 		+

+ ip::address_v4::to_string that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ ip::address_v6::to_string +

+ 		+

+ ip::address_v6::to_string that takes error_code& +

+ 		+

+ The error_code overload + is not required. +

+
+

+ No replacement +

+ 		+

+ ip::address_v6::is_v4_compatible and ip::address_v6::v4_compatible +

+ 		+
+

+ ip::network_v4 +

+ 		+

+ ip::address_v4::broadcast, ip::address_v4::is_class_a, + ip::address_v4::is_class_b, ip::address_v4::is_class_c, + and ip::address_v4::netmask +

+ 		+

+ The network_v4 class + adds the ability to manipulate IPv4 network addresses using CIDR + notation. +

+
+

+ ip::network_v6 +

+ 		+ +

+ The network_v6 class + adds the ability to manipulate IPv6 network addresses using CIDR + notation. +

+
+

+ ip::address_v4_iterator and + ip::address_v4_range +

+ 		+ +

+ The ip::address_v4_iterator and address_v4_range classes add the + ability to iterate over all, or a subset of, IPv4 addresses. +

+
+

+ ip::address_v6_iterator and + ip::address_v6_range +

+ 		+ +

+ The ip::address_v6_iterator and address_v6_range classes add the + ability to iterate over all, or a subset of, IPv6 addresses. +

+
+

+ ip::basic_resolver::results_type +

+ 		+

+ ip::basic_resolver::iterator +

+ 		+

+ Resolvers now produce ranges rather than single iterators. +

+
+

+ ip::basic_resolver::resolve overloads taking + hostname and service as arguments +

+ 		+

+ ip::basic_resolver::resolve overloads taking a ip::basic_resolver::query +

+ 		+
+

+ ip::basic_resolver::resolve returns a range +

+ 		+

+ ip::basic_resolver::resolve returns a single iterator +

+ 		+
+

+ ip::basic_resolver::async_resolve overloads + taking hostname and service as arguments +

+ 		+

+ ip::basic_resolver::async_resolve overloads taking + a ip::basic_resolver::query +

+ 		+
+

+ ip::basic_resolver::async_resolve calls the + handler with a range +

+ 		+

+ ip::basic_resolver::async_resolve calls the handler + with a single iterator +

+ 		+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview.html b/Packages/asio-1.36.0/doc/asio/overview.html new file mode 100644 index 0000000..e12f38e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview.html @@ -0,0 +1,272 @@ + + + +Overview + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/basics.html b/Packages/asio-1.36.0/doc/asio/overview/basics.html new file mode 100644 index 0000000..b91150c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/basics.html @@ -0,0 +1,168 @@ + + + +Basic Asio Anatomy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio may be used to perform both synchronous and asynchronous operations + on I/O objects such as sockets. Before using Asio it may be useful to get + a conceptual picture of the various parts of Asio, your program, and how + they work together. +

+

+ As an introductory example, let's consider what happens when you perform + a connect operation on a socket. We shall start by examining synchronous + operations. +

+

+ +

+

+ Your program will have at least one I/O execution context, such as an asio::io_context + object, asio::thread_pool object, or asio::system_context. + This I/O execution context represents your program's link to the operating + system's I/O services. +

+
asio::io_context io_context;
+
+

+ To perform I/O operations your program will + need an I/O object such as a TCP socket: +

+
asio::ip::tcp::socket socket(io_context);
+
+

+ When a synchronous connect operation is performed, the following sequence + of events occurs: +

+

+ 1. Your program initiates the connect operation + by calling the I/O object: +

+
socket.connect(server_endpoint);
+
+

+ 2. The I/O object forwards the request to + the I/O execution context. +

+

+ 3. The I/O execution context calls on the + operating system to perform the connect + operation. +

+

+ 4. The operating system returns the result + of the operation to the I/O execution context. +

+

+ 5. The I/O execution context translates + any error resulting from the operation into an object of type asio::error_code. An error_code + may be compared with specific values, or tested as a boolean (where a false result means that no error occurred). + The result is then forwarded back up to the I/O object. +

+

+ 6. The I/O object throws an exception of + type asio::system_error if the operation failed. If + the code to initiate the operation had instead been written as: +

+
asio::error_code ec;
+socket.connect(server_endpoint, ec);
+
+

+ then the error_code variable + ec would be set to the result + of the operation, and no exception would be thrown. +

+

+ When an asynchronous operation is used, a different sequence of events occurs. +

+

+ +

+

+ 1. Your program initiates the connect operation + by calling the I/O object: +

+
socket.async_connect(server_endpoint, your_completion_handler);
+
+

+ where your_completion_handler + is a function or function object with the signature: +

+
void your_completion_handler(const asio::error_code& ec);
+
+

+ The exact signature required depends on the asynchronous operation being + performed. The reference documentation indicates the appropriate form for + each operation. +

+

+ 2. The I/O object forwards the request to + the I/O execution context. +

+

+ 3. The I/O execution context signals to + the operating system that it should start + an asynchronous connect. +

+

+ Time passes. (In the synchronous case this wait would have been contained + entirely within the duration of the connect operation.) +

+

+ +

+

+ 4. The operating system indicates that the + connect operation has completed by placing the result on a queue, ready to + be picked up by the I/O execution context. +

+

+ 5. When using an io_context + as the I/O execution context, your program must make a call to io_context::run() + (or to one of the similar io_context + member functions) in order for the result to be retrieved. A call to io_context::run() blocks + while there are unfinished asynchronous operations, so you would typically + call it as soon as you have started your first asynchronous operation. +

+

+ 6. While inside the call to io_context::run(), + the I/O execution context dequeues the result + of the operation, translates it into an error_code, + and then passes it to your completion handler. +

+

+ This is a simplified picture of how Asio operates. You will want to delve + further into the documentation if your needs are more advanced, such as extending + Asio to perform other types of asynchronous operations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/channels.html b/Packages/asio-1.36.0/doc/asio/overview/channels.html new file mode 100644 index 0000000..1413e74 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/channels.html @@ -0,0 +1,93 @@ + + + +Channels + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + + + + +
[Note]Note

+ This is an experimental feature. +

+

+ The templates experimental::basic_channel + and experimental::basic_concurrent_channel, + with aliases experimental::channel + and experimental::concurrent_channel, may be used to send + messages between different parts of the same application. A message + is defined as a collection of arguments to be passed to a completion handler, + and the set of messages supported by a channel is specified by its template + parameters. Messages may be sent and received using asynchronous or non-blocking + synchronous operations. +

+

+ For example: +

+
// Create a channel with no buffer space.
+channel<void(error_code, size_t)> ch(ctx);
+
+// The call to try_send fails as there is no buffer
+// space and no waiting receive operations.
+bool ok = ch.try_send(asio::error::eof, 123);
+assert(!ok);
+
+// The async_send operation is outstanding until
+// a receive operation consumes the message.
+ch.async_send(asio::error::eof, 123,
+    [](error_code ec)
+    {
+      // ...
+    });
+
+// The async_receive consumes the message. Both the
+// async_send and async_receive operations complete
+// immediately.
+ch.async_receive(
+    [](error_code ec, size_t n)
+    {
+      // ...
+    });
+
+
+ + See + Also +
+

+ experimental::basic_channel, + experimental::basic_concurrent_channel, + Channels examples (C++20). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition.html b/Packages/asio-1.36.0/doc/asio/overview/composition.html new file mode 100644 index 0000000..96a83ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition.html @@ -0,0 +1,81 @@ + + + +Composition and Completion Tokens + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/compose.html b/Packages/asio-1.36.0/doc/asio/overview/composition/compose.html new file mode 100644 index 0000000..1453073 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/compose.html @@ -0,0 +1,137 @@ + + + +Compositions as Asynchronous Operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Application developers may wish to package their own compositions as conforming + asynchronous operations + within the asynchronous model. + Doing so facilitates seamless composition of these operations together + with the operations already provided by Asio. +

+

+ While these operations may be written from scratch to conform with the + requirements on + asynchronous operations, Asio includes the async_compose function to simplify + this process. The async_compose + implementation automatically provides an intermediate completion handler + that correctly propagates the associated + characteristics and tracks outstanding work against the I/O executor + and completion executor. +

+

+ The following example illustrates an asynchronous echo loop (i.e. read, + followed by write, and so on), expressed as a simple state machine. +

+
struct async_echo_implementation
+{
+  tcp::socket& socket_;
+  asio::mutable_buffer buffer_;
+  enum { starting, reading, writing } state_;
+
+  template <typename Self>
+  void operator()(Self& self,
+      asio::error_code error = {},
+      std::size_t n = 0)
+  {
+    switch (state_)
+    {
+    case starting:
+      state_ = reading;
+      socket_.async_read_some(
+          buffer_, std::move(self));
+      break;
+    case reading:
+      if (error)
+      {
+        self.complete(error, 0);
+      }
+      else
+      {
+        state_ = writing;
+        asio::async_write(socket_, buffer_,
+            asio::transfer_exactly(n),
+            std::move(self));
+      }
+      break;
+    case writing:
+      self.complete(error, n);
+      break;
+    }
+  }
+};
+
+

+ This implementation is then used in an initiating function, which trivially + wraps async_compose: +

+
template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    asio::mutable_buffer buffer,
+    CompletionToken&& token) ->
+  typename asio::async_result<
+    typename std::decay<CompletionToken>::type,
+      void(asio::error_code, std::size_t)>::return_type
+{
+  return asio::async_compose<CompletionToken,
+    void(asio::error_code, std::size_t)>(
+      async_echo_implementation{socket, buffer,
+        async_echo_implementation::starting},
+      token, socket);
+}
+
+

+ Here, async_compose is + first passed the function object that contains the implementation of the + composed asynchronous operation. The first argument to the function object + is a non-const reference to the enclosing intermediate completion handler. + The remaining arguments are any arguments that originate from the completion + handlers of any asynchronous operations performed by the implementation. +

+

+ The async_compose function + is also passed the completion token, and zero or more I/O objects or I/O + executors for which outstanding work must be maintained. +

+
+ + See + Also +
+

+ async_compose, Operations examples (C++11), + Operations examples + (C++14). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/coro.html b/Packages/asio-1.36.0/doc/asio/overview/composition/coro.html new file mode 100644 index 0000000..af888c3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/coro.html @@ -0,0 +1,588 @@ + + + +Resumable C++ 20 Coroutines + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + + + + +
[Note]Note

+ This is an experimental feature. +

+

+ The experimental::coro + class provides support for a universal C++20 coroutine. These coroutines + can be used as tasks, generators and transfomers, depending on their signature. +

+
coro<std::string_view> line_reader(tcp::socket stream)
+{
+   while (stream.is_open())
+   {
+     std::array<char, 4096> buf;
+
+     auto read = co_await stream.async_read_some(
+         asio::buffer(buf), deferred);
+
+     if (read == 0u)
+       continue;
+
+     co_yield std::string_view { buf.data(), read };
+   }
+}
+
+coro<void, std::size_t> line_logger(tcp::socket stream)
+{
+  std::size_t lines_read = 0u;
+  auto reader = line_reader(std::move(stream));
+  while (auto l = co_await reader)
+  {
+    std::cout << "Read: '" << *l << "'" << std::endl;
+    lines_read++;
+  }
+  co_return lines_read;
+}
+
+void read_lines(tcp::socket sock)
+{
+  co_spawn(line_logger(std::move(sock),
+      [](std::exception_ptr, std::size_t lines)
+      {
+        std::clog << "Read " << lines << " lines" << std::endl;
+      }));
+}
+
+

+ A coro + is highly configurable, so that it can cover a set of different use cases. +

+
template<
+    typename Yield,
+    typename Return = void,
+    typename Executor = any_io_executor>
+struct coro;
+
+
+ + Yield +
+

+ The Yield parameter designates + how a co_yield statement + behaves. It can either be a type, like int + or a signature with zero or one types: +

+
coro<void> // A coroutine with no yield
+coro<int> // A coroutine that can yield int
+
+coro<void()> // A coroutine with no yield
+coro<int()> // A coroutine that can yield int
+
+coro<int(double)> // A coroutine that can yield int and receive double
+
+

+ Receiving a value means that the co_yield + statement returns a value. +

+
coro<int(int)> my_sum(any_io_executor)
+{
+  int value = 0;
+  while (true)
+    value += co_yield value; //sum up all values
+}
+
+

+ Putting values into a coroutine can be done it two ways: either by direct + resumption (from another coro) or through async_resume. The first value + gets ignored because the coroutines are lazy. +

+
coro<void> c(any_io_executor exec)
+{
+  auto sum = my_sum(exec);
+  assert(0  == co_await sum(-1));
+  assert(0  == co_await sum(10));
+  assert(10 == co_await sum(15));
+  assert(25 == co_await sum(0));
+}
+
+awaitable<void> a()
+{
+  auto sum = my_sum(co_await this_coro::executor);
+  assert(0  == co_await sum.async_resume(-1, use_awaitable));
+  assert(0  == co_await sum.async_resume(10, use_awaitable));
+  assert(10 == co_await sum.async_resume(15, use_awaitable));
+  assert(25 == co_await sum.async_resume(0, use_awaitable));
+}
+
+
+ + noexcept +
+

+ A coro may be noexcept: +

+
coro<void() noexcept> c;
+coro<int() noexcept> c;
+coro<int(double) noexcept> c;
+
+

+ This will change its @c async_resume signature, from void(std::exception_ptr) to void() or void(std::exception_ptr, T) + to void(T). A + noexcept coro that ends with an exception will cause std::terminate + to be called. +

+

+ Furthermore, calls of async_resume + and co_await of an expired + noexcept coro will cause undefined behaviour. +

+
+ + Return +
+

+ A coro can also define a type that can be used with co_return: +

+
coro<void() noexcept, int> c(any_io_executor)
+{
+  co_return 42;
+}
+
+

+ A coro can have both a Yield + and Return that are non + void at the same time. +

+
+ + Result +
+

+ The result type of a coroutine is dermined by both Yield + and Return. Note that in + the follwing table only the yield output value is considered, i.e. T(U) means T. +

+
+

Table 2. Result type deduction

+
+++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Yield +

+ 		+

+ Return +

+ 		+

+ noexcept +

+ 		+

+ result_type +

+ 		+

+ completion_signature +

+
+

+ T +

+ 		+

+ U +

+ 		+

+ false +

+ 		+

+ variant<T, + U> +

+ 		+

+ void(std::exception_ptr, + variant<T, + U>) +

+
+

+ T +

+ 		+

+ U +

+ 		+

+ true +

+ 		+

+ variant<T, + U> +

+ 		+

+ void(variant<T, + U>) +

+
+

+ T +

+ 		+

+ void +

+ 		+

+ false +

+ 		+

+ optional<T> +

+ 		+

+ void(std::exception_ptr, + optional<T>) +

+
+

+ T +

+ 		+

+ void +

+ 		+

+ true +

+ 		+

+ optional<T> +

+ 		+

+ void(optional<T>) +

+
+

+ void +

+ 		+

+ void +

+ 		+

+ false +

+ 		+

+ optional<T> +

+ 		+

+ void(std::exception_ptr) +

+
+

+ void +

+ 		+

+ void +

+ 		+

+ true +

+ 		+

+ optional<T> +

+ 		+

+ void() +

+
+

+ void +

+ 		+

+ T +

+ 		+

+ false +

+ 		+

+ optional<T> +

+ 		+

+ void(std::exception_ptr, + T) +

+
+

+ void +

+ 		+

+ T +

+ 		+

+ true +

+ 		+

+ optional<T> +

+ 		+

+ void(T) +

+
+
+
+ + Executor +
+

+ Every coroutine needs to have its own executor. Since the coroutine gets + called multiple times, it cannot take the executor from the caller like + an awaitable. Therefore + a coro requires to get + an executor or an execution_context passed in as the first parameter. +

+
coro<int> with_executor(any_io_executor);
+coro<int> with_context(io_context &);
+
+

+ It is to note, that an execution_context is defined as loosely as possible. + An execution context is any object that has a get_executor() function, which returns an executor that + can be transformed into the executor_type of the coroutine. This allows + most io_objects to be used as the source of the executor: +

+
coro<int> with_socket(tcp::socket);
+
+

+ Additionally, a coro that + is a member function will check the this + pointer as well, either if it's an executor or an execution context: +

+
struct my_io_object
+{
+  any_io_executor get_executor();
+
+  coro<int> my_coro();
+};
+
+

+ Finally, a member coro can be given an explicit executor or execution context, + to override the one of the object: +

+
struct my_io_object
+{
+  any_io_executor get_executor();
+
+  coro<int> my_coro(any_io_executor exec); // it will use exec
+};
+
+
+ + co_await +
+

+ The @c co_await within a coro + is not the same as async_resume(deferred), unless both coros use different executors. + If they use the same, the coro + will direclty suspend and resume the executor, without any usage of the + executor. +

+

+ co_await this_coro:: behaves the same as coroutines that use + @c asio::awaitable. +

+
+ + Integrating + with awaitable +
+

+ As the coro member function + async_resume is an asynchronous + operation, it may also be used in conjunction with awaitable + coroutines in a single control flow. For example: +

+
#include <asio.hpp>
+#include <asio/experimental/coro.hpp>
+
+using asio::ip::tcp;
+
+asio::experimental::coro<std::string> reader(tcp::socket& sock)
+{
+  std::string buf;
+  while (sock.is_open())
+  {
+    std::size_t n = co_await asio::async_read_until(
+        sock, asio::dynamic_buffer(buf), '\n',
+        asio::deferred);
+    co_yield buf.substr(0, n);
+    buf.erase(0, n);
+  }
+}
+
+asio::awaitable<void> consumer(tcp::socket sock)
+{
+  auto r = reader(sock);
+  auto msg1 = co_await r.async_resume(asio::use_awaitable);
+  std::cout << "Message 1: " << msg1.value_or("\n");
+  auto msg2 = co_await r.async_resume(asio::use_awaitable);
+  std::cout << "Message 2: " << msg2.value_or("\n");
+}
+
+asio::awaitable<void> listen(tcp::acceptor& acceptor)
+{
+  for (;;)
+  {
+    co_spawn(
+        acceptor.get_executor(),
+        consumer(co_await acceptor.async_accept(asio::use_awaitable)),
+        asio::detached);
+  }
+}
+
+int main()
+{
+  asio::io_context ctx;
+  tcp::acceptor acceptor(ctx, {tcp::v4(), 54321});
+  co_spawn(ctx, listen(acceptor), asio::detached);
+  ctx.run();
+}
+
+
+ + See + Also +
+

+ co_spawn, experimental::coro, + C++20 Coroutines, + Stackful Coroutines, + Stackless Coroutines. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/coroutine.html b/Packages/asio-1.36.0/doc/asio/overview/composition/coroutine.html new file mode 100644 index 0000000..eb1506a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/coroutine.html @@ -0,0 +1,83 @@ + + + +Stackless Coroutines + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The coroutine + class provides support for stackless coroutines. Stackless coroutines enable + programs to implement asynchronous logic in a synchronous manner, with + minimal overhead, as shown in the following example: +

+
struct session : asio::coroutine
+{
+  boost::shared_ptr<tcp::socket> socket_;
+  boost::shared_ptr<std::vector<char> > buffer_;
+
+  session(boost::shared_ptr<tcp::socket> socket)
+    : socket_(socket),
+      buffer_(new std::vector<char>(1024))
+  {
+  }
+
+  void operator()(asio::error_code ec = asio::error_code(), std::size_t n = 0)
+  {
+    if (!ec) reenter (this)
+    {
+      for (;;)
+      {
+        yield socket_->async_read_some(asio::buffer(*buffer_), *this);
+        yield asio::async_write(*socket_, asio::buffer(*buffer_, n), *this);
+      }
+    }
+  }
+};
+
+

+ The coroutine class is + used in conjunction with the pseudo-keywords reenter, + yield and fork. These are preprocessor macros, + and are implemented in terms of a switch + statement using a technique similar to Duff's Device. The coroutine class's documentation + provides a complete description of these pseudo-keywords. +

+
+ + See + Also +
+

+ coroutine, HTTP + Server 4 example, Stackful + Coroutines. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/cpp20_coroutines.html b/Packages/asio-1.36.0/doc/asio/overview/composition/cpp20_coroutines.html new file mode 100644 index 0000000..0b794c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/cpp20_coroutines.html @@ -0,0 +1,393 @@ + + + +C++20 Coroutines Support + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Support for C++20 Coroutines is provided via the awaitable class template, the + use_awaitable + completion token, and the co_spawn() + function. These facilities allow programs to implement asynchronous logic + in a synchronous manner, in conjunction with the co_await + keyword, as shown in the following example: +

+
asio::co_spawn(executor, echo(std::move(socket)), asio::detached);
+
+// ...
+
+asio::awaitable<void> echo(tcp::socket socket)
+{
+  try
+  {
+    char data[1024];
+    for (;;)
+    {
+      std::size_t n = co_await socket.async_read_some(asio::buffer(data));
+      co_await async_write(socket, asio::buffer(data, n));
+    }
+  }
+  catch (std::exception& e)
+  {
+    std::printf("echo Exception: %s\n", e.what());
+  }
+}
+
+

+ The first argument to co_spawn() is an executor + that determines the context in which the coroutine is permitted to execute. + For example, a server's per-client object may consist of multiple coroutines; + they should all run on the same strand + so that no explicit synchronisation is required. +

+

+ The second argument is an awaitable<R>, + that is the result of the coroutine's entry point function, and in the + above example is the result of the call to echo. + (Alternatively, this argument can be a function object that returns the + awaitable<R>.) The template parameter R is the type of return value produced + by the coroutine. In the above example, the coroutine returns void. +

+

+ The third argument is a completion token, and this is used by co_spawn() + to produce a completion handler with signature void(std::exception_ptr, R). + This completion handler is invoked with the result of the coroutine once + it has finished. In the above example we pass a completion token type, + asio::detached, + which is used to explicitly ignore the result of an asynchronous operation. +

+

+ In this example the body of the coroutine is implemented in the echo function. When an asynchronous operation + is called without explicitly specifying a completion token, the default + completion token deferred is used. This causes + the operation's initiating function to return a deferred asynchronous operation + object that may be used with the co_await + keyword: +

+
std::size_t n = co_await socket.async_read_some(asio::buffer(data));
+
+

+ Alternatively, we can specify the use_awaitable + completion token: +

+
std::size_t n = co_await socket.async_read_some(asio::buffer(data), asio::use_awaitable);
+
+

+ With either of those completion tokens, when an asynchronous operation's + handler signature has the form: +

+
void handler(asio::error_code ec, result_type result);
+
+

+ the resulting type of the co_await + expression is result_type. + In the async_read_some + example above, this is size_t. + If the asynchronous operation fails, the error_code + is converted into a system_error + exception and thrown. +

+

+ Where a handler signature has the form: +

+
void handler(asio::error_code ec);
+
+

+ the co_await expression + produces a void result. As + above, an error is passed back to the coroutine as a system_error + exception. +

+
+ + Error + Handling +
+

+ To perform explicit error handling, rather than the default exception-throwing + behaviour, use the as_tuple or redirect_error completion token + adapters. +

+

+ The as_tuple completion + token adapter packages the completion handler arguments into a single tuple, + which is then returned as the result of the awaited operation. For example: +

+
asio::awaitable<void> echo(tcp::socket socket)
+{
+  char data[1024];
+  for (;;)
+  {
+    std::tuple<asio::error_code, std::size_t> result =
+      co_await socket.async_read_some(
+        asio::buffer(data), asio::as_tuple);
+    if (!std::get<0>(result))
+    {
+      // success
+    }
+
+    // ...
+  }
+}
+
+

+ or if explicitly specifying the use_awaitable + completion token: +

+
asio::awaitable<void> echo(tcp::socket socket)
+{
+  char data[1024];
+  for (;;)
+  {
+    std::tuple<asio::error_code, std::size_t> result =
+      co_await socket.async_read_some(asio::buffer(data),
+        asio::as_tuple(asio::use_awaitable));
+    if (!std::get<0>(result))
+    {
+      // success
+    }
+
+    // ...
+  }
+}
+
+

+ The result can also be captured directly into a structured binding: +

+
asio::awaitable<void> echo(tcp::socket socket)
+{
+  char data[1024];
+  for (;;)
+  {
+    auto [ec, n] = co_await socket.async_read_some(
+        asio::buffer(data), asio::as_tuple);
+    if (!ec)
+    {
+      // success
+    }
+
+    // ...
+  }
+}
+
+

+ Alternatively, the redirect_error + completion token adapter may be used to capture the error into a supplied + error_code variable: +

+
asio::awaitable<void> echo(tcp::socket socket)
+{
+  char data[1024];
+  for (;;)
+  {
+    asio::error_code ec;
+    std::size_t n = co_await socket.async_read_some(
+        asio::buffer(data), asio::redirect_error(ec));
+    if (!ec)
+    {
+      // success
+    }
+
+    // ...
+  }
+}
+
+
+ + Coroutines + and Per-Operation Cancellation +
+

+ All threads of execution created by co_spawn + have a cancellation state that records the current state of any cancellation + requests made to the coroutine. To access this state, use this_coro::cancellation_state as follows: +

+
asio::awaitable<void> my_coroutine()
+{
+  asio::cancellation_state cs
+    = co_await asio::this_coro::cancellation_state;
+
+  // ...
+
+  if (cs.cancelled() != asio::cancellation_type::none)
+    // ...
+}
+
+

+ When first created by co_spawn, + the thread of execution has a cancellation state that supports cancellation_type::terminal values only. To change the cancellation + state, call this_coro::reset_cancellation_state. +

+

+ By default, continued execution of a cancelled coroutine will trigger an + exception from any subsequent co_await + of an awaitable<> + object. This behaviour can be changed by using this_coro::throw_if_cancelled. +

+
+ + Co-ordinating + Parallel Coroutines +
+
+ + + + + +
[Note]Note

+ This is an experimental feature. +

+

+ The logical operators || and + && have been overloaded + for awaitable<>, + to allow coroutines to be trivially awaited in parallel. +

+

+ When awaited using &&, + the co_await expression + waits until both operations have completed successfully. As a "short-circuit" + evaluation, if one operation fails with an exception, the other is immediately + cancelled. For example: +

+
std::tuple<std::size_t, std::size_t> results =
+  co_await (
+    async_read(socket, input_buffer, use_awaitable)
+      && async_write(socket, output_buffer, use_awaitable)
+  );
+
+

+ Following completion of a && + operation, the results of all operations are concatenated into a tuple. + In the above example, the first size_t + represents the non-exceptional component of the async_read + result, and the second size_t + is the result of the async_write. +

+

+ When awaited using ||, the + co_await expression waits + until either operation succeeds. As a "short-circuit" evaluation, + if one operation succeeds without throwing an exception, the other is immediately + cancelled. For example: +

+
std::variant<std::size_t, std::monostate> results =
+  co_await (
+    async_read(socket, input_buffer, use_awaitable)
+      || timer.async_wait(use_awaitable)
+  );
+
+

+ Following completion of a || + operation, the result of the first operation to complete non-exceptionally + is placed into a std::variant. The active index of the variant + reflects which of the operations completed first. In the above example, + index 0 corresponds to the + async_read operation. +

+

+ These operators may be enabled by adding the #include: +

+
#include <asio/experimental/awaitable_operators.hpp>
+
+

+ and then bringing the contents of the experimental::awaitable_operators + namespace into scope: +

+
using namespace asio::experimental::awaitable_operators;
+
+

+ Note: To use these operators we must explicitly specify the use_awaitable completion token. +

+
+ + Lightweight + Coroutines Implementing Asynchonous Operations +
+

+ The co_composed template + facilitates a lightweight implementation of user-defined asynchronous operations + using C++20 coroutines. The following example illustrates a simple asynchronous + operation that implements an echo protocol in terms of a coroutine: +

+
template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    CompletionToken&& token)
+{
+  return asio::async_initiate<
+    CompletionToken, void(asio::error_code)>(
+      asio::co_composed<
+        void(asio::error_code)>(
+          [](auto state, tcp::socket& socket) -> void
+          {
+            try
+            {
+              state.throw_if_cancelled(true);
+              state.reset_cancellation_state(
+                asio::enable_terminal_cancellation());
+
+              for (;;)
+              {
+                char data[1024];
+                std::size_t n =
+                  co_await socket.async_read_some(
+                    asio::buffer(data));
+
+                co_await asio::async_write(socket,
+                    asio::buffer(data, n));
+              }
+            }
+            catch (const asio::system_error& e)
+            {
+              co_return {e.code()};
+            }
+          }, socket),
+      token, std::ref(socket));
+}
+
+
+ + See Also +
+

+ co_spawn, detached, + as_tuple, redirect_error, + awaitable, use_awaitable_t, + use_awaitable, this_coro::executor, + co_composed, Coroutines + examples, Resumable + C++20 Coroutines, Stackful + Coroutines, Stackless + Coroutines. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/deferred.html b/Packages/asio-1.36.0/doc/asio/overview/composition/deferred.html new file mode 100644 index 0000000..bcd6718 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/deferred.html @@ -0,0 +1,100 @@ + + + +Deferred Operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The deferred, + completion token takes a call to an asynchronous operation's initiating + function and turns it into a function object that accepts a completion + token. For example: +

+
auto deferred_op =
+  timer.async_wait(
+    asio::deferred);
+...
+std::move(deferred_op)(
+    [](asio::error_code ec){ ... });
+
+

+ or: +

+
auto deferred_op =
+  timer.async_wait(
+    asio::deferred);
+...
+std::future<void> =
+  std::move(deferred_op)(
+    asio::use_future);
+
+

+ The deferred token also supports chaining, to create simple compositions: +

+
auto deferred_op =
+  timer.async_wait(
+    asio::deferred(
+      [&](asio::error_code ec)
+      {
+        timer.expires_after(
+            std::chrono::seconds(1));
+
+        return timer.async_wait(
+            asio::deferred);
+      });
+...
+std::future<void> = std::move(deferred_op)(asio::use_future);
+
+
+ + Deferred + as the Default Completion Token +
+

+ Most asynchronous operations provided by Asio have a default completion + token. Although this default token can be changed by specifying a custom + executor, it is normally asio::deferred. This means that we can omit the + token and simply write: +

+
auto deferred_op = timer.async_wait();
+
+
+ + See + Also +
+

+ deferred, deferred_t, + Deferred examples + (C++11), Deferred + examples (C++14). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/futures.html b/Packages/asio-1.36.0/doc/asio/overview/composition/futures.html new file mode 100644 index 0000000..2990282 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/futures.html @@ -0,0 +1,79 @@ + + + +Futures + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The asio::use_future completion token provides + first-class support for returning a std::future + from an asynchronous operation's initiating function. +

+

+ To use asio::use_future, pass it to an asynchronous + operation instead of a completion handler. For example: +

+
std::future<std::size_t> length =
+  my_socket.async_read_some(my_buffer, asio::use_future);
+
+

+ Where a completion signature has the form: +

+
void handler(asio::error_code ec, result_type result);
+
+

+ the initiating function returns a std::future + templated on result_type. + In the above example, this is std::size_t. + If the asynchronous operation fails, the error_code + is converted into a system_error + exception and passed back to the caller through the future. +

+

+ Where a completion signature has the form: +

+
void handler(asio::error_code ec);
+
+

+ the initiating function returns std::future<void>. As above, an error is passed back + in the future as a system_error + exception. +

+
+ + See + Also +
+

+ use_future, use_future_t, + Futures example (C++11). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/immediate_completion.html b/Packages/asio-1.36.0/doc/asio/overview/composition/immediate_completion.html new file mode 100644 index 0000000..6f277d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/immediate_completion.html @@ -0,0 +1,83 @@ + + + +Customising Immediate Completion + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The associated_immediate_executor + associator trait, along with the bind_immediate_executor + function, provide the ability to customise the execution of a completion + handler when an asynchronous operation completes immediately. +

+

+ When a supported operation completes immediately (that is, within the initiating + function) the associated immmediate executor is obtained, and the completion + handler is delivered through that executor as if by using asio::dispatch on that executor. By default, + the immediate executor delivers the completion handler as if using asio::post via the operation's I/O executor. +

+

+ For example, to allow a recursive call to the completion handler of an + async_read_some operation, + we may specify that immediate completion is delivered via a system_executor: +

+
my_socket.async_read_some(my_buffer,
+    bind_immediate_executor(
+      system_executor(),
+      [](error_code e, size_t n)
+      {
+        // ...
+      }
+    )
+  );
+
+

+ Immediate execution is currently supported for asynchronous operations + on reactor-based sockets and descriptors, and for asynchronous operations + on channels. +

+

+ Note: When enabling the immediate execution + of completion handlers, care must be taken to ensure that unbounded recursion + and stack overflow do not occur. Furthermore, use of immediate completion + may impact the fairness of completion handler scheduling, with a potential + for starvation for other pending work. +

+
+ + See Also +
+

+ associated_immediate_executor, + bind_immediate_executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/parallel_group.html b/Packages/asio-1.36.0/doc/asio/overview/composition/parallel_group.html new file mode 100644 index 0000000..bdc36b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/parallel_group.html @@ -0,0 +1,105 @@ + + + +Co-ordinating Parallel Operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + + + + +
[Note]Note

+ This is an experimental feature. +

+

+ The experimental::make_parallel_group function may + be used to launch work that is performed in parallel, and wait for one + or all of the operations to complete. A parallel_group + implements automatic cancellation of incomplete operations. For example: +

+
experimental::make_parallel_group(
+    [&](auto token)
+    {
+      return stream.async_read_some(asio::buffer(data), token);
+    },
+    [&](auto token)
+    {
+      return timer.async_wait(token);
+    }
+  ).async_wait(
+    experimental::wait_for_one(),
+    [](
+        std::array<std::size_t, 2> completion_order,
+        asio::error_code ec1, std::size_t n1,
+        asio::error_code ec2
+    )
+    {
+      // ...
+    }
+  );
+
+

+ The conditions for completion of the group may be specified using one of + the four provided function objects wait_for_all, wait_for_one, wait_for_one_success, wait_for_one_error, or with a + custom function. +

+

+ The parallel_group facility + can also be combined with deferred as follows: +

+
experimental::make_parallel_group(
+    stream.async_read_some(asio::buffer(data), deferred),
+    timer.async_wait(experimental::deferred)
+  ).async_wait(
+    // ...
+  );
+
+

+ Note: for maximum flexibility, parallel_group + does not propagate the executor automatically to the operations within + the group. +

+
+ + See + Also +
+

+ experimental::make_parallel_group, + experimental::parallel_group, + Parallel Groups + examples (C++11), Parallel + Groups examples (C++14). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/promises.html b/Packages/asio-1.36.0/doc/asio/overview/composition/promises.html new file mode 100644 index 0000000..0578588 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/promises.html @@ -0,0 +1,132 @@ + + + +Promises + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + + + + +
[Note]Note

+ This is an experimental feature. +

+

+ The experimental::promise type and experimental::use_promise completion token allow + eager execution and synchronisation of asynchronous operations. For example: +

+
auto promise = async_read(
+    stream, asio::buffer(my_buffer),
+    asio::experimental::use_promise);
+
+... do other stuff while the read is going on ...
+
+promise.async_wait( // completion the operation
+    [](error_code ec, std::size_t bytes_read)
+    {
+      ...
+    });
+
+

+ Promises can be safely disregarded if the result is no longer required. + Different operations can be combined to either wait for all to complete + or for one to complete (and cancel the rest). For example, to wait for + one to complete: +

+
auto timeout_promise =
+  timer.async_wait(
+    asio::experimental::use_promise);
+
+auto read_promise = async_read(
+    stream, asio::buffer(my_buffer),
+    asio::experimental::use_promise);
+
+auto promise =
+  asio::experimental::make_parallel_group(
+    timeout_promise.async_wait(asio::deferred),
+    read_promise.async_wait(asio::deferred)
+  ).async_wait(
+    asio::experimental::wait_for_one(),
+    asio::experimental::use_promise);
+
+promise.async_wait(
+    [](std::array<std::size_t, 2> order,
+       error_code timer_ec,
+       error_code read_ec, std::size_t read_size)
+    {
+      if (order[0] == 0)
+      {
+        // timed out
+      }
+      else
+      {
+        // completed in time
+      }
+    });
+
+

+ or to wait for all to complete: +

+
auto write_promise = async_write(
+    stream, asio::buffer(my_write_buffer),
+    asio::experimental::use_promise);
+
+auto read_promise = async_read(
+    stream, asio::buffer(my_buffer),
+    asio::experimental::use_promise);
+
+auto promise =
+  asio::experimental::make_parallel_group(
+    timeout_promise.async_wait(asio::deferred),
+    read_promise.async_wait(asio::deferred)
+  ).async_wait(
+    asio::experimental::wait_for_all(),
+    asio::experimental::use_promise);
+
+promise.async_wait(
+    [](std::array<std::size_t, 2> order,
+       error_code timer_ec,
+       error_code read_ec, std::size_t read_size)
+    {
+      // ...
+    });
+
+
+ + See + Also +
+

+ promise, use_promise. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/spawn.html b/Packages/asio-1.36.0/doc/asio/overview/composition/spawn.html new file mode 100644 index 0000000..25d8279 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/spawn.html @@ -0,0 +1,144 @@ + + + +Stackful Coroutines + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The spawn() function is a high-level wrapper + for running stackful coroutines. It is based on the Boost.Coroutine library. + The spawn() + function enables programs to implement asynchronous logic in a synchronous + manner, as shown in the following example: +

+
asio::spawn(my_strand, do_echo, asio::detached);
+
+// ...
+
+void do_echo(asio::yield_context yield)
+{
+  try
+  {
+    char data[128];
+    for (;;)
+    {
+      std::size_t length =
+        my_socket.async_read_some(
+          asio::buffer(data), yield);
+
+      asio::async_write(my_socket,
+          asio::buffer(data, length), yield);
+    }
+  }
+  catch (std::exception& e)
+  {
+    // ...
+  }
+}
+
+

+ The first argument to spawn() may be an executor or execution context. + This argument determines the context in which the coroutine is permitted + to execute. For example, a server's per-client object may consist of multiple + coroutines; they should all run on the same strand + so that no explicit synchronisation is required. +

+

+ The second argument is a function object with signature: +

+
void coroutine(asio::yield_context yield);
+
+

+ that specifies the code to be run as part of the coroutine. The parameter + yield may be passed to + an asynchronous operation in place of the completion handler, as in: +

+
std::size_t length =
+  my_socket.async_read_some(
+    asio::buffer(data), yield);
+
+

+ This starts the asynchronous operation and suspends the coroutine. The + coroutine will be resumed automatically when the asynchronous operation + completes. +

+

+ Where an asynchronous operation's handler signature has the form: +

+
void handler(asio::error_code ec, result_type result);
+
+

+ the initiating function returns the result_type. In the async_read_some + example above, this is size_t. + If the asynchronous operation fails, the error_code + is converted into a system_error + exception and thrown. +

+

+ Where a handler signature has the form: +

+
void handler(asio::error_code ec);
+
+

+ the initiating function returns void. + As above, an error is passed back to the coroutine as a system_error + exception. +

+

+ To collect the error_code + from an operation, rather than have it throw an exception, associate the + output variable with the yield_context + as follows: +

+
asio::error_code ec;
+std::size_t length =
+  my_socket.async_read_some(
+    asio::buffer(data), yield[ec]);
+
+

+ Note: if spawn() is used with a specified executor of + type Executor, the function + object signature is actually: +

+
void coroutine(asio::basic_yield_context<Executor> yield);
+
+
+ + See + Also +
+

+ spawn, yield_context, + basic_yield_context, + Spawn example (C++11), + Stackless Coroutines. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/token_adapters.html b/Packages/asio-1.36.0/doc/asio/overview/composition/token_adapters.html new file mode 100644 index 0000000..a43afe5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/token_adapters.html @@ -0,0 +1,318 @@ + + + +Completion Token Adapters + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A completion token adapter is a utility that can be + generically applied to a completion + token, to produce a new completion token with modified behaviour. + Common uses of completion token adapters include: +

+
    +
  • + Automatically wrapping the completion handler to add associated + characteristics. +
    • +
  • + Transforming the completion signature and arguments passed to the completion + handler. +
    • +
+

+ Asio includes a number of completion token adapters as described below. +

+
+ + bind_executor, + bind_allocator, bind_cancellation_slot, and bind_immediate_executor +
+

+ The bind_executor + function adapts a completion token to imbue the completion handler with + an associated executor. +

+

+ This example shows the bind_executor + adapter applied to a lambda, to specify that the handler should execute + in the specified strand. The arguments to the completion handler are passed + through as-is. +

+
my_socket.async_read_some(my_buffer,
+    asio::bind_executor(my_strand,
+      [](asio::error_code error, std::size_t bytes_transferred)
+      {
+        // ...
+      }));
+
+

+ When applied to completion tokens that cause the initiating function to + produce a result, such as use_awaitable, the result is returned + unmodified. +

+
asio::awaitable<void> my_coroutine()
+{
+  // ...
+  std::size_t bytes_transferred =
+    co_await my_socket.async_read_some(my_buffer,
+      asio::bind_executor(my_strand, asio::use_awaitable));
+  // ...
+}
+
+

+ The bind_allocator, + bind_cancellation_slot, + and bind_immediate_executor adapters + work similarly, to imbue the completion handler with an associated + allocator, associated + cancellation slot, and associated immediate executor respectively. +

+
+ + redirect_error +
+

+ The redirect_error + function adapts a completion token to capture the error_code + produced by an operation into a specified variable. In doing so, it modifies + the completion signature to remove the initial error_code + parameter. +

+

+ This example shows the redirect_error + adapter applied to a lambda, to specify that the error should be captured + into my_error. The error_code is no longer passed to the + completion handler, but the remaining arguments are passed through as-is. +

+
asio::error_code my_error; // N.B. must be valid until operation completes
+// ...
+my_socket.async_read_some(my_buffer,
+    asio::redirect_error(
+      [](std::size_t bytes_transferred)
+      {
+        // ...
+      }, my_error));
+
+

+ When applied to completion tokens that cause the initiating function to + produce a result, such as use_awaitable, the result is returned + unmodified. However, if the operation fails, the co_await + expression will no longer throw an exception on resumption. +

+
asio::awaitable<void> my_coroutine()
+{
+  // ...
+  asio::error_code my_error;
+  std::size_t bytes_transferred =
+    co_await my_socket.async_read_some(my_buffer,
+      asio::redirect_error(asio::use_awaitable, my_error));
+  // ...
+}
+
+
+ + as_tuple +
+

+ The as_tuple + adapter can be used to specify that the completion handler arguments should + be combined into a single tuple argument. +

+

+ For example, the as_tuple + adapter may be used in conjunction with use_awaitable and structured bindings + as follows: +

+
auto [e, n] =
+  co_await my_socket.async_read_some(my_buffer,
+    asio::as_tuple(asio::use_awaitable));
+
+

+ This adapter may also be used as a default completion token: +

+
using default_token = asio::as_tuple_t<asio::use_awaitable_t<>>;
+using tcp_socket = default_token::as_default_on_t<tcp::socket>;
+// ...
+asio::awaitable<void> do_read(tcp_socket my_socket)
+{
+  // ...
+  auto [e, n] = co_await my_socket.async_read_some(my_buffer);
+  // ...
+}
+
+
+ + as_single +
+
+ + + + + +
[Note]Note

+ This is an experimental feature. +

+

+ The experimental::as_single adapter can be used + to specify that the completion handler arguments should be combined into + a single argument. For completion signatures with a single parameter, the + argument is passed through as-is. For signatures with two or more parameters, + the arguments are combined into a tuple. +

+

+ For example, when applied to a timer wait operation, the single error_code argument is passed directly + to the completion handler: +

+
my_timer.async_wait(
+    asio::experimental::as_single(
+      [](asio::error_code error)
+      {
+        // ...
+      }));
+
+

+ When applied to a socket read operation, where the completion signature + specifies two parameters, the handler is passed the result as a tuple: +

+
my_socket.async_read_some(my_buffer,
+    asio::experimental::as_single,
+      [](std::tuple<asio::error_code, std::size_t> result)
+      {
+        // ...
+      }));
+
+
+ + append +
+

+ The append + completion token adapter can be used to pass additional completion handler + arguments at the end of the completion signature. +

+

+ For example: +

+
timer.async_wait(
+    asio::append(
+      [](std::error_code ec, int i)
+      {
+        // ...
+      },
+      42
+    )
+  );
+
+std::future<int> f = timer.async_wait(
+    asio::append(
+      asio::use_future,
+      42
+    )
+  );
+
+
+ + prepend +
+

+ The prepend + completion token adapter can be used to pass additional completion handler + arguments before the existing completion handler arguments. +

+

+ For example: +

+
timer.async_wait(
+    asio::prepend(
+      [](int i, std::error_code ec)
+      {
+        // ...
+      },
+      42
+    )
+  );
+
+std::future<std::tuple<int, std::error_code>> f = timer.async_wait(
+    asio::prepend(
+      asio::use_future,
+      42
+    )
+  );
+
+
+ + consign +
+

+ The consign + completion token adapter can be used to attach additional values to a completion + handler. This is typically used to keep at least one copy of an object, + such as a smart pointer, alive until the completion handler is called. +

+

+ For example: +

+
auto timer1 = std::make_shared<asio::steady_timer>(my_io_context);
+timer1->expires_after(std::chrono::seconds(1));
+timer1->async_wait(
+    asio::consign(
+      [](std::error_code ec)
+      {
+        // ...
+      },
+      timer1
+    )
+  );
+
+auto timer2 = std::make_shared<asio::steady_timer>(my_io_context);
+timer2->expires_after(std::chrono::seconds(30));
+std::future<void> f =
+  timer2->async_wait(
+    asio::consign(
+      asio::use_future,
+      timer2
+    )
+  );
+
+
+ + See + Also +
+

+ bind_executor, bind_allocator, bind_cancellation_slot, + redirect_error, as_tuple, experimental::as_single, + append, prepend. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/composition/type_erasure.html b/Packages/asio-1.36.0/doc/asio/overview/composition/type_erasure.html new file mode 100644 index 0000000..15d3232 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/composition/type_erasure.html @@ -0,0 +1,127 @@ + + + +Type Erasure, Separate Compilation and Virtual Functions + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The any_completion_handler<> class template can be used to type-erase + completion handlers. This template stores a completion handler in a runtime-polymorphic + wrapper, and forwards the function call operator, associated executor, + associated allocator, and associated cancellation slot to the target handler. +

+

+ One use case is to enable separate compilation of asynchronous operation + implementations. For example, we can declare our implementation function + in a header file, and provide a thin asynchronous operation wrapper: +

+
void async_sleep_impl(
+    asio::any_completion_handler<void(asio::error_code)> handler,
+    asio::any_io_executor ex, std::chrono::nanoseconds duration);
+
+template <typename CompletionToken>
+inline auto async_sleep(asio::any_io_executor ex,
+    std::chrono::nanoseconds duration, CompletionToken&& token)
+{
+  return asio::async_initiate<
+    CompletionToken, void(asio::error_code)>(
+      async_sleep_impl, token, std::move(ex), duration);
+}
+
+

+ By wrapping a call to async_initiate, + the async_sleep template + function adds full support for completion tokens. The definition of async_sleep_impl is then put into a separately + compiled source file: +

+
void async_sleep_impl(
+    asio::any_completion_handler<void(asio::error_code)> handler,
+    asio::any_io_executor ex, std::chrono::nanoseconds duration)
+{
+  auto timer = std::make_shared<asio::steady_timer>(ex, duration);
+  timer->async_wait(asio::consign(std::move(handler), timer));
+}
+
+

+ Another use for any_completion_handler<> is to vary the implementation behind + an asynchronous operation at runtime, by using virtual functions: +

+
class line_reader
+{
+public:
+  // ...
+
+  template <typename CompletionToken>
+  auto async_read_line(std::string prompt, CompletionToken&& token)
+  {
+    return asio::async_initiate<
+      CompletionToken, void(asio::error_code, std::string)>(
+        [](auto handler, line_reader* self, std::string prompt)
+        {
+          self->async_read_line_impl(std::move(prompt), std::move(handler));
+        }, token, this, prompt);
+  }
+
+private:
+  virtual void async_read_line_impl(std::string prompt,
+      asio::any_completion_handler<
+        void(asio::error_code, std::string)> handler) = 0;
+};
+
+

+ A derived class provides the implementation of the operation: +

+
class stdin_line_reader : public line_reader
+{
+private:
+  // ...
+
+  void async_read_line_impl(std::string prompt,
+      asio::any_completion_handler<
+        void(asio::error_code, std::string)> handler) override
+  {
+    // ...
+  }
+};
+
+
+ + See + Also +
+

+ any_completion_handler, + type erasure + examples (C++11), type + erasure examples (C++20). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core.html b/Packages/asio-1.36.0/doc/asio/overview/core.html new file mode 100644 index 0000000..f2016db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core.html @@ -0,0 +1,74 @@ + + + +Core Concepts and Functionality + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/allocation.html b/Packages/asio-1.36.0/doc/asio/overview/core/allocation.html new file mode 100644 index 0000000..5ff0dc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/allocation.html @@ -0,0 +1,139 @@ + + + +Custom Memory Allocation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Many asynchronous operations need to allocate an object to store state + associated with the operation. For example, a Win32 implementation needs + OVERLAPPED-derived objects + to pass to Win32 API functions. +

+

+ Furthermore, programs typically contain easily identifiable chains of asynchronous + operations. A half duplex protocol implementation (e.g. an HTTP server) + would have a single chain of operations per client (receives followed by + sends). A full duplex protocol implementation would have two chains executing + in parallel. Programs should be able to leverage this knowledge to reuse + memory for all asynchronous operations in a chain. +

+

+ Given a copy of a user-defined Handler + object h, if the implementation + needs to allocate memory associated with that handler it will obtain an + allocator using the get_associated_allocator + function. For example: +

+
asio::associated_allocator_t<Handler> a = asio::get_associated_allocator(h);
+
+

+ The associated allocator must satisfy the standard Allocator requirements. +

+

+ By default, handlers use the standard allocator (which is implemented in + terms of ::operator + new() + and ::operator + delete()). + The allocator may be customised for a particular handler type by specifying + a nested type allocator_type + and member function get_allocator(): +

+
class my_handler
+{
+public:
+  // Custom implementation of Allocator type requirements.
+  typedef my_allocator allocator_type;
+
+  // Return a custom allocator implementation.
+  allocator_type get_allocator() const noexcept
+  {
+    return my_allocator();
+  }
+
+  void operator()() { ... }
+};
+
+

+ In more complex cases, the associated_allocator + template may be partially specialised directly: +

+
namespace asio {
+
+  template <typename Allocator>
+  struct associated_allocator<my_handler, Allocator>
+  {
+    // Custom implementation of Allocator type requirements.
+    typedef my_allocator type;
+
+    // Return a custom allocator implementation.
+    static type get(const my_handler&,
+        const Allocator& a = Allocator()) noexcept
+    {
+      return my_allocator();
+    }
+  };
+
+} // namespace asio
+
+

+ The implementation guarantees that the deallocation will occur before the + associated handler is invoked, which means the memory is ready to be reused + for any new asynchronous operations started by the handler. +

+

+ The custom memory allocation functions may be called from any user-created + thread that is calling an Asio library function. The implementation guarantees, + for the asynchronous operations included with the library, that within + the context of an individual operation the implementation will not make + concurrent calls to the memory allocation functions for that handler. The + implementation will insert appropriate memory barriers to ensure correct + memory visibility should an asynchronous operation need to call the allocation + functions from different threads. (Note: If the same allocator is shared + across multiple concurrent asynchronous operations, this can result in + concurrent calls to the memory allocation functions. Use of a strand + does not prevent these concurrent calls, as an operation may need to allocate + memory from outside the strand. In this case, the shared allocator is responsible + for providing the necessary thread safety guarantees.) +

+
+ + See + Also +
+

+ associated_allocator, + get_associated_allocator, + custom memory allocation + example (C++11). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/async.html b/Packages/asio-1.36.0/doc/asio/overview/core/async.html new file mode 100644 index 0000000..17bbf7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/async.html @@ -0,0 +1,279 @@ + + + +The Proactor Design Pattern: Concurrency Without Threads + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The Asio library offers side-by-side support for synchronous and asynchronous + operations. The asynchronous support is based on the Proactor design pattern + [POSA2]. The + advantages and disadvantages of this approach, when compared to a synchronous-only + or Reactor approach, are outlined below. +

+
+ + Proactor + and Asio +
+

+ Let us examine how the Proactor design pattern is implemented in Asio, + without reference to platform-specific details. +

+

+ +

+

+ Proactor design pattern (adapted from [POSA2]) +

+

+ — Asynchronous Operation +

+

+ Defines an operation that is executed asynchronously, such as an asynchronous + read or write on a socket. +

+

+ — Asynchronous Operation Processor +

+

+ Executes asynchronous operations and queues events on a completion event + queue when operations complete. From a high-level point of view, internal + services like reactive_socket_service + are asynchronous operation processors. +

+

+ — Completion Event Queue +

+

+ Buffers completion events until they are dequeued by an asynchronous + event demultiplexer. +

+

+ — Completion Handler +

+

+ Processes the result of an asynchronous operation. These are function + objects, often created using boost::bind. +

+

+ — Asynchronous Event Demultiplexer +

+

+ Blocks waiting for events to occur on the completion event queue, and + returns a completed event to its caller. +

+

+ — Proactor +

+

+ Calls the asynchronous event demultiplexer to dequeue events, and dispatches + the completion handler (i.e. invokes the function object) associated + with the event. This abstraction is represented by the io_context class. +

+

+ — Initiator +

+

+ Application-specific code that starts asynchronous operations. The initiator + interacts with an asynchronous operation processor via a high-level interface + such as basic_stream_socket, + which in turn delegates to a service like reactive_socket_service. +

+
+ + Implementation + Using Reactor +
+

+ On many platforms, Asio implements the Proactor design pattern in terms + of a Reactor, such as select, + epoll or kqueue. This implementation approach + corresponds to the Proactor design pattern as follows: +

+

+ — Asynchronous Operation Processor +

+

+ A reactor implemented using select, + epoll or kqueue. When the reactor indicates + that the resource is ready to perform the operation, the processor executes + the asynchronous operation and enqueues the associated completion handler + on the completion event queue. +

+

+ — Completion Event Queue +

+

+ A linked list of completion handlers (i.e. function objects). +

+

+ — Asynchronous Event Demultiplexer +

+

+ This is implemented by waiting on an event or condition variable until + a completion handler is available in the completion event queue. +

+
+ + Implementation + Using Windows Overlapped I/O +
+

+ On Windows NT, 2000 and XP, Vista, 7 and later, Asio takes advantage of + overlapped I/O to provide an efficient implementation of the Proactor design + pattern. This implementation approach corresponds to the Proactor design + pattern as follows: +

+

+ — Asynchronous Operation Processor +

+

+ This is implemented by the operating system. Operations are initiated + by calling an overlapped function such as AcceptEx. +

+

+ — Completion Event Queue +

+

+ This is implemented by the operating system, and is associated with an + I/O completion port. There is one I/O completion port for each io_context instance. +

+

+ — Asynchronous Event Demultiplexer +

+

+ Called by Asio to dequeue events and their associated completion handlers. +

+
+ + Advantages +
+

+ — Portability. +

+

+ Many operating systems offer a native asynchronous I/O API (such as overlapped + I/O on Windows) as the preferred option for developing + high performance network applications. The library may be implemented + in terms of native asynchronous I/O. However, if native support is not + available, the library may also be implemented using synchronous event + demultiplexors that typify the Reactor pattern, such as POSIX + select(). +

+

+ — Decoupling threading from concurrency. +

+

+ Long-duration operations are performed asynchronously by the implementation + on behalf of the application. Consequently applications do not need to + spawn many threads in order to increase concurrency. +

+

+ — Performance and scalability. +

+

+ Implementation strategies such as thread-per-connection (which a synchronous-only + approach would require) can degrade system performance, due to increased + context switching, synchronisation and data movement among CPUs. With + asynchronous operations it is possible to avoid the cost of context switching + by minimising the number of operating system threads — typically a limited + resource — and only activating the logical threads of control that have + events to process. +

+

+ — Simplified application synchronisation. +

+

+ Asynchronous operation completion handlers can be written as though they + exist in a single-threaded environment, and so application logic can + be developed with little or no concern for synchronisation issues. +

+

+ — Function composition. +

+

+ Function composition refers to the implementation of functions to provide + a higher-level operation, such as sending a message in a particular format. + Each function is implemented in terms of multiple calls to lower-level + read or write operations. +

+

+ For example, consider a protocol where each message consists of a fixed-length + header followed by a variable length body, where the length of the body + is specified in the header. A hypothetical read_message operation could + be implemented using two lower-level reads, the first to receive the + header and, once the length is known, the second to receive the body. +

+

+ To compose functions in an asynchronous model, asynchronous operations + can be chained together. That is, a completion handler for one operation + can initiate the next. Starting the first call in the chain can be encapsulated + so that the caller need not be aware that the higher-level operation + is implemented as a chain of asynchronous operations. +

+

+ The ability to compose new operations in this way simplifies the development + of higher levels of abstraction above a networking library, such as functions + to support a specific protocol. +

+
+ + Disadvantages +
+

+ — Program complexity. +

+

+ It is more difficult to develop applications using asynchronous mechanisms + due to the separation in time and space between operation initiation + and completion. Applications may also be harder to debug due to the inverted + flow of control. +

+

+ — Memory usage. +

+

+ Buffer space must be committed for the duration of a read or write operation, + which may continue indefinitely, and a separate buffer is required for + each concurrent operation. The Reactor pattern, on the other hand, does + not require buffer space until a socket is ready for reading or writing. +

+
+ + References +
+

+ [POSA2] D. Schmidt et al, Pattern Oriented Software Architecture, + Volume 2. Wiley, 2000. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/buffers.html b/Packages/asio-1.36.0/doc/asio/overview/core/buffers.html new file mode 100644 index 0000000..4951478 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/buffers.html @@ -0,0 +1,258 @@ + + + +Buffers + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Fundamentally, I/O involves the transfer of data to and from contiguous + regions of memory, called buffers. These buffers can be simply expressed + as a tuple consisting of a pointer and a size in bytes. However, to allow + the development of efficient network applications, Asio includes support + for scatter-gather operations. These operations involve one or more buffers: +

+
    +
  • + A scatter-read receives data into multiple buffers. +
    • +
  • + A gather-write transmits multiple buffers. +
    • +
+

+ Therefore we require an abstraction to represent a collection of buffers. + The approach used in Asio is to define a type (actually two types) to represent + a single buffer. These can be stored in a container, which may be passed + to the scatter-gather operations. +

+

+ In addition to specifying buffers as a pointer and size in bytes, Asio + makes a distinction between modifiable memory (called mutable) and non-modifiable + memory (where the latter is created from the storage for a const-qualified + variable). These two types could therefore be defined as follows: +

+
typedef std::pair<void*, std::size_t> mutable_buffer;
+typedef std::pair<const void*, std::size_t> const_buffer;
+
+

+ Here, a mutable_buffer would be convertible to a const_buffer, but conversion + in the opposite direction is not valid. +

+

+ However, Asio does not use the above definitions as-is, but instead defines + two classes: mutable_buffer + and const_buffer. The goal + of these is to provide an opaque representation of contiguous memory, where: +

+
    +
  • + Types behave as std::pair would in conversions. That is, a mutable_buffer is convertible to + a const_buffer, but + the opposite conversion is disallowed. +
    • +
  • + There is protection against buffer overruns. Given a buffer instance, + a user can only create another buffer representing the same range of + memory or a sub-range of it. To provide further safety, the library + also includes mechanisms for automatically determining the size of + a buffer from an array, boost::array + or std::vector of POD elements, or from a + std::string. +
    • +
  • + The underlying memory is explicitly accessed using the data() + member function. In general an application should never need to do + this, but it is required by the library implementation to pass the + raw memory to the underlying operating system functions. +
    • +
+

+ Finally, multiple buffers can be passed to scatter-gather operations (such + as read() or write()) + by putting the buffer objects into a container. The MutableBufferSequence + and ConstBufferSequence + concepts have been defined so that containers such as std::vector, + std::list, std::array + or boost::array can be used. +

+
+ + Streambuf + for Integration with Iostreams +
+

+ The class asio::basic_streambuf is derived from std::basic_streambuf to associate the input + sequence and output sequence with one or more objects of some character + array type, whose elements store arbitrary values. These character array + objects are internal to the streambuf object, but direct access to the + array elements is provided to permit them to be used with I/O operations, + such as the send or receive operations of a socket: +

+
    +
  • + The input sequence of the streambuf is accessible via the data() + member function. The return type of this function meets the ConstBufferSequence requirements. +
    • +
  • + The output sequence of the streambuf is accessible via the prepare() + member function. The return type of this function meets the MutableBufferSequence requirements. +
    • +
  • + Data is transferred from the front of the output sequence to the back + of the input sequence by calling the commit() + member function. +
    • +
  • + Data is removed from the front of the input sequence by calling the + consume() + member function. +
    • +
+

+ The streambuf constructor accepts a size_t + argument specifying the maximum of the sum of the sizes of the input sequence + and output sequence. Any operation that would, if successful, grow the + internal data beyond this limit will throw a std::length_error + exception. +

+
+ + Bytewise + Traversal of Buffer Sequences +
+

+ The buffers_iterator<> + class template allows buffer sequences (i.e. types meeting MutableBufferSequence or ConstBufferSequence requirements) to + be traversed as though they were a contiguous sequence of bytes. Helper + functions called buffers_begin() and buffers_end() are also provided, where + the buffers_iterator<> template parameter is automatically deduced. +

+

+ As an example, to read a single line from a socket and into a std::string, you may write: +

+
asio::streambuf sb;
+...
+std::size_t n = asio::read_until(sock, sb, '\n');
+asio::streambuf::const_buffers_type bufs = sb.data();
+std::string line(
+    asio::buffers_begin(bufs),
+    asio::buffers_begin(bufs) + n);
+
+
+ + Buffer + Literals +
+

+ The _buf literal suffix, + defined in namespace asio::buffer_literals, + may be used to create const_buffer + objects from string, binary integer, and hexadecimal integer literals. + These buffer literals may be arbitrarily long. For example: +

+
using namespace asio::buffer_literals;
+
+asio::const_buffer b1 = "hello"_buf;
+asio::const_buffer b2 = 0xdeadbeef_buf;
+asio::const_buffer b3 = 0x01234567'89abcdef'01234567'89abcdef_buf;
+asio::const_buffer b4 = 0b1010101011001100_buf;
+
+

+ The memory associated with a buffer literal is valid for the lifetime of + the program. This means that the buffer can be safely used with asynchronous + operations: +

+
async_write(my_socket, "hello"_buf, my_handler);
+
+
+ + Buffer + Debugging +
+

+ Some standard library implementations, such as the one that ships with + Microsoft Visual C++ 8.0 and later, provide a feature called iterator debugging. + What this means is that the validity of iterators is checked at runtime. + If a program tries to use an iterator that has been invalidated, an assertion + will be triggered. For example: +

+
std::vector<int> v(1)
+std::vector<int>::iterator i = v.begin();
+v.clear(); // invalidates iterators
+*i = 0; // assertion!
+
+

+ Asio takes advantage of this feature to add buffer debugging. Consider + the following code: +

+
void dont_do_this()
+{
+ std::string msg = "Hello, world!";
+ asio::async_write(sock, asio::buffer(msg), my_handler);
+}
+
+

+ When you call an asynchronous read or write you need to ensure that the + buffers for the operation are valid until the completion handler is called. + In the above example, the buffer is the std::string + variable msg. This variable + is on the stack, and so it goes out of scope before the asynchronous operation + completes. If you're lucky then the application will crash, but random + failures are more likely. +

+

+ When buffer debugging is enabled, Asio stores an iterator into the string + until the asynchronous operation completes, and then dereferences it to + check its validity. In the above example you would observe an assertion + failure just before Asio tries to call the completion handler. +

+

+ This feature is automatically made available for Microsoft Visual Studio + 8.0 or later and for GCC when _GLIBCXX_DEBUG + is defined. There is a performance cost to this checking, so buffer debugging + is only enabled in debug builds. For other compilers it may be enabled + by defining ASIO_ENABLE_BUFFER_DEBUGGING. + It can also be explicitly disabled by defining ASIO_DISABLE_BUFFER_DEBUGGING. +

+
+ + See + Also +
+

+ buffer, buffers_begin, + buffers_end, buffers_iterator, + const_buffer, mutable_buffer, streambuf, + ConstBufferSequence, + MutableBufferSequence, + buffers example (c++11). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/cancellation.html b/Packages/asio-1.36.0/doc/asio/overview/core/cancellation.html new file mode 100644 index 0000000..33b9b39 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/cancellation.html @@ -0,0 +1,388 @@ + + + +Per-Operation Cancellation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + + + + +
[Note]Note

+ These type requirements and classes are the low level building blocks + of cancellation. For most use cases, consider using a higher level abstraction, + such as experimental::make_parallel_group + or the logical + operators for awaitable. +

+

+ I/O objects, such as sockets and timers, support object-wide cancellation + of outstanding asynchronous operations via their close + or cancel member functions. + However, certain asynchronous operations also support individual, targeted + cancellation. This per-operation cancellation is enabled by specifying + that a completion handler has an associated + cancellation slot which satisfies the CancellationSlot + type requirements. A cancellation slot is a lightweight channel used for + delivering a cancellation request. +

+

+ Given a copy of a user-defined Handler + object h, if an asynchronous + operation supports cancellation it will obtain a cancellation slot using + the get_associated_cancellation_slot + function. For example: +

+
asio::associated_cancellation_slot_t<Handler> s
+  = asio::get_associated_cancellation_slot(h);
+
+

+ The associated cancellation slot must satisfy the CancellationSlot type + requirements. +

+

+ By default, handlers use a default-constructed cancellation_slot, which means + that per-operation cancellation is disabled. The cancellation slot may + be customised for a particular handler type by specifying a nested type + cancellation_slot_type + and member function get_cancellation_slot(): +

+
class my_handler
+{
+public:
+  // Custom implementation of CancellationSlot type requirements.
+  typedef my_cancellation_slot cancellation_slot_type;
+
+  // Return a custom cancellation slot implementation.
+  cancellation_slot_type get_cancellation_slot() const noexcept
+  {
+    return my_cancellation_slot(...);
+  }
+
+  void operator()() { ... }
+};
+
+

+ In more complex cases, the associated_cancellation_slot + template may be partially specialised directly: +

+
namespace asio {
+
+  template <typename CancellationSlot>
+  struct associated_cancellation_slot<my_handler, CancellationSlot>
+  {
+    // Custom implementation of CancellationSlot type requirements.
+    typedef my_cancellation_slot type;
+
+    // Return a custom cancellation_slot implementation.
+    static type get(const my_handler&,
+        const CancellationSlot& a = CancellationSlot()) noexcept
+    {
+      return my_cancellation_slot(...);
+    }
+  };
+
+} // namespace asio
+
+

+ For convenience, a cancellation slot may be associated with a handler by + using the bind_cancellation_slot function. + This is particularly useful when associating a cancellation slot with a + lambda: +

+
asio::async_read(my_socket, my_buffer,
+    asio::bind_cancellation_slot(
+      my_cancellation_slot,
+      [](asio::error_code e, std::size_t n)
+      {
+        ...
+      }
+    )
+  );
+
+

+ Asio provides a ready-to-use cancellation slot in the form of cancellation_slot and its counterpart + cancellation_signal. + These two classes implement a one-to-one pairing of producer (signal) and + consumer (slot) interfaces. The following example shows its use: +

+
class session
+  : public std::enable_shared_from_this<proxy>
+{
+  ...
+
+  void do_read()
+  {
+    auto self = shared_from_this();
+    socket_.async_read_some(
+        buffer(data_),
+        asio::bind_cancellation_slot(
+          cancel_signal_.slot(),
+          [self](std::error_code error, std::size_t n)
+          {
+            ...
+          }
+        )
+      );
+  }
+
+  ...
+
+  void request_cancel()
+  {
+    cancel_signal_.emit(asio::cancellation_type::total);
+  }
+
+  ...
+
+  asio::cancellation_signal cancel_signal_;
+};
+
+

+ A cancellation_signal contains + a single slot, and consequently a cancellation signal/slot pair may be + used with at most one operation at a time. However, the same slot may be + reused for subsequent operations. +

+

+ To support cancellation, an asynchronous operation installs a cancellation + handler into the slot by calling the slot's assign + or emplace functions. This + handler will be invoked when a cancellation signal is emitted. A slot holds + exactly one handler at a time, and installing a new handler will overwrite + any previously installed handler. +

+

+ When emitting a cancellation signal, the caller must specify a cancellation + type. This value is a bitmask that dictates what guarantees the + cancellation target must make if successful cancellation occurs. The possible + bit values are, from weakest to strongest guarantee, are: +

+
+

Table 1. cancellation types

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Bit +

+ 		+

+ Guarantee if cancellation is successful +

+ 		+

+ Examples where this is the strongest supported guarantee +

+
+

+ terminal +

+ 		+

+ The operation had unspecified side effects, and it is only safe + to close or destroy the I/O object. +

+ 		+

+ A stateful implementation of a message framing protocol, where + an asynchronous operation sends or receives a complete message. + If cancellation occurs part-way through the message body, it + is not possible to report a sensible state to the completion + handler. +

+
+

+ partial +

+ 		+

+ The operation had well-defined side effects, and the completion + handler for the operation indicates what these side effects were. +

+ 		+

+ Composed operations such as async_read + and async_write. + If cancellation occurs before all bytes are transferred, the + completion handler is passed the total bytes transferred so far. + The caller may use this information to start another operation + to transfer the remaining bytes. +

+
+

+ total +

+ 		+

+ The operation had no side effects that are observable through + the API. +

+ 		+

+ Low level system calls that transfer either zero or non-zero + bytes.

Wait-for-readiness operations that have no + side effects, even when successful.

A fully buffered + message framing protocol implementation, where partial messages + are stored so that they may be reused on the next operation. +

+
+
+

+ For example, if application logic requires that an operation complete with + all-or-nothing side effects, it should emit only the total + cancellation type. If this type is unsupported by the target operation, + no cancellation will occur. +

+

+ Furthermore, a stronger guarantee always satisfies the requirements of + a weaker guarantee. The partial + guarantee still satisfies the terminal + guarantee. The total guarantee + satisfies both partial + and terminal. This means + that when an operation supports a given cancellation type as its strongest + guarantee, it should honour cancellation requests for any of the weaker + guarantees. +

+

+ Cancellation requests should not be emitted during an asynchronous operation's + initiating function. Cancellation requests that are emitted before an operation + starts have no effect. Similarly, cancellation requests made after completion + have no effect. +

+

+ When emitting a cancellation signal, the thread safety rules apply as if + calling a member function on the target operation's I/O object. For non-composed + operations, this means that it is safe to emit the cancellation signal + from any thread provided there are no other concurrent calls to the I/O + object, and no other concurrent cancellation signal requests. For composed + operations, care must be taken to ensure the cancellation request does + not occur concurrently with the operation's intermediate completion handlers. +

+
+ + Supported + Operations +
+

+ Consult the documentation for individual asynchronous operations for their + supported cancellation types, if any. The ability to cancel individual + operations, or composed operations, is currently supported by: +

+
    +
  • + timers +
    • +
  • + sockets on POSIX and Windows +
    • +
  • + POSIX descriptors +
    • +
  • + Windows HANDLEs +
    • +
  • + signal sets +
    • +
  • + serial ports +
    • +
  • + SSL streams +
    • +
  • + all Asio-provided composed operations such as async_read + and async_write +
    • +
  • + compositions based on async_compose +
    • +
  • + C++20 coroutines that use awaitable +
    • +
  • + C++20 coroutines that use experimental::coro +
    • +
  • + the experimental::parallel_group operation +
    • +
  • + the experimental::promise class +
    • +
+
+ + See + Also +
+

+ CancellationSlot, + associated_cancellation_slot, + bind_cancellation_slot, + cancellation_signal, + cancellation_slot, + cancellation_state, + cancellation_type, + get_associated_cancellation_slot, + experimental::parallel_group, + experimental::make_parallel_group +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/configuration.html b/Packages/asio-1.36.0/doc/asio/overview/core/configuration.html new file mode 100644 index 0000000..a7c0473 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/configuration.html @@ -0,0 +1,738 @@ + + + +Runtime Configuration and Concurrency Hints + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio provides a number of runtime configuration options that can be used + to fine tune Asio's behaviour, such as enabling or disabling specific optimisations. + The configuration options available are listed in the table below. +

+
+++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Section +

+ 		+

+ Key +

+ 		+

+ Type +

+ 		+

+ Default +

+ 		+

+ Description +

+
+

+ scheduler +

+ 		+

+ concurrency_hint +

+ 		+

+ int +

+ 		+

+ 0 +

+ 		+

+ This is a suggestion to the io_context + implementation as to the number of active threads that should + be used for running completion handlers. +

+

+ When the Windows I/O completion port backend is in use, this + value is passed to CreateIoCompletionPort. +

+

+ When a reactor-based backend is used, the implementation recognises + the value 1 as an + indication that the io_context + will be run from a single thread, and applies several optimisations + based on this assumption. For example, when a handler is posted + from within another handler, the new handler is added to a fast + thread-local queue (with the consequence that the new handler + is held back until the currently executing handler finishes). +

+

+ No matter what value is specified for this configuration option, + the io_context + or thread_pool + still provides full thread safety, and distinct I/O objects may + be used from any thread. +

+
+

+ scheduler +

+ 		+

+ locking +

+ 		+

+ bool +

+ 		+

+ true +

+ 		+

+ This is used to enable or disable locking in the scheduler, when + using a reactor-based backend. When set to false, + this option has the following restrictions: +

+

+ — Care must be taken to ensure that all operations on the io_context and any of its associated + I/O objects (such as sockets and timers) occur in only one thread + at a time. +

+

+ — Asynchronous resolve operations fail with operation_not_supported. +

+

+ — If a signal_set + is used with the io_context, + signal_set objects + cannot be used with any other io_context in the program. +

+
+

+ scheduler +

+ 		+

+ locking_spin_count +

+ 		+

+ int +

+ 		+

+ 0 +

+ 		+

+ The number of times to first attempt to acquire the scheduler's + internal lock without blocking, when using a reactor-based backend. +

+
+

+ scheduler +

+ 		+

+ task_usec +

+ 		+

+ int +

+ 		+

+ -1 +

+ 		+

+ The maximum time, in microseconds, that the scheduler will wait + for its reactor task to complete. A value of -1 means that no limit is placed + on this wait time. May be set to 0 + to enable CPU-bound spinning. +

+
+

+ scheduler +

+ 		+

+ wait_usec +

+ 		+

+ int +

+ 		+

+ -1 +

+ 		+

+ The maximum time, in microseconds, that the scheduler will wait + on its wake-up event in an idle thread (i.e. a thread that is + not otherwise executing a handler or waiting on the reactor). + A value of -1 + means that no limit is placed on this wait time. May be set to + 0 to enable CPU-bound + spinning in an execution context that is being run on multiple + threads. +

+
+

+ reactor +

+ 		+

+ preallocated_io_objects +

+ 		+

+ unsigned int +

+ 		+

+ 0 +

+ 		+

+ The number of internal reactor I/O object states to allocate + at construction. +

+

+ The reactor implementation uses per I/O object state to track + things like the queue of outstanding operations. These state + objects are recycled once the I/O object is destroyed, but new + ones are allocated if there are no unused state objects currently + available. +

+

+ If an upper bound on the number of I/O objects is known at construction + time, this configuration option can be set to ensure that no + allocations occur after construction is complete. +

+
+

+ reactor +

+ 		+

+ registration_locking +

+ 		+

+ bool +

+ 		+

+ true +

+ 		+

+ Enables or disables locking in the reactor around I/O object + registration and deregistration. +

+

+ If set to false, + care must be taken not to concurrently open or close I/O objects. +

+
+

+ reactor +

+ 		+

+ registration_locking_spin_count +

+ 		+

+ int +

+ 		+

+ 0 +

+ 		+

+ The number of times to first attempt to acquire the reactor's + lock without blocking, when performing I/O object registration + or deregistration. +

+
+

+ reactor +

+ 		+

+ io_locking +

+ 		+

+ bool +

+ 		+

+ true +

+ 		+

+ Enables or disables per I/O object locking in the reactor +

+

+ If set to false, + care must be taken to ensure that the run functions + on the io_context + (i.e. run, run_for, run_until, + run_one, run_one_for, run_one_until, poll, and poll_one), + and all operations on the context's associated I/O objects (such + as sockets and timers), occur in only one thread at a time. +

+
+

+ reactor +

+ 		+

+ io_locking_spin_count +

+ 		+

+ int +

+ 		+

+ 0 +

+ 		+

+ The number of times to first attempt to acquire the reactor's + per I/O object locks without blocking. +

+
+

+ timer +

+ 		+

+ heap_reserve +

+ 		+

+ unsigned int +

+ 		+

+ 0 +

+ 		+

+ The number of entries to reserve in the internal timer queue's + heap. +

+

+ If an upper bound on the number of timers is known at construction + time, this configuration option can be set to ensure that no + timer allocations occur after construction is complete. +

+
+

+ resolver +

+ 		+

+ threads +

+ 		+

+ unsigned int +

+ 		+

+ 0 +

+ 		+

+ The number of internal threads to be used for asynchronous name + resolution. +

+

+ If non-zero, the specified number of threads are created when + the first resolver object is constructed. Otherwise, at most + one thread is created at the time of the first async_resolve call. +

+
+

+ These configuration options are associated with an execution context (such + as io_context + or thread_pool. + In order to use non-default values, a configuration service must be installed + into the execution context at construction. A number of ways to achieve + this are illustrated in the sections below. +

+
+ + Configuration + From String +
+

+ To read configuration options from a string, construct the execution context + with a config_from_string object: +

+
asio::io_context my_io_context{
+    asio::config_from_string{
+      "scheduler.concurrency_hint=10\n"
+      "scheduler.locking=1"}};
+
+

+ Each variable must be on a line of its own, and of the form: +

+
section.key=value
+
+

+ or, if an optional prefix is specified: +

+
prefix.section.key=value
+
+

+ Blank lines and lines starting with # + are ignored. It is also permitted to include a comment starting with # after the value. +

+
+ + Configuration + From Environment Variables +
+

+ To read configuration options from environment variables, construct the + execution context with a config_from_env object: +

+
asio::io_context my_io_context{
+    asio::config_from_env{"my_app"}};
+
+

+ The environment variable names are formed by concatenating the prefix, + section, and key, with underscore as delimiter, and then converting the + resulting string to upper case. For example, given a prefix "my_app" and the "scheduler" / "concurrency_hint" + option, + the value + is read + from an + environment variable + named MY_APP_SCHEDULER_CONCURRENCY_HINT`. +

+
+ + Configuration + From Concurrency Hint +
+

+ For backwards compatibility, the io_context constructor can be + passed a concurrency hint as an integer. This is used to initialise the + configuration options as described in the table below. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ concurrency_hint Value +

+ 		+

+ Effect +

+
+

+ n, where n < + 0xFFFF +

+ 		+

+ Equivalent to setting: +

+

+ — "scheduler" + / "concurrency_hint" + to n. +

+

+ — "scheduler" + / "locking" + to true. +

+

+ — "reactor" + / "registration_locking" + to true. +

+

+ — "reactor" + / "io_locking" + to true. +

+
+

+ ASIO_CONCURRENCY_HINT_UNSAFE +

+ 		+

+ — "scheduler" + / "concurrency_hint" + to 1. +

+

+ — "scheduler" + / "locking" + to false. +

+

+ — "reactor" + / "registration_locking" + to false. +

+

+ — "reactor" + / "io_locking" + to false. +

+
+

+ ASIO_CONCURRENCY_HINT_UNSAFE_IO +

+ 		+

+ — "scheduler" + / "concurrency_hint" + to 1. +

+

+ — "scheduler" + / "locking" + to true. +

+

+ — "reactor" + / "registration_locking" + to true. +

+

+ — "reactor" + / "io_locking" + to false. +

+
+

+ ASIO_CONCURRENCY_HINT_SAFE +

+ 		+

+ — "scheduler" + / "concurrency_hint" + to 0. +

+

+ — "scheduler" + / "locking" + to true. +

+

+ — "reactor" + / "registration_locking" + to true. +

+

+ — "reactor" + / "io_locking" + to true. +

+
+

+ The concurrency hint used by default-constructed io_context + objects can be overridden at compile time by defining the ASIO_CONCURRENCY_HINT_DEFAULT + macro. For example, specifying +

+
-DASIO_CONCURRENCY_HINT_DEFAULT=1
+
+

+ on the compiler command line means that a concurrency hint of 1 + is used for all default-constructed io_context objects in + the program. Similarly, the concurrency hint used by io_context + objects constructed with 1 can be overridden by defining + ASIO_CONCURRENCY_HINT_1. For example, passing +

+
-DASIO_CONCURRENCY_HINT_1=ASIO_CONCURRENCY_HINT_UNSAFE
+
+

+ to the compiler will disable thread safety for all of these objects. +

+
+ + Custom + Configuration Options +
+

+ Applications and third-party libraries can utilise the config class to associate their + own configuration options with an execution context, or to access the configuration + options listed above. The configuration parameters' values are accessed + by passing a section, key and default value to the get + member function:
+

+
asio::config cfg{ctx};
+bool enable_locking = cfg.get("scheduler", "locking", true);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/handler_tracking.html b/Packages/asio-1.36.0/doc/asio/overview/core/handler_tracking.html new file mode 100644 index 0000000..d5a7345 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/handler_tracking.html @@ -0,0 +1,488 @@ + + + +Handler Tracking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ To aid in debugging asynchronous programs, Asio provides support for handler + tracking. When enabled by defining ASIO_ENABLE_HANDLER_TRACKING, + Asio writes debugging output to the standard error stream. The output records + asynchronous operations and the relationships between their handlers. +

+

+ This feature is useful when debugging and you need to know how your asynchronous + operations are chained together, or what the pending asynchronous operations + are. As an illustration, here is the output when you run the HTTP Server + example, handle a single request, then shut down via Ctrl+C: +

+
@asio|1589424178.741850|0*1|signal_set@0x7ffee977d878.async_wait
+@asio|1589424178.742593|0*2|socket@0x7ffee977d8a8.async_accept
+@asio|1589424178.742619|.2|non_blocking_accept,ec=asio.system:11
+@asio|1589424178.742625|0|resolver@0x7ffee977d760.cancel
+@asio|1589424195.830382|.2|non_blocking_accept,ec=system:0
+@asio|1589424195.830413|>2|ec=system:0
+@asio|1589424195.830473|2*3|socket@0x7fa71d808230.async_receive
+@asio|1589424195.830496|.3|non_blocking_recv,ec=system:0,bytes_transferred=151
+@asio|1589424195.830503|2*4|socket@0x7ffee977d8a8.async_accept
+@asio|1589424195.830507|.4|non_blocking_accept,ec=asio.system:11
+@asio|1589424195.830510|<2|
+@asio|1589424195.830529|>3|ec=system:0,bytes_transferred=151
+@asio|1589424195.831143|3^5|in 'async_write' (./../../../include/asio/impl/write.hpp:330)
+@asio|1589424195.831143|3*5|socket@0x7fa71d808230.async_send
+@asio|1589424195.831186|.5|non_blocking_send,ec=system:0,bytes_transferred=1090
+@asio|1589424195.831194|<3|
+@asio|1589424195.831218|>5|ec=system:0,bytes_transferred=1090
+@asio|1589424195.831263|5|socket@0x7fa71d808230.close
+@asio|1589424195.831298|<5|
+@asio|1589424199.793770|>1|ec=system:0,signal_number=2
+@asio|1589424199.793781|1|socket@0x7ffee977d8a8.close
+@asio|1589424199.793809|<1|
+@asio|1589424199.793840|>4|ec=asio.system:125
+@asio|1589424199.793854|<4|
+@asio|1589424199.793883|0|signal_set@0x7ffee977d878.cancel
+
+

+ Each line is of the form: +

+
<tag>|<timestamp>|<action>|<description>
+
+

+ The <tag> is always @asio, and is used + to identify and extract the handler tracking messages from the program + output. +

+

+ The <timestamp> is seconds and microseconds from 1 Jan + 1970 UTC. +

+

+ The <action> takes one of the following forms: +

+
+

+
+
>n
+

+ The program entered the handler number n. The <description> + shows the arguments to the handler. +

+
<n
+

+ The program left handler number n. +

+
!n
+

+ The program left handler number n due to an exception. +

+
~n
+

+ The handler number n was destroyed without having been + invoked. This is usually the case for any unfinished asynchronous + operations when the io_context is destroyed. +

+
n^m
+

+ The handler number n is about to create a new asynchronous + operation with completion handler number m. The <description> + contains source location information to help identify where in the + program the asynchronous operation is being started. +

+
n*m
+

+ The handler number n created a new asynchronous operation + with completion handler number m. The <description> + shows what asynchronous operation was started. +

+
n
+

+ The handler number n performed some other operation. + The <description> shows what function was called. + Currently only close() and cancel() operations + are logged, as these may affect the state of pending asynchronous + operations. +

+
.n
+

+ The implementation performed a system call as part of the asynchronous + operation for which handler number n is the completion + handler. The <description> shows what function + was called and its results. These tracking events are only emitted + when using a reactor-based implementation. +

+
+
+

+ Where the <description> shows a synchronous or asynchronous + operation, the format is <object-type>@<pointer>.<operation>. + For handler entry, it shows a comma-separated list of arguments and their + values. +

+

+ As shown above, Each handler is assigned a numeric identifier. Where the + handler tracking output shows a handler number of 0, it means that the + action was performed outside of any handler. +

+
+ + Adding + Location Information +
+

+ Programs may augment the handler tracking output's location information + by using the macro ASIO_HANDLER_LOCATION + in the source code. For example: +

+
#define HANDLER_LOCATION \
+  ASIO_HANDLER_LOCATION((__FILE__, __LINE__, __func__))
+
+// ...
+
+void do_read()
+{
+  HANDLER_LOCATION;
+
+  auto self(shared_from_this());
+  socket_.async_read_some(asio::buffer(data_, max_length),
+      [this, self](std::error_code ec, std::size_t length)
+      {
+        HANDLER_LOCATION;
+
+        if (!ec)
+        {
+          do_write(length);
+        }
+      });
+}
+
+

+ With the additional location information available, the handler tracking + output may include a call stack of source locations: +

+
@asio|1589423304.861944|>7|ec=system:0,bytes_transferred=5
+@asio|1589423304.861952|7^8|in 'async_write' (./../../../include/asio/impl/write.hpp:330)
+@asio|1589423304.861952|7^8|called from 'do_write' (handler_tracking/async_tcp_echo_server.cpp:62)
+@asio|1589423304.861952|7^8|called from 'operator()' (handler_tracking/async_tcp_echo_server.cpp:51)
+@asio|1589423304.861952|7*8|socket@0x7ff61c008230.async_send
+@asio|1589423304.861975|.8|non_blocking_send,ec=system:0,bytes_transferred=5
+@asio|1589423304.861980|<7|
+
+

+ Furthermore, if std::source_location or std::experimental::source_location + are available, the use_awaitable_t + token (when default-constructed or used as a default completion token) + will also cause handler tracking to output a source location for each newly + created asynchronous operation. A use_awaitable_t object may + also be explicitly constructed with location information. +

+
+ + Visual + Representations +
+

+ The handler tracking output may be post-processed using the included handlerviz.pl + tool to create a visual representation of the handlers (requires the GraphViz + tool dot). +

+
+ + Custom Tracking +
+

+ Handling tracking may be customised by defining the ASIO_CUSTOM_HANDLER_TRACKING + macro to the name of a header file (enclosed in "" + or <>). This header + file must implement the following preprocessor macros: +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Macro +

+ 		+

+ Description +

+
+

+ ASIO_INHERIT_TRACKED_HANDLER +

+ 		+

+ Specifies a base class for classes that implement asynchronous + operations. When used, the macro immediately follows the class + name, so it must have the form : + public my_class. +

+
+

+ ASIO_ALSO_INHERIT_TRACKED_HANDLER +

+ 		+

+ Specifies a base class for classes that implement asynchronous + operations. When used, the macro follows other base classes, + so it must have the form , + public my_class. +

+
+

+ ASIO_HANDLER_TRACKING_INIT(args) +

+ 		+

+ An expression that is used to initialise the tracking mechanism. +

+
+

+ ASIO_HANDLER_LOCATION(args) +

+ 		+

+ A variable declaration that is used to define a source code location. + args is a parenthesised + function argument list containing the file name, line number, + and function name. +

+
+

+ ASIO_HANDLER_CREATION(args) +

+ 		+

+ An expression that is called on creation of an asynchronous operation. + args is a parenthesised + function argument list containing the owning execution context, + the tracked handler, the name of the object type, a pointer to + the object, the object's native handle, and the operation name. +

+
+

+ ASIO_HANDLER_COMPLETION(args) +

+ 		+

+ An expression that is called on completion of an asynchronous + operation. args + is a parenthesised function argument list containing the tracked + handler. +

+
+

+ ASIO_HANDLER_INVOCATION_BEGIN(args) +

+ 		+

+ An expression that is called immediately before a completion + handler is invoked. args + is a parenthesised function argument list containing the arguments + to the completion handler. +

+
+

+ ASIO_HANDLER_INVOCATION_END +

+ 		+

+ An expression that is called immediately after a completion handler + is invoked. +

+
+

+ ASIO_HANDLER_OPERATION(args) +

+ 		+

+ An expression that is called when some synchronous object operation + is called (such as close() or cancel()). args + is a parenthesised function argument list containing the owning + execution context, the name of the object type, a pointer to + the object, the object's native handle, and the operation name. +

+
+

+ ASIO_HANDLER_REACTOR_REGISTRATION(args) +

+ 		+

+ An expression that is called when an object is registered with + the reactor. args + is a parenthesised function argument list containing the owning + execution context, the object's native handle, and a unique registration + key. +

+
+

+ ASIO_HANDLER_REACTOR_DEREGISTRATION(args) +

+ 		+

+ An expression that is called when an object is deregistered from + the reactor. args + is a parenthesised function argument list containing the owning + execution context, the object's native handle, and a unique registration + key. +

+
+

+ ASIO_HANDLER_REACTOR_READ_EVENT +

+ 		+

+ A bitmask constant used to identify reactor read readiness events. +

+
+

+ ASIO_HANDLER_REACTOR_WRITE_EVENT +

+ 		+

+ A bitmask constant used to identify reactor write readiness events. +

+
+

+ ASIO_HANDLER_REACTOR_ERROR_EVENT +

+ 		+

+ A bitmask constant used to identify reactor error readiness events. +

+
+

+ ASIO_HANDLER_REACTOR_EVENTS(args) +

+ 		+

+ An expression that is called when an object registered with the + reactor becomes ready. args + is a parenthesised function argument list containing the owning + execution context, the unique registration key, and a bitmask + of the ready events. +

+
+

+ ASIO_HANDLER_REACTOR_OPERATION(args) +

+ 		+

+ An expression that is called when the implementation performs + a system call as part of a reactor-based asynchronous operation. + args is a parenthesised + function argument list containing the tracked handler, the operation + name, the error code produced by the operation, and (optionally) + the number of bytes transferred. +

+
+
+ + See + Also +
+

+ Handler tracking + examples. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/line_based.html b/Packages/asio-1.36.0/doc/asio/overview/core/line_based.html new file mode 100644 index 0000000..894997c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/line_based.html @@ -0,0 +1,156 @@ + + + +Line-Based Operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Many commonly-used internet protocols are line-based, which means that + they have protocol elements that are delimited by the character sequence + "\r\n". Examples + include HTTP, SMTP and FTP. To more easily permit the implementation of + line-based protocols, as well as other protocols that use delimiters, Asio + includes the functions read_until() and async_read_until(). +

+

+ The following example illustrates the use of async_read_until() in an HTTP server, to receive the first + line of an HTTP request from a client: +

+
class http_connection
+{
+  ...
+
+  void start()
+  {
+    asio::async_read_until(socket_, data_, "\r\n",
+        boost::bind(&http_connection::handle_request_line, this, _1));
+  }
+
+  void handle_request_line(asio::error_code ec)
+  {
+    if (!ec)
+    {
+      std::string method, uri, version;
+      char sp1, sp2, cr, lf;
+      std::istream is(&data_);
+      is.unsetf(std::ios_base::skipws);
+      is >> method >> sp1 >> uri >> sp2 >> version >> cr >> lf;
+      ...
+    }
+  }
+
+  ...
+
+  asio::ip::tcp::socket socket_;
+  asio::streambuf data_;
+};
+
+

+ The streambuf data member + serves as a place to store the data that has been read from the socket + before it is searched for the delimiter. It is important to remember that + there may be additional data after the delimiter. + This surplus data should be left in the streambuf + so that it may be inspected by a subsequent call to read_until() or async_read_until(). +

+

+ The delimiters may be specified as a single char, + a std::string or a boost::regex. + The read_until() + and async_read_until() + functions also include overloads that accept a user-defined function object + called a match condition. For example, to read data into a streambuf until + whitespace is encountered: +

+
typedef asio::buffers_iterator<
+    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);
+}
+...
+asio::streambuf b;
+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
+...
+asio::streambuf b;
+asio::read_until(s, b, match_char('a'));
+
+

+ The is_match_condition<> type trait automatically evaluates + to true for functions, and for function objects with a nested result_type typedef. For other types + the trait must be explicitly specialised, as shown above. +

+
+ + See + Also +
+

+ async_read_until(), + is_match_condition, + read_until(), streambuf, + HTTP client example. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/reactor.html b/Packages/asio-1.36.0/doc/asio/overview/core/reactor.html new file mode 100644 index 0000000..f10606a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/reactor.html @@ -0,0 +1,77 @@ + + + +Reactor-Style Operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sometimes a program must be integrated with a third-party library that + wants to perform the I/O operations itself. To facilitate this, Asio includes + synchronous and asynchronous operations that may be used to wait for a + socket to become ready to read, ready to write, or to have a pending error + condition. +

+

+ As an example, to perform a non-blocking read something like the following + may be used: +

+
ip::tcp::socket socket(my_io_context);
+...
+socket.non_blocking(true);
+...
+socket.async_wait(ip::tcp::socket::wait_read, read_handler);
+...
+void read_handler(asio::error_code ec)
+{
+  if (!ec)
+  {
+    std::vector<char> buf(socket.available());
+    socket.read_some(buffer(buf));
+  }
+}
+
+

+ These operations are supported for sockets on all platforms, and for the + POSIX stream-oriented descriptor classes. +

+
+ + See + Also +
+

+ basic_socket::wait(), + basic_socket::async_wait(), + basic_socket::non_blocking(), + basic_socket::native_non_blocking(), + nonblocking example. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/strands.html b/Packages/asio-1.36.0/doc/asio/overview/core/strands.html new file mode 100644 index 0000000..833aee9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/strands.html @@ -0,0 +1,159 @@ + + + +Strands: Use Threads Without Explicit Locking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A strand is defined as a strictly sequential invocation of event handlers + (i.e. no concurrent invocation). Use of strands allows execution of code + in a multithreaded program without the need for explicit locking (e.g. + using mutexes). +

+

+ Strands may be either implicit or explicit, as illustrated by the following + alternative approaches: +

+
    +
  • + Calling io_context::run() from only one thread means all event handlers + execute in an implicit strand, due to the io_context's guarantee that + handlers are only invoked from inside run(). +
    • +
  • + Where there is a single chain of asynchronous operations associated + with a connection (e.g. in a half duplex protocol implementation like + HTTP) there is no possibility of concurrent execution of the handlers. + This is an implicit strand. +
    • +
  • + An explicit strand is an instance of strand<> or io_context::strand. + All event handler function objects need to be bound to the strand using + asio::bind_executor() + or otherwise posted/dispatched through the strand object. +
    • +
+

+ In the case of composed asynchronous operations, such as async_read() + or async_read_until(), + if a completion handler goes through a strand, then all intermediate handlers + should also go through the same strand. This is needed to ensure thread + safe access for any objects that are shared between the caller and the + composed operation (in the case of async_read() it's the socket, which the caller can + close() + to cancel the operation). +

+

+ To achieve this, all asynchronous operations obtain the handler's associated + executor by using the get_associated_executor + function. For example: +

+
asio::associated_executor_t<Handler> a = asio::get_associated_executor(h);
+
+

+ The associated executor must satisfy the Executor requirements. It will + be used by the asynchronous operation to submit both intermediate and final + handlers for execution. +

+

+ The executor may be customised for a particular handler type by specifying + a nested type executor_type + and member function get_executor(): +

+
class my_handler
+{
+public:
+  // Custom implementation of Executor type requirements.
+  typedef my_executor executor_type;
+
+  // Return a custom executor implementation.
+  executor_type get_executor() const noexcept
+  {
+    return my_executor();
+  }
+
+  void operator()() { ... }
+};
+
+

+ In more complex cases, the associated_executor + template may be partially specialised directly: +

+
struct my_handler
+{
+  void operator()() { ... }
+};
+
+namespace asio {
+
+  template <class Executor>
+  struct associated_executor<my_handler, Executor>
+  {
+    // Custom implementation of Executor type requirements.
+    typedef my_executor type;
+
+    // Return a custom executor implementation.
+    static type get(const my_handler&,
+        const Executor& = Executor()) noexcept
+    {
+      return my_executor();
+    }
+  };
+
+} // namespace asio
+
+

+ The asio::bind_executor() + function is a helper to bind a specific executor object, such as a strand, + to a completion handler. This binding automatically associates an executor + as shown above. For example, to bind a strand to a completion handler we + would simply write: +

+
my_socket.async_read_some(my_buffer,
+    asio::bind_executor(my_strand,
+      [](error_code ec, size_t length)
+      {
+        // ...
+      }));
+
+
+ + See + Also +
+

+ associated_executor, + get_associated_executor, + bind_executor, strand, io_context::strand, + tutorial Timer.5, HTTP server 3 example. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/streams.html b/Packages/asio-1.36.0/doc/asio/overview/core/streams.html new file mode 100644 index 0000000..16493dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/streams.html @@ -0,0 +1,119 @@ + + + +Streams, Short Reads and Short Writes + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Many I/O objects in Asio are stream-oriented. This means that: +

+
    +
  • + There are no message boundaries. The data being transferred is a continuous + sequence of bytes. +
    • +
  • + Read or write operations may transfer fewer bytes than requested. This + is referred to as a short read or short write. +
    • +
+

+ Objects that provide stream-oriented I/O model one or more of the following + type requirements: +

+
    +
  • + SyncReadStream, where + synchronous read operations are performed using a member function called + read_some(). +
    • +
  • + AsyncReadStream, where + asynchronous read operations are performed using a member function + called async_read_some(). +
    • +
  • + SyncWriteStream, where + synchronous write operations are performed using a member function + called write_some(). +
    • +
  • + AsyncWriteStream, where + asynchronous write operations are performed using a member function + called async_write_some(). +
    • +
+

+ Examples of stream-oriented I/O objects include ip::tcp::socket, + ssl::stream<>, + posix::stream_descriptor, windows::stream_handle, + etc. +

+

+ Programs typically want to transfer an exact number of bytes. When a short + read or short write occurs the program must restart the operation, and + continue to do so until the required number of bytes has been transferred. + Asio provides generic functions that do this automatically: read(), + async_read(), + write() + and async_write(). +

+
+ + Why + EOF is an Error +
+
    +
  • + The end of a stream can cause read, + async_read, read_until or async_read_until + functions to violate their contract. E.g. a read of N bytes may finish + early due to EOF. +
    • +
  • + An EOF error may be used to distinguish the end of a stream from a + successful read of size 0. +
    • +
+
+ + See + Also +
+

+ async_read(), async_write(), + read(), write(), + AsyncReadStream, + AsyncWriteStream, + SyncReadStream, SyncWriteStream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/core/threads.html b/Packages/asio-1.36.0/doc/asio/overview/core/threads.html new file mode 100644 index 0000000..34cfb80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/core/threads.html @@ -0,0 +1,122 @@ + + + +Threads and Asio + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + Thread + Safety +
+

+ In general, it is safe to make concurrent use of distinct objects, but + unsafe to make concurrent use of a single object. However, types such as + io_context provide a stronger + guarantee that it is safe to use a single object concurrently. +

+
+ + Thread + Pools +
+

+ Multiple threads may call io_context::run() to set up a pool of threads from which + completion handlers may be invoked. This approach may also be used with + post() + as a means to perform arbitrary computational tasks across a thread pool. +

+

+ Note that all threads that have joined an io_context's + pool are considered equivalent, and the io_context + may distribute work across them in an arbitrary fashion. +

+
+ + Internal + Threads +
+

+ The implementation of this library for a particular platform may make use + of one or more internal threads to emulate asynchronicity. As far as possible, + these threads must be invisible to the library user. In particular, the + threads: +

+
    +
  • + must not call the user's code directly; and +
    • +
  • + must block all signals. +
    • +
+

+ This approach is complemented by the following guarantee: +

+
  • + Asynchronous completion handlers will only be called from threads that + are currently calling io_context::run(). +
+

+ Consequently, it is the library user's responsibility to create and manage + all threads to which the notifications will be delivered. +

+

+ The reasons for this approach include: +

+
    +
  • + By only calling io_context::run() from a single thread, the user's + code can avoid the development complexity associated with synchronisation. + For example, a library user can implement scalable servers that are + single-threaded (from the user's point of view). +
    • +
  • + A library user may need to perform initialisation in a thread shortly + after the thread starts and before any other application code is executed. + For example, users of Microsoft's COM must call CoInitializeEx + before any other COM operations can be called from that thread. +
    • +
  • + The library interface is decoupled from interfaces for thread creation + and management, and permits implementations on platforms where threads + are not available. +
    • +
+
+ + See + Also +
+

+ io_context, post. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011.html new file mode 100644 index 0000000..57a9f90 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011.html @@ -0,0 +1,60 @@ + + + +C++ 2011 Support + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ System Errors and Error + Codes +

+

+ Movable I/O Objects +

+

+ Movable Handlers +

+

+ Variadic Templates +

+

+ Array Container +

+

+ Atomics +

+

+ Shared Pointers +

+

+ Chrono +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/array.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/array.html new file mode 100644 index 0000000..61acef3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/array.html @@ -0,0 +1,61 @@ + + + +Array Container + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Where the standard library provides std::array<>, Asio: +

+
+

+ Support for std::array<> + is automatically enabled for g++ 4.3 and later, when + the -std=c++0x or -std=gnu++0x compiler + options are used, as well as for Microsoft Visual C++ 10. It may be disabled + by defining ASIO_DISABLE_STD_ARRAY, + or explicitly enabled for other compilers by defining ASIO_HAS_STD_ARRAY. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/atomic.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/atomic.html new file mode 100644 index 0000000..9326ebc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/atomic.html @@ -0,0 +1,45 @@ + + + +Atomics + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio's implementation can use std::atomic<> in preference to boost::detail::atomic_count. +

+

+ Support for the standard atomic integer template is automatically enabled + for g++ 4.5 and later, when the -std=c++0x + or -std=gnu++0x compiler options are used. It may be + disabled by defining ASIO_DISABLE_STD_ATOMIC, + or explicitly enabled for other compilers by defining ASIO_HAS_STD_ATOMIC. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/chrono.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/chrono.html new file mode 100644 index 0000000..25fc0c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/chrono.html @@ -0,0 +1,57 @@ + + + +Chrono + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+Chrono +

+

+ Asio provides timers based on the std::chrono + facilities via the basic_waitable_timer + class template. The typedefs system_timer, + steady_timer and 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 ASIO_DISABLE_STD_CHRONO, + or explicitly enabled for other compilers by defining ASIO_HAS_STD_CHRONO. +

+

+ When standard chrono is + unavailable, Asio will otherwise use the Boost.Chrono library. The basic_waitable_timer + class template may be used with either. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/move_handlers.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/move_handlers.html new file mode 100644 index 0000000..c546e64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/move_handlers.html @@ -0,0 +1,78 @@ + + + +Movable Handlers + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ With C++11 and later, user-defined completion handlers are only required + to be move constructible, and are not required to be copy constructible. +

+

+ When move support is enabled, asynchronous that are documented as follows: +

+
template <typename Handler>
+void async_XYZ(..., Handler handler);
+
+

+ are actually declared as: +

+
template <typename Handler>
+void async_XYZ(..., Handler&& handler);
+
+

+ The handler argument is perfectly forwarded and the move construction occurs + within the body of async_XYZ(). This ensures that all other function + arguments are evaluated prior to the move. This is critical when the other + arguments to async_XYZ() are members of the handler. For example: +

+
struct my_operation
+{
+  unique_ptr<tcp::socket> socket;
+  unique_ptr<vector<char>> buffer;
+  ...
+  void operator(error_code ec, size_t length)
+  {
+    ...
+    socket->async_read_some(asio::buffer(*buffer), std::move(*this));
+    ...
+  }
+};
+
+

+ Move support is automatically enabled for g++ 4.5 and + later, when the -std=c++0x or -std=gnu++0x + compiler options are used. It may be disabled by defining ASIO_DISABLE_MOVE, or explicitly enabled + for other compilers by defining ASIO_HAS_MOVE. + Note that these macros also affect the availability of movable + I/O objects. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/move_objects.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/move_objects.html new file mode 100644 index 0000000..cfc50bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/move_objects.html @@ -0,0 +1,100 @@ + + + +Movable I/O Objects + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ When move support is available (via rvalue references), Asio allows move + construction and assignment of sockets, serial ports, POSIX descriptors + and Windows handles. +

+

+ Move support allows you to write code like: +

+
tcp::socket make_socket(io_context& i)
+{
+  tcp::socket s(i);
+  ...
+  std::move(s);
+}
+
+

+ or: +

+
class connection : public enable_shared_from_this<connection>
+{
+private:
+  tcp::socket socket_;
+  ...
+public:
+  connection(tcp::socket&& s) : socket_(std::move(s)) {}
+  ...
+};
+
+...
+
+class server
+{
+private:
+  tcp::acceptor acceptor_;
+  ...
+  void handle_accept(error_code ec, tcp::socket socket)
+  {
+    if (!ec)
+      std::make_shared<connection>(std::move(socket))->go();
+    acceptor_.async_accept(...);
+  }
+  ...
+};
+
+

+ as well as: +

+
std::vector<tcp::socket> sockets;
+sockets.push_back(tcp::socket(...));
+
+

+ A word of warning: There is nothing stopping you from moving these objects + while there are pending asynchronous operations, but it is unlikely to + be a good idea to do so. In particular, composed operations like async_read() store a reference + to the stream object. Moving during the composed operation means that the + composed operation may attempt to access a moved-from object. +

+

+ Move support is automatically enabled for g++ 4.5 and + later, when the -std=c++0x or -std=gnu++0x + compiler options are used. It may be disabled by defining ASIO_DISABLE_MOVE, or explicitly enabled + for other compilers by defining ASIO_HAS_MOVE. + Note that these macros also affect the availability of movable + handlers. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/shared_ptr.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/shared_ptr.html new file mode 100644 index 0000000..113e7c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/shared_ptr.html @@ -0,0 +1,45 @@ + + + +Shared Pointers + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio's implementation can use std::shared_ptr<> and std::weak_ptr<> in preference to the Boost equivalents. +

+

+ Support for the standard smart pointers is automatically enabled for g++ + 4.3 and later, when the -std=c++0x or -std=gnu++0x + compiler options are used, as well as for Microsoft Visual C++ 10. It may + be disabled by defining ASIO_DISABLE_STD_SHARED_PTR, + or explicitly enabled for other compilers by defining ASIO_HAS_STD_SHARED_PTR. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/system_error.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/system_error.html new file mode 100644 index 0000000..f389050 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/system_error.html @@ -0,0 +1,49 @@ + + + +System Errors and Error Codes + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ When available, Asio can use the std::error_code + and std::system_error classes for reporting errors. + In this case, the names asio::error_code + and asio::system_error will be typedefs for these + standard classes. +

+

+ System error support is automatically enabled for g++ + 4.6 and later, when the -std=c++0x or -std=gnu++0x + compiler options are used. It may be disabled by defining ASIO_DISABLE_STD_SYSTEM_ERROR, or explicitly + enabled for other compilers by defining ASIO_HAS_STD_SYSTEM_ERROR. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/cpp2011/variadic.html b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/variadic.html new file mode 100644 index 0000000..e64d266 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/cpp2011/variadic.html @@ -0,0 +1,47 @@ + + + +Variadic Templates + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ When supported by a compiler, Asio can use variadic templates to implement + the basic_socket_streambuf::connect() + and basic_socket_iostream::connect() + functions. +

+

+ Support for variadic templates is automatically enabled for g++ + 4.3 and later, when the -std=c++0x or -std=gnu++0x + compiler options are used. It may be disabled by defining ASIO_DISABLE_VARIADIC_TEMPLATES, or explicitly + enabled for other compilers by defining ASIO_HAS_VARIADIC_TEMPLATES. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/files.html b/Packages/asio-1.36.0/doc/asio/overview/files.html new file mode 100644 index 0000000..e97ffc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/files.html @@ -0,0 +1,86 @@ + + + +Files + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+Files +

+
+ + + + + +
[Note]Note

+ This feature requires I/O completion ports on Windows, and io_uring on + Linux (define ASIO_HAS_IO_URING + to enable). +

+

+ Asio provides support for manipulating stream-oriented and random-access + files. For example, to write to a newly created stream-oriented file: +

+
asio::stream_file file(
+    my_io_context, "/path/to/file",
+    asio::stream_file::write_only
+      | asio::stream_file::create
+      | asio::stream_file::truncate);
+
+file.async_write_some(my_buffer,
+    [](error_code e, size_t n)
+    {
+      // ...
+    });
+
+

+ or to read from a random-access file: +

+
asio::random_access_file file(
+    my_io_context, "/path/to/file",
+    asio::random_access_file::read_only);
+
+file.async_read_some_at(1234, my_buffer,
+    [](error_code e, size_t n)
+    {
+      // ...
+    });
+
+
+ + See + Also +
+

+ basic_file, basic_random_access_file, + basic_stream_file, + file_base, random_access_file, + stream_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/implementation.html b/Packages/asio-1.36.0/doc/asio/overview/implementation.html new file mode 100644 index 0000000..adec8ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/implementation.html @@ -0,0 +1,578 @@ + + + +Platform-Specific Implementation Notes + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This section lists platform-specific implementation details, such as the + default demultiplexing mechanism, the number of threads created internally, + and when threads are created. +

+
+ + Linux + Kernel 2.4 +
+

+ Demultiplexing mechanism: +

+
  • + Uses select for demultiplexing. + This means that the number of file descriptors in the process cannot + be permitted to exceed FD_SETSIZE. +
+

+ Threads: +

+
    +
  • + Demultiplexing using select + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + Linux + Kernel 2.6 +
+

+ Demultiplexing mechanism: +

+
  • + Uses epoll for demultiplexing. +
+

+ Threads: +

+
    +
  • + Demultiplexing using epoll + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + Linux + Kernel 5.10 +
+

+ Demultiplexing mechanism: +

+
    +
  • + If ASIO_HAS_IO_URING + is defined, uses io_uring + for file-related asynchonous operations. +
    • +
  • + Uses epoll for demultiplexing + other event sources. +
    • +
  • + Optionally uses io_uring + for all asynchronous operations if, in addition to ASIO_HAS_IO_URING, + ASIO_DISABLE_EPOLL is + defined to disable epoll. +
    • +
+

+ Threads: +

+
    +
  • + Demultiplexing using epoll + and io_uring is performed + in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + Solaris +
+

+ Demultiplexing mechanism: +

+
  • + Uses /dev/poll for demultiplexing. +
+

+ Threads: +

+
    +
  • + Demultiplexing using /dev/poll is performed in one + of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + QNX + Neutrino +
+

+ Demultiplexing mechanism: +

+
  • + Uses select for demultiplexing. + This means that the number of file descriptors in the process cannot + be permitted to exceed FD_SETSIZE. +
+

+ Threads: +

+
    +
  • + Demultiplexing using select + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + Mac + OS X +
+

+ Demultiplexing mechanism: +

+
  • + Uses kqueue for demultiplexing. +
+

+ Threads: +

+
    +
  • + Demultiplexing using kqueue + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + FreeBSD +
+

+ Demultiplexing mechanism: +

+
  • + Uses kqueue for demultiplexing. +
+

+ Threads: +

+
    +
  • + Demultiplexing using kqueue + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + AIX +
+

+ Demultiplexing mechanism: +

+
  • + Uses select for demultiplexing. + This means that the number of file descriptors in the process cannot + be permitted to exceed FD_SETSIZE. +
+

+ Threads: +

+
    +
  • + Demultiplexing using select + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + HP-UX +
+

+ Demultiplexing mechanism: +

+
  • + Uses select for demultiplexing. + This means that the number of file descriptors in the process cannot + be permitted to exceed FD_SETSIZE. +
+

+ Threads: +

+
    +
  • + Demultiplexing using select + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + Tru64 +
+

+ Demultiplexing mechanism: +

+
  • + Uses select for demultiplexing. + This means that the number of file descriptors in the process cannot + be permitted to exceed FD_SETSIZE. +
+

+ Threads: +

+
    +
  • + Demultiplexing using select + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + At most min(64,IOV_MAX) buffers may be transferred in a single + operation. +
+
+ + Windows + 95, 98 and Me +
+

+ Demultiplexing mechanism: +

+
  • + Uses select for demultiplexing. +
+

+ Threads: +

+
    +
  • + Demultiplexing using select + is performed in one of the threads that calls io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
  • + For sockets, at most 16 buffers may be transferred in a single operation. +
+
+ + Windows + NT, 2000, XP, 2003, Vista, 7, 8, 10 and 11 +
+

+ Demultiplexing mechanism: +

+
    +
  • + Uses overlapped I/O and I/O completion ports for all asynchronous socket + operations except for asynchronous connect. +
    • +
  • + Uses select for emulating + asynchronous connect. +
    • +
+

+ Threads: +

+
    +
  • + Demultiplexing using I/O completion ports is performed in all threads + that call io_context::run(), io_context::run_one(), io_context::poll() or io_context::poll_one(). +
    • +
  • + An additional thread per io_context + is used to trigger timers. This thread is created on construction of + the first basic_deadline_timer + or basic_waitable_timer + objects. +
    • +
  • + An additional thread per io_context + may be used for select + demultiplexing. This thread is created on the first call to: +
      +
    • + A socket async_wait() function, except when using + wait_read on a + stream-oriented socket. (For wait_read + on a stream-oriented socket, the overlapped I/O operation WSARecv is used and no additional + thread is required.) +
      • +
    • + A socket async_connect() operation, if the overlapped + I/O operation ConnectEx + is unavailable. (On recent versions of Windows, ConnectEx + is used and no additional thread is required.) +
      • +
    +
    • +
  • + One or more additional threads per io_context + to emulate asynchronous host resolution. By default, only one thread + is created, but this behaviour may be altered via the "resolver" + / "threads" configuration + option. +
    • +
+

+ Scatter-Gather: +

+
    +
  • + For sockets, at most 64 buffers may be transferred in a single operation. +
    • +
  • + For stream-oriented handles, only one buffer may be transferred in a + single operation. +
    • +
+
+ + Windows + Runtime +
+

+ Asio provides limited support for the Windows Runtime. It requires that the + language extensions be enabled. Due to the restricted facilities exposed + by the Windows Runtime API, the support comes with the following caveats: +

+
    +
  • + The core facilities such as the io_context, + strand, buffers, composed + operations, timers, etc., should all work as normal. +
    • +
  • + For sockets, only client-side TCP is supported. +
    • +
  • + Explicit binding of a client-side TCP socket is not supported. +
    • +
  • + The cancel() + function is not supported for sockets. Asynchronous operations may only + be cancelled by closing the socket. +
    • +
  • + Operations that use null_buffers + are not supported. +
    • +
  • + Only tcp::no_delay and socket_base::keep_alive + options are supported. +
    • +
  • + Resolvers do not support service names, only numbers. I.e. you must use + "80" rather than "http". +
    • +
  • + Most resolver query flags have no effect. +
    • +
+

+ Demultiplexing mechanism: +

+
  • + Uses the Windows::Networking::Sockets::StreamSocket class to implement asynchronous + TCP socket operations. +
+

+ Threads: +

+
    +
  • + Event completions are delivered to the Windows thread pool and posted + to the io_context for + the handler to be executed. +
    • +
  • + An additional thread per io_context + is used to trigger timers. This thread is created on construction of + the first timer objects. +
    • +
+

+ Scatter-Gather: +

+
  • + For sockets, at most one buffer may be transferred in a single operation. +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model.html b/Packages/asio-1.36.0/doc/asio/overview/model.html new file mode 100644 index 0000000..be78741 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model.html @@ -0,0 +1,78 @@ + + + +Asynchronous Model + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This section presents a high-level overview of the asynchronous model at + the core of the Asio library. This model enshrines asynchronous operations + as the fundamental building block of asynchronous composition, but in a way + that decouples them from the composition mechanism. The asynchronous operations + in Asio support callbacks, futures (both eager and lazy), fibers, coroutines, + and approaches yet to be imagined. This allows the application programmer + to select an approach based on appropriate trade-offs. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/allocators.html b/Packages/asio-1.36.0/doc/asio/overview/model/allocators.html new file mode 100644 index 0000000..375ba19 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/allocators.html @@ -0,0 +1,114 @@ + + + +Allocators + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Every asynchronous agent has an associated allocator. + An agent's allocator is an interface used by the agent's asynchronous operations + to obtain per-operation stable memory resources (POSMs). + This name reflects the fact that the memory is per-operation because the + memory is only retained for the lifetime of that operation, and stable, + because the memory is guaranteed to be available at that location throughout + the operation. +

+

+ Asynchronous operations may utilise POSMs in a number of different ways: +

+
    +
  • + The operation doesn't require any POSMs. For example, the operation + wraps an existing API that performs its own memory management, or is + copying the long lived state into existing memory like a circular buffer. +
    • +
  • + The operation uses a single, fixed-size POSM for as long as the operation + is outstanding. For example, the operation stores some state in a linked + list. +
    • +
  • + The operation uses a single, runtime-sized POSM. For example, the operation + stores a copy of a user-supplied buffer, or a runtime-sized array of + iovec structures. +
    • +
  • + The operation uses multiple POSMs concurrently. For example, a fixed + size POSM for a linked list plus a runtime-sized POSM for a buffer. +
    • +
  • + The operation uses multiple POSMs serially, which may vary in size. +
    • +
+

+ Associated allocators allow users to treat POSM optimisation as a cross-cutting + concern to the composition of asynchronous operations. Furthermore, using + allocators as the interface to obtain POSMs grant substantial flexibility + to both the implementers and users of asynchronous operations: +

+
    +
  • + Users can ignore the allocator and accept whatever default strategy + is employed by the application. +
    • +
  • + Implementers can ignore the allocator, especially if the operation + is not considered performance-sensitive. +
    • +
  • + Users can co-locate POSMs for related asynchronous operations, for + better locality of reference. +
    • +
  • + For compositions that involve serial POSMs of different sizes, memory + usage need only be as great as the currently extant POSM. For example, + consider a composition that contains a short-lived operation that uses + large POSMs (connection establishment and handshake) followed by a + long-lived operation that uses small POSMs (transferring data to and + from the peer). +
    • +
+

+ As noted previously, all resources must be released prior to calling the + completion handler. This enables memory to be recycled for subsequent asynchronous + operations within an agent. This allows applications with long-lived asynchronous + agents to have no hot-path memory allocations, even though the user code + is unaware of associated allocators. +

+
+ + See + Also +
+

+ Custom Memory Allocation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/associators.html b/Packages/asio-1.36.0/doc/asio/overview/model/associators.html new file mode 100644 index 0000000..1fccebf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/associators.html @@ -0,0 +1,151 @@ + + + +Associated Characteristics and Associators + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ An asynchronous agent has associated characteristics + that specify how asynchronous operations should behave when composed as + part of that agent, such as: +

+
    +
  • + An allocator, which determines how the agent's asynchronous operations + obtain memory resources. +
    • +
  • + A cancellation slot, which determines how the agent's asynchronous + operations support cancellation. +
    • +
  • + An executor, which determines how the agent's completion handlers will + be queued and run. +
    • +
+

+ When an asynchronous operation is run within an asynchronous agent, its + implementation may query these associated characteristics and use them + to satisfy the requirements or preferences they represent. The asynchronous + operation performs these queries by applying associator + traits to the completion handler. Each characteristic has a corresponding + associator trait. +

+

+ An associator trait may be specialised for concrete completion handler + types to: +

+
    +
  • + accept the default characteristic supplied by the asynchronous operation, + returning this default as-is +
    • +
  • + return an unrelated implementation of the characteristic, or +
    • +
  • + adapt the supplied default to introduce additional behaviour required + by the completion handler. +
    • +
+
+ + Specification + of an Associator +
+

+ Given an associator trait named[2] associated_R, + having: +

+
    +
  • + a source value s of + type S, in this case + the completion handler and its type, +
    • +
  • + a set of type requirements (or a concept) R + that define the syntactic and semantic requirements of the associated + characteristic, and +
    • +
  • + a candidate value c + of type C that meets + the type requirements R, + which represents a default implementation of the associated characteristic, + supplied by the asynchronous operation +
    • +
+

+ the asynchronous operation uses the associator trait to compute: +

+
    +
  • + the type associated_R<S, C>::type, + and +
    • +
  • + the value associated_R<S, C>::get(s, c) +
    • +
+

+ that meet the requirements defined in R. + For convenience, these are also accessible via type alias associated_R_t<S, C> and free function get_associated_R(s, + c), + respectively. +

+

+ The trait's primary template is specified such that: +

+
    +
  • + if S::R_type is well-formed, defines a + nested type alias type as S::R_type, + and a static member function get that returns s.get_R() +
    • +
  • + otherwise, if associator<associated_R, S, C>::type + is well-formed and denotes a type, inherits from associator<associated_R, S, C> +
    • +
  • + otherwise, defines a nested type alias type as C, + and a static member function get that returns c. +
    • +
+
+
+

[2] + The associator traits are named associated_allocator, associated_executor, + and associated_cancellation_slot. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/async_agents.html b/Packages/asio-1.36.0/doc/asio/overview/model/async_agents.html new file mode 100644 index 0000000..ff89034 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/async_agents.html @@ -0,0 +1,70 @@ + + + +Asynchronous Agents + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An asynchronous agent is a sequential composition + of asynchronous operations. Every asynchronous operation is considered + to run as a part of an asynchronous agent, even if that agent contains + only that single operation. An asynchronous agent is an entity that may + perform work concurrently with other agents. Asynchronous agents are to + asynchronous operations as threads are to synchronous operations. +

+

+ However, an asynchronous agent is a purely notional construct that allows + us to reason about the context for, and composition of, asynchronous operations + in a program. The name “asynchronous agent” does not appear in the + library, nor is it important which concrete mechanism[1] is used to compose the asynchronous operations in an agent. +

+

+ We can visualise an asynchronous agent as follows: +

+

+ +

+

+ Asynchronous agents alternately wait for an asynchronous operation to complete, + and then run a completion handler for that operation. Within the context + of an agent, these completion handlers represent indivisible units of schedulable + work. +

+
+
+

[1] + Such as chains of lambdas, coroutines, fibers, state machines, etc. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/async_ops.html b/Packages/asio-1.36.0/doc/asio/overview/model/async_ops.html new file mode 100644 index 0000000..97b29b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/async_ops.html @@ -0,0 +1,140 @@ + + + +Asynchronous Operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An asynchronous operation is the basic unit of composition + in the Asio asynchronous model. Asynchronous operations represent work + that is launched and performed in the background, while the user's code + that initiated the work can continue with other things. +

+

+ Conceptually, the lifecycle of an asynchronous operation can be described + in terms of the following events and phases: +

+

+ +

+

+ An initiating function is a function which may be + called by the user to start an asynchronous operation. +

+

+ A completion handler is a user-provided, move-only + function object that will be invoked, at most once, with the result of + the asynchronous operation. The invocation of the completion handler tells + the user about something that has already happened: the operation completed, + and the side effects of the operation were established. +

+

+ The initiating function and completion handler are incorporated into the + user's code as follows: +

+

+ +

+

+ Synchronous operations, being embodied as single functions, have several + inherent semantic properties as a consequence. Asynchronous operations + adopt some of these semantic properties from their synchronous counterparts, + in order to facilitate flexible and efficient composition. +

+
++++ + + + + + + + + + + + + + + +
+

+ Property of synchronous operations +

+ 		+

+ Equivalent property of asynchronous operations +

+
+

+ When a synchronous operation is generic (i.e. a template) the + return type is deterministically derived from the function and + its arguments. +

+ 		+

+ When an asynchronous operation is generic, the completion handler's + arguments' types and order are deterministically derived from + the initiating function and its arguments. +

+
+

+ If a synchronous operation requires a temporary resource (such + as memory, a file descriptor, or a thread), this resource is + released before returning from the function. +

+ 		+

+ If an asynchronous operation requires a temporary resource (such + as memory, a file descriptor, or a thread), this resource is + released before calling the completion handler. +

+
+

+ The latter is an important property of asynchronous operations, in that + it allows a completion handler to initiate further asynchronous operations + without overlapping resource usage. Consider the trivial (and relatively + common) case of the same operation being repeated over and over in a chain: +

+

+ +

+

+ By ensuring that resources are released before the completion handler runs, + we avoid doubling the peak resource usage of the chain of operations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/cancellation.html b/Packages/asio-1.36.0/doc/asio/overview/model/cancellation.html new file mode 100644 index 0000000..4fe6ee2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/cancellation.html @@ -0,0 +1,65 @@ + + + +Cancellation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In Asio, many objects, such as sockets and timers, support object-wide + cancellation of outstanding asynchronous operations via their close or + cancel member functions. However, certain asynchronous operations also + support individual, targeted cancellation. This per-operation cancellation + is enabled by specifying that every asynchronous agent has an associated + cancellation slot. +

+

+ To support cancellation, an asynchronous operation installs a cancellation + handler into the agent's slot. The cancellation handler is a function object + that will be invoked when a cancellation signal is emitted by the user + into the slot. Since a cancellation slot is associated with a single agent, + the slot holds at most one handler at a time, and installing a new handler + will overwrite any previously installed handler. Thus, the same slot is + reused for subsequent asynchronous operations within the agent. +

+

+ Cancellation is particularly useful when an asynchronous operation contains + multiple child agents. For example, one child agent may be complete and + the other is then cancelled, as its side effects are no longer required. +

+
+ + See + Also +
+

+ Per-Operation Cancellation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/child_agents.html b/Packages/asio-1.36.0/doc/asio/overview/model/child_agents.html new file mode 100644 index 0000000..af1a382 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/child_agents.html @@ -0,0 +1,109 @@ + + + +Child Agents + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The asynchronous operations within an agent may themselves be implemented + in terms of child agents.[3] As far as the parent agent is concerned, it is waiting for + the completion of a single asynchronous operation. The asynchronous operations + that constitute the child agent run in sequence, and when the final completion + handler runs the parent agent is resumed. +

+

+ +

+

+ As with individual asynchronous operations, the asynchronous operations + built on child agents must release their temporary resources prior to calling + the completion handler. We may also think of these child agents as resources + that end their lifetimes before the completion handler is invoked. +

+

+ When an asynchronous operation creates a child agent, it may propagate[4] the associated characteristics of the parent agent to the child + agent. These associated characteristics may then be recursively propagated + through further layers of asynchronous operations and child agents. This + stacking of asynchronous operations replicates another property of synchronous + operations. +

+
++++ + + + + + + + + +
+

+ Property of synchronous operations +

+ 		+

+ Equivalent property of asynchronous operations +

+
+

+ Compositions of synchronous operations may be refactored to use + child functions that run on the same thread (i.e. are simply + called) without altering functionality. +

+ 		+

+ Asynchronous agents may be refactored to use asynchronous operations + and child agents that share the associated characteristics of + the parent agent, without altering functionality. +

+
+

+ Finally, some asynchronous operations may be implemented in terms of multiple + child agents that run concurrently. In this case, the asynchronous operation + may choose to selectively propagate the associated characteristics of the + parent agent. +

+
+
+

[3] + In Asio these asynchronous operations are referred to as composed + operations. +

+

[4] + Typically, by specialising the associator trait and forwarding to the + outer completion handler. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/completion_tokens.html b/Packages/asio-1.36.0/doc/asio/overview/model/completion_tokens.html new file mode 100644 index 0000000..ffefedc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/completion_tokens.html @@ -0,0 +1,326 @@ + + + +Completion Tokens + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A key goal of Asio's asynchronous model is to support multiple composition + mechanisms. This is achieved via a completion token, + which the user passes to an asynchronous operation's initiating function + to customise the API surface of the library. By convention, the completion + token is the final argument to an asynchronous operation's initiating function. +

+

+ For example, if the user passes a lambda (or other function object) as + the completion token, the asynchronous operation behaves as previously + described: the operation begins, and when the operation completes the result + is passed to the lambda. +

+
socket.async_read_some(buffer,
+    [](error_code e, size_t)
+    {
+      // ...
+    }
+  );
+
+

+ When the user passes the use_future + completion token, the operation behaves as though implemented in terms + of a promise and future pair. The initiating function + does not just launch the operation, but also returns a future that may + be used to await the result. +

+
future<size_t> f =
+  socket.async_read_some(
+      buffer, use_future
+    );
+// ...
+size_t n = f.get();
+
+

+ Similarly, when the user passes the use_awaitable + completion token, the initiating function behaves as though it is an awaitable-based coroutine [6]. However, in this case the initiating function does not launch + the asynchronous operation directly. It only returns the awaitable, which in turn launches the + operation when it is co_await-ed. +

+
awaitable<void> foo()
+{
+  size_t n =
+    co_await socket.async_read_some(
+        buffer, use_awaitable
+      );
+
+  // ...
+}
+
+

+ Finally, the yield_context + completion token causes the initiating function to behave as a synchronous + operation within the context of a stackful coroutine. It not only begins + the asynchronous operation, but blocks the stackful coroutine until it + is complete. From the point of the stackful coroutine, it is a synchronous + operation. +

+
void foo(asio::yield_context yield)
+{
+  size_t n = socket.async_read_some(buffer, yield);
+
+  // ...
+}
+
+

+ All of these uses are supported by a single implementation of the async_read_some initiating function. +

+

+ To achieve this, an asynchronous operation must first specify a completion + signature (or, possibly, signatures) that describes the arguments + that will be passed to its completion handler. +

+

+ Then, the operation's initiating function takes the completion signature, + completion token, and its internal implementation and passes them to the + async_result trait. The async_result + trait is a customisation point that combines these to first produce a concrete + completion handler, and then launch the operation. +

+

+ +

+

+ To see this in practice, let's use a detached thread to adapt a synchronous + operation into an asynchronous one:[7] +

+
template <
+    completion_token_for<void(error_code, size_t)> 1
+      CompletionToken>
+auto async_read_some(
+    tcp::socket& s,
+    const mutable_buffer& b,
+    CompletionToken&& token)
+{
+  auto init = []( 2
+      auto completion_handler,
+      tcp::socket* s,
+      const mutable_buffer& b)
+  {
+    std::thread( 3
+        [](
+            auto completion_handler,
+            tcp::socket* s,
+            const mutable_buffer& b
+          )
+        {
+          error_code ec;
+          size_t n = s->read_some(b, ec);
+          std::move(completion_handler)(ec, n); 4
+        },
+        std::move(completion_handler),
+        s,
+        b
+      ).detach();
+  };
+
+  return async_result< 5
+      decay_t<CompletionToken>,
+      void(error_code, size_t)
+    >::initiate(
+        init, 6
+        std::forward<CompletionToken>(token), 7
+        &s, 8
+        b
+      );
+}
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

1

+ The completion_token_for + concept checks whether the user-supplied completion token will satisfy + the specified completion signature. For older versions of C++, simply + use typename here instead. +

2

+ Define a function object that contains the code to launch the asynchronous + operation. This is passed the concrete completion handler, followed + by any additional arguments that were passed through the async_result trait. +

3

+ The body of the function object spawns a new thread to perform the + operation. +

4

+ Once the operation completes, the completion handler is passed the + result. +

5

+ The async_result trait + is passed the (decayed) completion token type, and the completion signatures + of the asynchronous operation. +

6

+ Call the trait’s initiate + member function, first passing the function object that launches the + operation. +

7

+ Next comes the forwarded completion token. The trait implementation + will convert this into a concrete completion handler. +

8

+ Finally, pass any additional arguments for the function object. Assume + that these may be decay-copied and moved by the trait implementation. +

+

+ In practice we should call the async_initiate + helper function, rather than use the async_result + trait directly. The async_initiate + function automatically performs the necessary decay and forward of the + completion token, and also enables backwards compatibility with legacy + completion token implementations. +

+
template <
+    completion_token_for<void(error_code, size_t)>
+      CompletionToken>
+auto async_read_some(
+    tcp::socket& s,
+    const mutable_buffer& b,
+    CompletionToken&& token)
+{
+  auto init = /* ... as above ... */;
+
+  return async_initiate<
+      CompletionToken,
+      void(error_code, size_t)
+    >(init, token, &s, b);
+}
+
+

+ We can think of the completion token as a kind of proto completion handler. + In the case where we pass a function object (like a lambda) as the completion + token, it already satisfies the completion handler requirements. The async_result + primary template handles this case by trivially forwarding the arguments + through: +

+
template <class CompletionToken, completion_signature... Signatures>
+struct async_result
+{
+  template <
+      class Initiation,
+      completion_handler_for<Signatures...> CompletionHandler,
+      class... Args>
+  static void initiate(
+      Initiation&& initiation,
+      CompletionHandler&& completion_handler,
+      Args&&... args)
+  {
+    std::forward<Initiation>(initiation)(
+        std::forward<CompletionHandler>(completion_handler),
+        std::forward<Args>(args)...);
+  }
+};
+
+

+ We can see here that this default implementation avoids copies of all arguments, + thus ensuring that eager initiation is as efficient as possible. +

+

+ On the other hand, a lazy completion token (such as use_awaitable + above) may capture these arguments for deferred launching of the operation. + For example, a specialisation for a trivial deferred + token (that simply packages the operation for later) might look something + like this: +

+
template <completion_signature... Signatures>
+struct async_result<deferred_t, Signatures...>
+{
+  template <class Initiation, class... Args>
+  static auto initiate(Initiation initiation, deferred_t, Args... args)
+  {
+    return [
+        initiation = std::move(initiation),
+        arg_pack = std::make_tuple(std::move(args)...)
+      ](auto&& token) mutable
+    {
+      return std::apply(
+          [&](auto&&... args)
+          {
+            return async_result<decay_t<decltype(token)>, Signatures...>::initiate(
+                std::move(initiation),
+                std::forward<decltype(token)>(token),
+                std::forward<decltype(args)>(args)...
+              );
+          },
+          std::move(arg_pack)
+        );
+    };
+  }
+};
+
+
+
+

[6] + The awaitable class template + is included with the Asio library as a return type for C++20 coroutines. + These coroutines can be trivially implemented in terms of other awaitable-based coroutines. +

+

[7] + For illustrative purposes only. Not recommended for real world use! +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/executors.html b/Packages/asio-1.36.0/doc/asio/overview/model/executors.html new file mode 100644 index 0000000..dda31af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/executors.html @@ -0,0 +1,105 @@ + + + +Executors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Every asynchronous agent has an associated executor. + An agent's executor determines how the agent's completion handlers are + queued and ultimately run. +

+

+ Example uses of executors include: +

+
    +
  • + Coordinating a group of asynchronous agents that operate on shared + data structures, ensuring that the agents' completion handlers never + run concurrently[5]. +
    • +
  • + Ensuring that agents are run on specified execution resource (e.g. + a CPU) that is proximal to data or an event source (e.g. a NIC). +
    • +
  • + Denoting a group of related agents, and so enabling dynamic thread + pools to make smarter scheduling decisions (such as moving the agents + between execution resources as a unit). +
    • +
  • + Queuing all completion handlers to run on a GUI application thread, + so that they may safely update user interface elements. +
    • +
  • + Returning an asynchronous operation's default executor as-is, to run + completion handlers as close as possible to the event that triggered + the operation's completion. +
    • +
  • + Adapting an asynchronous operation's default executor, to run code + before and after every completion handler, such as logging, user authorisation, + or exception handling. +
    • +
  • + Specifying a priority for an asynchronous agent and its completion + handlers. +
    • +
+

+ The asynchronous operations within an asynchronous agent use the agent's + associated executor to: +

+
    +
  • + Track the existence of the work that the asynchronous operation represents, + while the operation is outstanding. +
    • +
  • + Enqueue the completion handler for execution on completion of an operation. +
    • +
  • + Ensure that completion handlers do not run re-entrantly, if doing so + might lead to inadvertent recursion and stack overflow. +
    • +
+

+ Thus, an asynchronous agent's associated executor represents a policy of + how, where, and when the agent should run, specified as a cross-cutting + concern to the code that makes up the agent. +

+
+
+

[5] + In Asio, this kind of executor is called a strand. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/higher_levels.html b/Packages/asio-1.36.0/doc/asio/overview/model/higher_levels.html new file mode 100644 index 0000000..006d50b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/higher_levels.html @@ -0,0 +1,72 @@ + + + +Higher Level Abstractions + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The asynchronous model presented in this section provides a basis for defining + higher level abstractions. Asio builds on this core model to provide additional + facilities, such as: +

+
+

+ To allow users to more easily write their own asynchronous operations that + adhere to this model, Asio also provides the helper function async_compose. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/model/library_elements.html b/Packages/asio-1.36.0/doc/asio/overview/model/library_elements.html new file mode 100644 index 0000000..fb23c8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/model/library_elements.html @@ -0,0 +1,186 @@ + + + +Supporting Library Elements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The Asio asynchronous model is enabled by the library elements listed in + the table below. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Library Element +

+ 		+

+ Description +

+
+

+ completion_signature + concept +

+ 		+

+ Defines valid completion signature forms. +

+
+

+ completion_handler_for + concept +

+ 		+

+ Determines whether a completion handler is callable with a given + set of completion signatures. +

+
+

+ async_result + trait +

+ 		+

+ Converts a completion signature and completion token into a concrete + completion handler, and launches the operation. +

+
+

+ async_initiate + function +

+ 		+

+ Helper function to simplify use of the async_result + trait. +

+
+

+ completion_token_for + concept +

+ 		+

+ Determines whether a completion token produces a completion handler + for a given set of completion signatures. +

+
+

+ associator trait +

+ 		+

+ Automatically propagates all associators through layers of abstraction. +

+
+

+ associated_executor + trait, associated_executor_t + type alias, and get_associated_executor + function +

+ 		+

+ Defines an asynchronous agent’s associated executor. +

+
+

+ associated_allocator + trait, associated_allocator_t + type alias, and get_associated_allocator + function +

+ 		+

+ Defines an asynchronous agent’s associated allocator. +

+
+

+ associated_cancellation_slot + trait, associated_cancellation_slot_t + type alias, and get_associated_cancellation_slot + function +

+ 		+

+ Defines an asynchronous agent’s associated cancellation slot. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/networking.html b/Packages/asio-1.36.0/doc/asio/overview/networking.html new file mode 100644 index 0000000..6ae6617 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/networking.html @@ -0,0 +1,51 @@ + + + +Networking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/networking/bsd_sockets.html b/Packages/asio-1.36.0/doc/asio/overview/networking/bsd_sockets.html new file mode 100644 index 0000000..62f5dc4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/networking/bsd_sockets.html @@ -0,0 +1,555 @@ + + + +The BSD Socket API and Asio + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The Asio library includes a low-level socket interface based on the BSD + socket API, which is widely implemented and supported by extensive literature. + It is also used as the basis for networking APIs in other languages, like + Java. This low-level interface is designed to support the development of + efficient and scalable applications. For example, it permits programmers + to exert finer control over the number of system calls, avoid redundant + data copying, minimise the use of resources like threads, and so on. +

+

+ Unsafe and error prone aspects of the BSD socket API are not included. + For example, the use of int + to represent all sockets lacks type safety. The socket representation in + Asio uses a distinct type for each protocol, e.g. for TCP one would use + ip::tcp::socket, and for UDP one uses ip::udp::socket. +

+

+ The following table shows the mapping between the BSD socket API and Asio: +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ BSD Socket API Elements +

+ 		+

+ Equivalents in Asio +

+
+

+ socket descriptor - int + (POSIX) or SOCKET + (Windows) +

+ 		+

+ For TCP: ip::tcp::socket, + ip::tcp::acceptor +

+

+ For UDP: ip::udp::socket +

+

+ basic_socket, + basic_stream_socket, + basic_datagram_socket, + basic_raw_socket +

+
+

+ in_addr, in6_addr +

+ 		+

+ ip::address, + ip::address_v4, + ip::address_v6 +

+
+

+ sockaddr_in, + sockaddr_in6 +

+ 		+

+ For TCP: ip::tcp::endpoint +

+

+ For UDP: ip::udp::endpoint +

+

+ ip::basic_endpoint +

+
+

+ accept() +

+ 		+

+ For TCP: ip::tcp::acceptor::accept() +

+

+ basic_socket_acceptor::accept() +

+
+

+ bind() +

+ 		+

+ For TCP: ip::tcp::acceptor::bind(), + ip::tcp::socket::bind() +

+

+ For UDP: ip::udp::socket::bind() +

+

+ basic_socket::bind() +

+
+

+ close() +

+ 		+

+ For TCP: ip::tcp::acceptor::close(), + ip::tcp::socket::close() +

+

+ For UDP: ip::udp::socket::close() +

+

+ basic_socket::close() +

+
+

+ connect() +

+ 		+

+ For TCP: ip::tcp::socket::connect() +

+

+ For UDP: ip::udp::socket::connect() +

+

+ basic_socket::connect() +

+
+

+ getaddrinfo(), + gethostbyaddr(), gethostbyname(), getnameinfo(), getservbyname(), getservbyport() +

+ 		+

+ For TCP: ip::tcp::resolver::resolve(), + ip::tcp::resolver::async_resolve() +

+

+ For UDP: ip::udp::resolver::resolve(), + ip::udp::resolver::async_resolve() +

+

+ ip::basic_resolver::resolve(), + ip::basic_resolver::async_resolve() +

+
+

+ gethostname() +

+ 		+

+ ip::host_name() +

+
+

+ getpeername() +

+ 		+

+ For TCP: ip::tcp::socket::remote_endpoint() +

+

+ For UDP: ip::udp::socket::remote_endpoint() +

+

+ basic_socket::remote_endpoint() +

+
+

+ getsockname() +

+ 		+

+ For TCP: ip::tcp::acceptor::local_endpoint(), + ip::tcp::socket::local_endpoint() +

+

+ For UDP: ip::udp::socket::local_endpoint() +

+

+ basic_socket::local_endpoint() +

+
+

+ getsockopt() +

+ 		+

+ For TCP: ip::tcp::acceptor::get_option(), + ip::tcp::socket::get_option() +

+

+ For UDP: ip::udp::socket::get_option() +

+

+ basic_socket::get_option() +

+
+

+ inet_addr(), + inet_aton(), + inet_pton() +

+ 		+

+ ip::make_address(), + ip::make_address_v4(), + ip::make_address_v6() +

+
+

+ inet_ntoa(), + inet_ntop() +

+ 		+

+ ip::address::to_string(), + ip::address_v4::to_string(), + ip::address_v6::to_string() +

+
+

+ ioctl() +

+ 		+

+ For TCP: ip::tcp::socket::io_control() +

+

+ For UDP: ip::udp::socket::io_control() +

+

+ basic_socket::io_control() +

+
+

+ listen() +

+ 		+

+ For TCP: ip::tcp::acceptor::listen() +

+

+ basic_socket_acceptor::listen() +

+
+

+ poll(), + select(), + pselect() +

+ 		+

+ io_context::run(), + io_context::run_one(), + io_context::poll(), + io_context::poll_one() +

+

+ Note: in conjunction with asynchronous operations. +

+
+

+ readv(), + recv(), + read() +

+ 		+

+ For TCP: ip::tcp::socket::read_some(), + ip::tcp::socket::async_read_some(), + ip::tcp::socket::receive(), + ip::tcp::socket::async_receive() +

+

+ For UDP: ip::udp::socket::receive(), + ip::udp::socket::async_receive() +

+

+ basic_stream_socket::read_some(), + basic_stream_socket::async_read_some(), + basic_stream_socket::receive(), + basic_stream_socket::async_receive(), + basic_datagram_socket::receive(), + basic_datagram_socket::async_receive() +

+
+

+ recvfrom() +

+ 		+

+ For UDP: ip::udp::socket::receive_from(), + ip::udp::socket::async_receive_from() +

+

+ basic_datagram_socket::receive_from(), + basic_datagram_socket::async_receive_from() +

+
+

+ send(), + write(), + writev() +

+ 		+

+ For TCP: ip::tcp::socket::write_some(), + ip::tcp::socket::async_write_some(), + ip::tcp::socket::send(), + ip::tcp::socket::async_send() +

+

+ For UDP: ip::udp::socket::send(), + ip::udp::socket::async_send() +

+

+ basic_stream_socket::write_some(), + basic_stream_socket::async_write_some(), + basic_stream_socket::send(), + basic_stream_socket::async_send(), + basic_datagram_socket::send(), + basic_datagram_socket::async_send() +

+
+

+ sendto() +

+ 		+

+ For UDP: ip::udp::socket::send_to(), + ip::udp::socket::async_send_to() +

+

+ basic_datagram_socket::send_to(), + basic_datagram_socket::async_send_to() +

+
+

+ setsockopt() +

+ 		+

+ For TCP: ip::tcp::acceptor::set_option(), + ip::tcp::socket::set_option() +

+

+ For UDP: ip::udp::socket::set_option() +

+

+ basic_socket::set_option() +

+
+

+ shutdown() +

+ 		+

+ For TCP: ip::tcp::socket::shutdown() +

+

+ For UDP: ip::udp::socket::shutdown() +

+

+ basic_socket::shutdown() +

+
+

+ sockatmark() +

+ 		+

+ For TCP: ip::tcp::socket::at_mark() +

+

+ basic_socket::at_mark() +

+
+

+ socket() +

+ 		+

+ For TCP: ip::tcp::acceptor::open(), + ip::tcp::socket::open() +

+

+ For UDP: ip::udp::socket::open() +

+

+ basic_socket::open() +

+
+

+ socketpair() +

+ 		+

+ local::connect_pair() +

+

+ Note: POSIX operating systems only. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/networking/iostreams.html b/Packages/asio-1.36.0/doc/asio/overview/networking/iostreams.html new file mode 100644 index 0000000..26e1637 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/networking/iostreams.html @@ -0,0 +1,111 @@ + + + +Socket Iostreams + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio includes classes that implement iostreams on top of sockets. These + hide away the complexities associated with endpoint resolution, protocol + independence, etc. To create a connection one might simply write: +

+
ip::tcp::iostream stream("www.boost.org", "http");
+if (!stream)
+{
+  // Can't connect.
+}
+
+

+ The iostream class can also be used in conjunction with an acceptor to + create simple servers. For example: +

+
io_context ioc;
+
+ip::tcp::endpoint endpoint(tcp::v4(), 80);
+ip::tcp::acceptor acceptor(ios, endpoint);
+
+for (;;)
+{
+  ip::tcp::iostream stream;
+  acceptor.accept(stream.socket());
+  ...
+}
+
+

+ Timeouts may be set by calling expires_at() or expires_from_now() to establish a deadline. Any socket operations + that occur past the deadline will put the iostream into a "bad" + state. +

+

+ For example, a simple client program like this: +

+
ip::tcp::iostream stream;
+stream.expires_from_now(boost::posix_time::seconds(60));
+stream.connect("www.boost.org", "http");
+stream << "GET /LICENSE_1_0.txt HTTP/1.0\r\n";
+stream << "Host: www.boost.org\r\n";
+stream << "Accept: */*\r\n";
+stream << "Connection: close\r\n\r\n";
+stream.flush();
+std::cout << stream.rdbuf();
+
+

+ will fail if all the socket operations combined take longer than 60 seconds. +

+

+ If an error does occur, the iostream's error() member function may be used to retrieve + the error code from the most recent system call: +

+
if (!stream)
+{
+  std::cout << "Error: " << stream.error().message() << "\n";
+}
+
+
+ + See + Also +
+

+ ip::tcp::iostream, + basic_socket_iostream, + iostreams examples. +

+
+ + Notes +
+

+ These iostream templates only support char, + not wchar_t, and do not perform + any code conversion. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/networking/other_protocols.html b/Packages/asio-1.36.0/doc/asio/overview/networking/other_protocols.html new file mode 100644 index 0000000..325b1e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/networking/other_protocols.html @@ -0,0 +1,148 @@ + + + +Support for Other Protocols + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Support for other socket protocols (such as Bluetooth or IRCOMM sockets) + can be added by implementing the protocol + type requirements. However, in many cases these protocols may also + be used with Asio's generic protocol support. For this, Asio provides the + following four classes: +

+
+

+ These classes implement the protocol + type requirements, but allow the user to specify the address family + (e.g. AF_INET) and protocol + type (e.g. IPPROTO_TCP) + at runtime. For example: +

+
asio::generic::stream_protocol::socket my_socket(my_io_context);
+my_socket.open(asio::generic::stream_protocol(AF_INET, IPPROTO_TCP));
+...
+
+

+ An endpoint class template, asio::generic::basic_endpoint, is included to + support these protocol classes. This endpoint can hold any other endpoint + type, provided its native representation fits into a sockaddr_storage + object. This class will also convert from other types that implement the + endpoint type requirements: +

+
asio::ip::tcp::endpoint my_endpoint1 = ...;
+asio::generic::stream_protocol::endpoint my_endpoint2(my_endpoint1);
+
+

+ The conversion is implicit, so as to support the following use cases: +

+
asio::generic::stream_protocol::socket my_socket(my_io_context);
+asio::ip::tcp::endpoint my_endpoint = ...;
+my_socket.connect(my_endpoint);
+
+
+ + C++11 + Move Construction +
+

+ When using C++11, it is possible to perform move construction from a socket + (or acceptor) object to convert to the more generic protocol's socket (or + acceptor) type. If the protocol conversion is valid: +

+
Protocol1 p1 = ...;
+Protocol2 p2(p1);
+
+

+ then the corresponding socket conversion is allowed: +

+
Protocol1::socket my_socket1(my_io_context);
+...
+Protocol2::socket my_socket2(std::move(my_socket1));
+
+

+ For example, one possible conversion is from a TCP socket to a generic + stream-oriented socket: +

+
asio::ip::tcp::socket my_socket1(my_io_context);
+...
+asio::generic::stream_protocol::socket my_socket2(std::move(my_socket1));
+
+

+ These conversions are also available for move-assignment. +

+

+ These conversions are not limited to the above generic protocol classes. + User-defined protocols may take advantage of this feature by similarly + ensuring the conversion from Protocol1 + to Protocol2 is valid, + as above. +

+
+ + Accepting + Generic Sockets +
+

+ As a convenience, a socket acceptor's accept() and async_accept() functions can directly accept into a + different protocol's socket type, provided the corresponding protocol conversion + is valid. For example, the following is supported because the protocol + asio::ip::tcp is convertible to asio::generic::stream_protocol: +

+
asio::ip::tcp::acceptor my_acceptor(my_io_context);
+...
+asio::generic::stream_protocol::socket my_socket(my_io_context);
+my_acceptor.accept(my_socket);
+
+
+ + See + Also +
+

+ generic::datagram_protocol, generic::raw_protocol, generic::seq_packet_protocol, generic::stream_protocol, protocol + type requirements. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/networking/protocols.html b/Packages/asio-1.36.0/doc/asio/overview/networking/protocols.html new file mode 100644 index 0000000..3d990e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/networking/protocols.html @@ -0,0 +1,202 @@ + + + +TCP, UDP and ICMP + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio provides off-the-shelf support for the internet protocols TCP, UDP + and ICMP. +

+
+ + TCP + Clients +
+

+ Hostname resolution is performed using a resolver, where host and service + names are looked up and converted into one or more endpoints: +

+
ip::tcp::resolver resolver(my_io_context);
+ip::tcp::resolver::query query("www.boost.org", "http");
+ip::tcp::resolver::iterator iter = resolver.resolve(query);
+ip::tcp::resolver::iterator end; // End marker.
+while (iter != end)
+{
+  ip::tcp::endpoint endpoint = *iter++;
+  std::cout << endpoint << std::endl;
+}
+
+

+ The list of endpoints obtained above could contain both IPv4 and IPv6 endpoints, + so a program should try each of them until it finds one that works. This + keeps the client program independent of a specific IP version. +

+

+ To simplify the development of protocol-independent programs, TCP clients + may establish connections using the free functions connect() + and async_connect(). + These operations try each endpoint in a list until the socket is successfully + connected. For example, a single call: +

+
ip::tcp::socket socket(my_io_context);
+asio::connect(socket, resolver.resolve(query));
+
+

+ will synchronously try all endpoints until one is successfully connected. + Similarly, an asynchronous connect may be performed by writing: +

+
asio::async_connect(socket_, iter,
+    boost::bind(&client::handle_connect, this,
+      asio::placeholders::error));
+
+// ...
+
+void handle_connect(const error_code& error)
+{
+  if (!error)
+  {
+    // Start read or write operations.
+  }
+  else
+  {
+    // Handle error.
+  }
+}
+
+

+ When a specific endpoint is available, a socket can be created and connected: +

+
ip::tcp::socket socket(my_io_context);
+socket.connect(endpoint);
+
+

+ Data may be read from or written to a connected TCP socket using the receive(), + async_receive(), + send() or + async_send() + member functions. However, as these could result in short + writes or reads, an application will typically use the following + operations instead: read(), + async_read(), write() + and async_write(). +

+
+ + TCP + Servers +
+

+ A program uses an acceptor to accept incoming TCP connections: +

+
ip::tcp::acceptor acceptor(my_io_context, my_endpoint);
+...
+ip::tcp::socket socket(my_io_context);
+acceptor.accept(socket);
+
+

+ After a socket has been successfully accepted, it may be read from or written + to as illustrated for TCP clients above. +

+
+ + UDP +
+

+ UDP hostname resolution is also performed using a resolver: +

+
ip::udp::resolver resolver(my_io_context);
+ip::udp::resolver::query query("localhost", "daytime");
+ip::udp::resolver::iterator iter = resolver.resolve(query);
+...
+
+

+ A UDP socket is typically bound to a local endpoint. The following code + will create an IP version 4 UDP socket and bind it to the "any" + address on port 12345: +

+
ip::udp::endpoint endpoint(ip::udp::v4(), 12345);
+ip::udp::socket socket(my_io_context, endpoint);
+
+

+ Data may be read from or written to an unconnected UDP socket using the + receive_from(), + async_receive_from(), + send_to() + or async_send_to() + member functions. For a connected UDP socket, use the receive(), + async_receive(), + send() + or async_send() + member functions. +

+
+ + ICMP +
+

+ As with TCP and UDP, ICMP hostname resolution is performed using a resolver: +

+
ip::icmp::resolver resolver(my_io_context);
+ip::icmp::resolver::query query("localhost", "");
+ip::icmp::resolver::iterator iter = resolver.resolve(query);
+...
+
+

+ An ICMP socket may be bound to a local endpoint. The following code will + create an IP version 6 ICMP socket and bind it to the "any" address: +

+
ip::icmp::endpoint endpoint(ip::icmp::v6(), 0);
+ip::icmp::socket socket(my_io_context, endpoint);
+
+

+ The port number is not used for ICMP. +

+

+ Data may be read from or written to an unconnected ICMP socket using the + receive_from(), + async_receive_from(), + send_to() + or async_send_to() + member functions. +

+
+ + See + Also +
+

+ ip::tcp, ip::udp, + ip::icmp, daytime + protocol tutorials, ICMP + ping example. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/pipes.html b/Packages/asio-1.36.0/doc/asio/overview/pipes.html new file mode 100644 index 0000000..32487af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/pipes.html @@ -0,0 +1,67 @@ + + + +Pipes + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+Pipes +

+

+ Asio provides support for portable anonymous pipes on POSIX and Windows (when + I/O completion ports are available). For example, to create and use a connected + pair of pipe objects: +

+
asio::readable_pipe read_end(my_io_context);
+asio::writable_pipe write_end(my_io_context);
+asio::connect_pipe(read_end, write_end);
+
+write_end.async_write_some(my_write_buffer,
+    [](asio::error_code e, size_t n)
+    {
+      // ...
+    });
+
+read_end.async_read_some(my_read_buffer,
+    [](asio::error_code e, size_t n)
+    {
+      // ...
+    });
+
+
+ + See + Also +
+

+ basic_readable_pipe, + basic_writable_pipe, + connect_pipe, readable_pipe, + writable_pipe. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/posix.html b/Packages/asio-1.36.0/doc/asio/overview/posix.html new file mode 100644 index 0000000..d7c770a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/posix.html @@ -0,0 +1,45 @@ + + + +POSIX-Specific Functionality + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ UNIX Domain Sockets +

+

+ Stream-Oriented File + Descriptors +

+

+ Fork +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/posix/fork.html b/Packages/asio-1.36.0/doc/asio/overview/posix/fork.html new file mode 100644 index 0000000..c9ee821 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/posix/fork.html @@ -0,0 +1,75 @@ + + + +Fork + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+Fork +

+

+ Asio supports programs that utilise the fork() system call. Provided the program calls + io_context.notify_fork() + at the appropriate times, Asio will recreate any internal file descriptors + (such as the "self-pipe trick" descriptor used for waking up + a reactor). The notification is usually performed as follows: +

+
io_context_.notify_fork(asio::io_context::fork_prepare);
+if (fork() == 0)
+{
+  io_context_.notify_fork(asio::io_context::fork_child);
+  ...
+}
+else
+{
+  io_context_.notify_fork(asio::io_context::fork_parent);
+  ...
+}
+
+

+ User-defined services can also be made fork-aware by overriding the io_context::service::notify_fork() + virtual function. +

+

+ Note that any file descriptors accessible via Asio's public API (e.g. the + descriptors underlying basic_socket<>, posix::stream_descriptor, + etc.) are not altered during a fork. It is the program's responsibility + to manage these as required. +

+
+ + See + Also +
+

+ io_context::notify_fork(), + io_context::fork_event, + io_context::service::notify_fork(), + Fork examples. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/posix/local.html b/Packages/asio-1.36.0/doc/asio/overview/posix/local.html new file mode 100644 index 0000000..f4df228 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/posix/local.html @@ -0,0 +1,102 @@ + + + +UNIX Domain Sockets + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio provides basic support for UNIX domain sockets (also known as local + sockets). The simplest use involves creating a pair of connected sockets. + The following code: +

+
local::stream_protocol::socket socket1(my_io_context);
+local::stream_protocol::socket socket2(my_io_context);
+local::connect_pair(socket1, socket2);
+
+

+ will create a pair of stream-oriented sockets. To do the same for datagram-oriented + sockets, use: +

+
local::datagram_protocol::socket socket1(my_io_context);
+local::datagram_protocol::socket socket2(my_io_context);
+local::connect_pair(socket1, socket2);
+
+

+ A UNIX domain socket server may be created by binding an acceptor to an + endpoint, in much the same way as one does for a TCP server: +

+
::unlink("/tmp/foobar"); // Remove previous binding.
+local::stream_protocol::endpoint ep("/tmp/foobar");
+local::stream_protocol::acceptor acceptor(my_io_context, ep);
+local::stream_protocol::socket socket(my_io_context);
+acceptor.accept(socket);
+
+

+ A client that connects to this server might look like: +

+
local::stream_protocol::endpoint ep("/tmp/foobar");
+local::stream_protocol::socket socket(my_io_context);
+socket.connect(ep);
+
+

+ Transmission of file descriptors or credentials across UNIX domain sockets + is not directly supported within Asio, but may be achieved by accessing + the socket's underlying descriptor using the native_handle() + member function. +

+
+ + See + Also +
+

+ local::connect_pair, + local::datagram_protocol, + local::datagram_protocol::endpoint, + local::datagram_protocol::socket, + local::stream_protocol, + local::stream_protocol::acceptor, + local::stream_protocol::endpoint, + local::stream_protocol::iostream, + local::stream_protocol::socket, + UNIX domain + sockets examples. +

+
+ + Notes +
+

+ UNIX domain sockets are only available at compile time if supported by + the target operating system. A program may test for the macro ASIO_HAS_LOCAL_SOCKETS to determine whether + they are supported. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/posix/stream_descriptor.html b/Packages/asio-1.36.0/doc/asio/overview/posix/stream_descriptor.html new file mode 100644 index 0000000..8fb23bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/posix/stream_descriptor.html @@ -0,0 +1,83 @@ + + + +Stream-Oriented File Descriptors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio includes classes added to permit synchronous and asynchronous read + and write operations to be performed on POSIX file descriptors, such as + pipes, standard input and output, and various devices. +

+

+ These classes also provide limited support for regular files. This support + assumes that the underlying read and write operations provided by the operating + system never fail with EAGAIN + or EWOULDBLOCK. (This assumption + normally holds for buffered file I/O.) Synchronous and asynchronous read + and write operations on file descriptors will succeed but the I/O will + always be performed immediately. Wait operations, and operations involving + asio::null_buffers, are not portably supported. +

+

+ For example, to perform read and write operations on standard input and + output, the following objects may be created: +

+
posix::stream_descriptor in(my_io_context, ::dup(STDIN_FILENO));
+posix::stream_descriptor out(my_io_context, ::dup(STDOUT_FILENO));
+
+

+ These are then used as synchronous or asynchronous read and write streams. + This means the objects can be used with any of the read(), + async_read(), write(), + async_write(), read_until() or async_read_until() + free functions. +

+
+ + See + Also +
+

+ posix::stream_descriptor, + Chat example (C++11). +

+
+ + Notes +
+

+ POSIX stream descriptors are only available at compile time if supported + by the target operating system. A program may test for the macro ASIO_HAS_POSIX_STREAM_DESCRIPTOR to determine + whether they are supported. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/rationale.html b/Packages/asio-1.36.0/doc/asio/overview/rationale.html new file mode 100644 index 0000000..4f5f390 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/rationale.html @@ -0,0 +1,95 @@ + + + +Rationale + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Most programs interact with the outside world in some way, whether it be + via a file, a network, a serial cable, or the console. Sometimes, as is the + case with networking, individual I/O operations can take a long time to complete. + This poses particular challenges to application development. +

+

+ Asio provides the tools to manage these long running operations, without + requiring programs to use concurrency models based on threads and explicit + locking. +

+

+ The Asio library is intended for programmers using C++ for systems programming, + where access to operating system functionality such as networking is often + required. In particular, Asio addresses the following goals: +

+
    +
  • + Portability. The library should support + a range of commonly used operating systems, and provide consistent behaviour + across these operating systems. +
    • +
  • + Scalability. The library should facilitate + the development of network applications that scale to thousands of concurrent + connections. The library implementation for each operating system should + use the mechanism that best enables this scalability. +
    • +
  • + Efficiency. The library should support + techniques such as scatter-gather I/O, and allow programs to minimise + data copying. +
    • +
  • + Model concepts from established APIs, such as BSD + sockets. The BSD socket API is widely implemented and understood, + and is covered in much literature. Other programming languages often + use a similar interface for networking APIs. As far as is reasonable, + Asio should leverage existing practice. +
    • +
  • + Ease of use. The library should provide + a lower entry barrier for new users by taking a toolkit, rather than + framework, approach. That is, it should try to minimise the up-front + investment in time to just learning a few basic rules and guidelines. + After that, a library user should only need to understand the specific + functions that are being used. +
    • +
  • + Basis for further abstraction. The library + should permit the development of other libraries that provide higher + levels of abstraction. For example, implementations of commonly used + protocols such as HTTP. +
    • +
+

+ Although Asio started life focused primarily on networking, its concepts + of asynchronous I/O have been extended to include other operating system + resources such as serial ports, file descriptors, and so on. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/serial_ports.html b/Packages/asio-1.36.0/doc/asio/overview/serial_ports.html new file mode 100644 index 0000000..a49a203 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/serial_ports.html @@ -0,0 +1,82 @@ + + + +Serial Ports + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio includes classes for creating and manipulating serial ports in a portable + manner. For example, a serial port may be opened using: +

+
serial_port port(my_io_context, name);
+
+

+ where name is something like "COM1" + on Windows, and "/dev/ttyS0" + on POSIX platforms. +

+

+ Once opened, the serial port may be used as a stream. + This means the objects can be used with any of the read(), + async_read(), write(), + async_write(), read_until() + or async_read_until() + free functions. +

+

+ The serial port implementation also includes option classes for configuring + the port's baud rate, flow control type, parity, stop bits and character + size. +

+
+ + See + Also +
+

+ serial_port, serial_port_base, + serial_port_base::baud_rate, + serial_port_base::flow_control, + serial_port_base::parity, + serial_port_base::stop_bits, + serial_port_base::character_size. +

+
+ + Notes +
+

+ Serial ports are available on all POSIX platforms. For Windows, serial ports + are only available at compile time when the I/O completion port backend is + used (which is the default). A program may test for the macro ASIO_HAS_SERIAL_PORT to determine whether + they are supported. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/signals.html b/Packages/asio-1.36.0/doc/asio/overview/signals.html new file mode 100644 index 0000000..9151cfd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/signals.html @@ -0,0 +1,73 @@ + + + +Signal Handling + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio supports signal handling using a class called signal_set. + Programs may add one or more signals to the set, and then perform an async_wait() + operation. The specified handler will be called when one of the signals occurs. + The same signal number may be registered with multiple signal_set + objects, however the signal number must be used only with Asio. +

+
void handler(
+    const asio::error_code& error,
+    int signal_number)
+{
+  if (!error)
+  {
+    // A signal occurred.
+  }
+}
+
+...
+
+// Construct a signal set registered for process termination.
+asio::signal_set signals(io_context, SIGINT, SIGTERM);
+
+// Start an asynchronous wait for one of the signals to occur.
+signals.async_wait(handler);
+
+

+ Signal handling also works on Windows, as the Microsoft Visual C++ runtime + library maps console events like Ctrl+C to the equivalent signal. +

+
+ + See + Also +
+

+ signal_set, HTTP + server example (C++11). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/ssl.html b/Packages/asio-1.36.0/doc/asio/overview/ssl.html new file mode 100644 index 0000000..1eb11d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/ssl.html @@ -0,0 +1,185 @@ + + + +SSL + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+SSL +

+

+ Asio contains classes and class templates for basic SSL support. These classes + allow encrypted communication to be layered on top of an existing stream, + such as a TCP socket. +

+

+ Before creating an encrypted stream, an application must construct an SSL + context object. This object is used to set SSL options such as verification + mode, certificate files, and so on. As an illustration, client-side initialisation + may look something like: +

+
ssl::context ctx(ssl::context::sslv23);
+ctx.set_verify_mode(ssl::verify_peer);
+ctx.load_verify_file("ca.pem");
+
+

+ To use SSL with a TCP socket, one may write: +

+
ssl::stream<ip::tcp::socket> ssl_sock(my_io_context, ctx);
+
+

+ To perform socket-specific operations, such as establishing an outbound connection + or accepting an incoming one, the underlying socket must first be obtained + using the ssl::stream template's lowest_layer() + member function: +

+
ip::tcp::socket::lowest_layer_type& sock = ssl_sock.lowest_layer();
+sock.connect(my_endpoint);
+
+

+ In some use cases the underlying stream object will need to have a longer + lifetime than the SSL stream, in which case the template parameter should + be a reference to the stream type: +

+
ip::tcp::socket sock(my_io_context);
+ssl::stream<ip::tcp::socket&> ssl_sock(sock, ctx);
+
+

+ SSL handshaking must be performed prior to transmitting or receiving data + over an encrypted connection. This is accomplished using the ssl::stream + template's handshake() + or async_handshake() + member functions. +

+

+ Once connected, SSL stream objects are used as synchronous or asynchronous + read and write streams. This means the objects can be used with any of the + read(), async_read(), + write(), async_write(), + read_until() or async_read_until() + free functions. +

+
+ + Certificate + Verification +
+

+ Asio provides various methods for configuring the way SSL certificates are + verified: +

+
+

+ To simplify use cases where certificates are verified according to the rules + in RFC 6125 (identity verification in the context of Transport Layer Security), + Asio provides a reusable verification callback as a function object: +

+
+

+ The following example shows verification of a remote host's certificate according + to the rules used by HTTPS: +

+
using asio::ip::tcp;
+namespace ssl = 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.
+asio::io_context io_context;
+ssl_socket sock(io_context, ctx);
+tcp::resolver resolver(io_context);
+tcp::resolver::query query("host.name", "https");
+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::host_name_verification("host.name"));
+sock.handshake(ssl_socket::client);
+
+// ... read and write as normal ...
+
+
+ + SSL + and Threads +
+

+ SSL stream objects perform no locking of their own. Therefore, it is essential + that all asynchronous SSL operations are performed in an implicit or explicit + strand. Note that this + means that no synchronisation is required (and so no locking overhead is + incurred) in single threaded programs. +

+
+ + See + Also +
+

+ ssl::context, ssl::host_name_verification, + ssl::stream, SSL + example (C++11). +

+
+ + Notes +
+

+ OpenSSL is required to make use + of Asio's SSL support. When an application needs to use OpenSSL functionality + that is not wrapped by Asio, the underlying OpenSSL types may be obtained + by calling ssl::context::native_handle() or ssl::stream::native_handle(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/timers.html b/Packages/asio-1.36.0/doc/asio/overview/timers.html new file mode 100644 index 0000000..d994a55 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/timers.html @@ -0,0 +1,87 @@ + + + +Timers + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+Timers +

+

+ Long running I/O operations will often have a deadline by which they must + have completed. These deadlines may be expressed as absolute times, but are + often calculated relative to the current time. +

+

+ As a simple example, to perform a synchronous wait operation on a timer using + a relative time one may write: +

+
io_context i;
+...
+steady_timer t(i);
+t.expires_after(chrono::seconds(5));
+t.wait();
+
+

+ More commonly, a program will perform an asynchronous wait operation on a + timer: +

+
void handler(asio::error_code ec) { ... }
+...
+io_context i;
+...
+steady_timer t(i);
+t.expires_after(chrono::milliseconds(400));
+t.async_wait(handler);
+...
+i.run();
+
+

+ The deadline associated with a timer may also be obtained as an absolute + time: +

+
steady_timer::time_point time_of_expiry = t.expiry();
+
+

+ which allows composition of timers: +

+
steady_timer t2(i);
+t2.expires_at(t.expiry() + chrono::seconds(30));
+
+
+ + See + Also +
+

+ basic_waitable_timer, + steady_timer, system_timer, + high_resolution_timer, + timer tutorials. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/windows.html b/Packages/asio-1.36.0/doc/asio/overview/windows.html new file mode 100644 index 0000000..feefd27 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/windows.html @@ -0,0 +1,45 @@ + + + +Windows-Specific Functionality + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Stream-Oriented HANDLEs +

+

+ Random-Access + HANDLEs +

+

+ Object HANDLEs +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/windows/object_handle.html b/Packages/asio-1.36.0/doc/asio/overview/windows/object_handle.html new file mode 100644 index 0000000..c19e39c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/windows/object_handle.html @@ -0,0 +1,95 @@ + + + +Object HANDLEs + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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_context, handle);
+
+

+ The wait() + and async_wait() + member functions may then be used to wait until the kernel object is signalled. +

+
+ + See + Also +
+

+ windows::object_handle. +

+
+ + Notes +
+

+ Windows object HANDLEs + are only available at compile time when targeting Windows. Programs may + test for the macro ASIO_HAS_WINDOWS_OBJECT_HANDLE + to determine whether they are supported. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/windows/random_access_handle.html b/Packages/asio-1.36.0/doc/asio/overview/windows/random_access_handle.html new file mode 100644 index 0000000..9b90c65 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/windows/random_access_handle.html @@ -0,0 +1,77 @@ + + + +Random-Access HANDLEs + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio provides Windows-specific classes that permit asynchronous read and + write operations to be performed on HANDLEs that refer to regular files. +

+

+ For example, to perform asynchronous operations on a file the following + object may be created: +

+
HANDLE handle = ::CreateFile(...);
+windows::random_access_handle file(my_io_context, handle);
+
+

+ Data may be read from or written to the handle using one of the read_some_at(), + async_read_some_at(), + write_some_at() + or async_write_some_at() member functions. However, like the equivalent + functions (read_some(), + etc.) on streams, these functions are only required to transfer one or + more bytes in a single operation. Therefore free functions called read_at(), async_read_at(), + write_at() and async_write_at() + have been created to repeatedly call the corresponding *_some_at() function until all data has + been transferred. +

+
+ + See Also +
+

+ windows::random_access_handle. +

+
+ + Notes +
+

+ Windows random-access HANDLEs + are only available at compile time when targeting Windows and only when + the I/O completion port backend is used (which is the default). A program + may test for the macro ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE + to determine whether they are supported. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/overview/windows/stream_handle.html b/Packages/asio-1.36.0/doc/asio/overview/windows/stream_handle.html new file mode 100644 index 0000000..6b9cc1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/overview/windows/stream_handle.html @@ -0,0 +1,79 @@ + + + +Stream-Oriented HANDLEs + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio contains classes to allow asynchronous read and write operations to + be performed on Windows HANDLEs, + such as named pipes. +

+

+ For example, to perform asynchronous operations on a named pipe, the following + object may be created: +

+
HANDLE handle = ::CreateFile(...);
+windows::stream_handle pipe(my_io_context, handle);
+
+

+ These are then used as synchronous or asynchronous read and write streams. + This means the objects can be used with any of the read(), + async_read(), write(), + async_write(), read_until() or async_read_until() + free functions. +

+

+ The kernel object referred to by the HANDLE + must support use with I/O completion ports (which means that named pipes + are supported, but anonymous pipes and console streams are not). +

+
+ + See + Also +
+

+ windows::stream_handle. +

+
+ + Notes +
+

+ Windows stream HANDLEs + are only available at compile time when targeting Windows and only when + the I/O completion port backend is used (which is the default). A program + may test for the macro ASIO_HAS_WINDOWS_STREAM_HANDLE + to determine whether they are supported. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference.html b/Packages/asio-1.36.0/doc/asio/reference.html new file mode 100644 index 0000000..00d21c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference.html @@ -0,0 +1,856 @@ + + + +Reference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ ++++++ + + + + + + + + + + +
+

+Properties

+ 		+

+Execution

+
+

+Customisation Points

+ + + + + +
prefer
query
require
require_concept
+

+Traits

+ + + + + + + + + + + + + +
can_prefer
can_query
can_require
can_require_concept
is_nothrow_prefer
is_nothrow_query
is_nothrow_require
is_nothrow_require_concept
prefer_result
query_result
require_result
require_concept_result
+ 		+

+Class Templates

+
execution::any_executor
+

+Classes

+ + + +
execution::bad_executor
execution::invocable_archetype
+

+Type Traits

+
execution::is_executor
+

+Concepts

+
executor
+ 		+

+Properties

+ + + + + + + + + + + + + + + + + + + + + + + +
execution::allocator_t
execution::blocking_t
execution::blocking_t::possibly_t
execution::blocking_t::always_t
execution::blocking_t::never_t
execution::blocking_adaptation_t
execution::blocking_adaptation_t::disallowed_t
execution::blocking_adaptation_t::allowed_t
execution::context_t
execution::context_as_t
execution::mapping_t
execution::mapping_t::thread_t
execution::mapping_t::new_thread_t
execution::mapping_t::other_t
execution::occupancy_t
execution::outstanding_work_t
execution::outstanding_work_t::untracked_t
execution::outstanding_work_t::tracked_t
execution::prefer_only
execution::relationship_t
execution::relationship_t::fork_t
execution::relationship_t::continuation_t
+ 		+

+Property Objects

+ + + + + + + + + + + + + + + + + + + + + + +
execution::allocator
execution::blocking
execution::blocking.possibly
execution::blocking.always
execution::blocking.never
execution::blocking_adaptation
execution::blocking_adaptation.disallowed
execution::blocking_adaptation.allowed
execution::context
execution::context_as
execution::mapping
execution::mapping.thread
execution::mapping.new_thread
execution::mapping.other
execution::occupancy
execution::outstanding_work
execution::outstanding_work.untracked
execution::outstanding_work.tracked
execution::relationship
execution::relationship.fork
execution::relationship.continuation
+
+ ++++++ + + + + + + + +
+

+Core

+
+

+Classes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
any_completion_executor
any_io_executor
bad_executor
cancellation_signal
cancellation_slot
cancellation_state
cancellation_type
config
config_service
config_from_concurrency_hint
config_from_env
config_from_string
config_service
coroutine
detached_t
error_code
execution_context
execution_context::id
execution_context::service
execution_context::service_maker
executor
executor_arg_t
invalid_service_owner
io_context
io_context::executor_type
io_context::service
io_context::strand
multiple_exceptions
no_error_t
partial_as_tuple
partial_redirect_error
service_already_exists
static_thread_pool
system_context
system_error
system_executor
this_coro::cancellation_state_t
this_coro::executor_t
thread
thread_pool
thread_pool::executor_type
yield_context
+ 		+

+Class Templates

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
any_completion_handler
any_completion_handler_allocator
append_t
as_tuple_t
async_completion
awaitable
basic_io_object (deprecated)
basic_system_executor
basic_yield_context
cancel_after_t
cancel_at_t
cancellation_filter
cancellation_slot_binder
consign_t
deferred_t
disposition_traits
executor_binder
executor_work_guard
experimental::as_single_t
experimental::basic_channel
experimental::basic_concurrent_channel
experimental::channel_traits
experimental::coro
experimental::parallel_group
experimental::promise
experimental::ranged_parallel_group
experimental::use_coro_t
experimental::use_promise_t
experimental::wait_for_all
experimental::wait_for_one
experimental::wait_for_one_error
experimental::wait_for_one_success
io_context::basic_executor_type
partial_allocator_binder
partial_cancel_after
partial_cancel_after_timer
partial_cancel_at
partial_cancel_at_timer
partial_cancellation_slot_binder
partial_executor_binder
partial_immediate_executor_binder
prepend_t
recycling_allocator
redirect_error_t
strand
thread_pool::basic_executor_type
use_awaitable_t
use_future_t
+ 		+

+Free Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+add_service (deprecated)
append
asio_handler_is_continuation
async_compose
async_immediate
async_initiate
bind_allocator
bind_cancellation_slot
bind_executor
bind_immediate_executor
cancel_after
cancel_at
co_composed
co_spawn
composed
consign
defer
dispatch
experimental::as_single
experimental::make_parallel_group
get_associated_allocator
get_associated_cancellation_slot
get_associated_executor
get_associated_immediate_executor
has_service
make_service
make_strand
make_work_guard
post
prepend
redirect_error
spawn
this_coro::reset_cancellation_state
this_coro::throw_if_cancelled
throw_exception
to_exception_ptr
use_service
+

+Special Values

+ + + + + + + + + + + + +
as_tuple
deferred
detached
executor_arg
experimental::use_coro
experimental::use_promise
no_error
this_coro::cancellation_state
this_coro::executor
use_awaitable
use_future
+ 		+

+Error Codes

+ + + + + +
error::basic_errors
error::netdb_errors
error::addrinfo_errors
error::misc_errors
+

+Bind Placeholders

+ + + + + + + +
placeholders::bytes_transferred
placeholders::endpoint
placeholders::error
placeholders::iterator
placeholders::results
placeholders::signal_number
+

+Type Traits

+ + + + + + + + + + + + +
associated_allocator
associated_cancellation_slot
associated_executor
associated_immediate_executor
associator
async_result
completion_signature_of
default_completion_token
is_async_operation
is_executor
uses_executor
+

+Type Requirements

+ + + + + + + + + + +
Asynchronous operations
CancellationHandler
CancellationSlot
Disposition
ExecutionContext
Executor
Handler
NullaryToken
Service
+
+ ++++++ + + + + + + + +
+

+Buffers and Buffer-Oriented Operations

+
+

+Classes

+ + + + + + + + +
const_buffer
mutable_buffer
const_registered_buffer
mutable_registered_buffer
+null_buffers (deprecated)
streambuf
registered_buffer_id
+

+Class Templates

+ + + + + + + + + +
basic_streambuf
buffer_registration
buffered_read_stream
buffered_stream
buffered_write_stream
buffers_iterator
dynamic_string_buffer
dynamic_vector_buffer
+ 		+

+Free Functions

+ + + + + + + + + + + + + + + + + + + + + + + +
async_read
async_read_at
async_read_until
async_write
async_write_at
buffer
buffer_copy
buffer_size
buffer_sequence_begin
buffer_sequence_end
buffers_begin
buffers_end
dynamic_buffer
read
read_at
read_until
register_buffers
transfer_all
transfer_at_least
transfer_exactly
write
write_at
+ 		+

+Type Traits

+ + + + + + + + + +
is_const_buffer_sequence
is_dynamic_buffer
is_dynamic_buffer_v1
is_dynamic_buffer_v2
is_match_condition
is_mutable_buffer_sequence
is_read_buffered
is_write_buffered
+ 		+

+Type Requirements

+ + + + + + + + + + + + + + + + + + + + +
Read and write operations
AsyncRandomAccessReadDevice
AsyncRandomAccessWriteDevice
AsyncReadStream
AsyncWriteStream
CompletionCondition
ConstBufferSequence
DynamicBuffer
DynamicBuffer_v1
DynamicBuffer_v2
MutableBufferSequence
ReadHandler
ReadToken
SyncRandomAccessReadDevice
SyncRandomAccessWriteDevice
SyncReadStream
SyncWriteStream
WriteHandler
WriteToken
+
+ ++++++ + + + + + + + +
+

+Networking

+
+

+Classes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
generic::datagram_protocol
generic::datagram_protocol::endpoint
generic::datagram_protocol::socket
generic::raw_protocol
generic::raw_protocol::endpoint
generic::raw_protocol::socket
generic::seq_packet_protocol
generic::seq_packet_protocol::endpoint
generic::seq_packet_protocol::socket
generic::stream_protocol
generic::stream_protocol::endpoint
generic::stream_protocol::iostream
generic::stream_protocol::socket
ip::address
ip::address_v4
ip::address_v4_iterator
ip::address_v4_range
ip::address_v6
ip::address_v6_iterator
ip::address_v6_range
ip::bad_address_cast
ip::icmp
ip::icmp::endpoint
ip::icmp::resolver
ip::icmp::socket
ip::network_v4
ip::network_v6
ip::resolver_base
ip::resolver_query_base
ip::tcp
ip::tcp::acceptor
ip::tcp::endpoint
ip::tcp::iostream
ip::tcp::resolver
ip::tcp::socket
ip::udp
ip::udp::endpoint
ip::udp::resolver
ip::udp::socket
ip::v4_mapped_t
socket_base
+ 		+

+Free Functions

+ + + + + + + + + +
async_connect
connect
ip::host_name
ip::make_address
ip::make_address_v4
ip::make_address_v6
ip::make_network_v4
ip::make_network_v6
+

+Class Templates

+ + + + + + + + + + + + + + + + +
basic_datagram_socket
basic_raw_socket
basic_seq_packet_socket
basic_socket
basic_socket_acceptor
basic_socket_iostream
basic_socket_streambuf
basic_stream_socket
generic::basic_endpoint
ip::basic_endpoint
ip::basic_resolver
ip::basic_resolver_entry
ip::basic_resolver_iterator
ip::basic_resolver_results
ip::basic_resolver_query
+ 		+

+Socket Options

+ + + + + + + + + + + + + + + + + + + + +
ip::multicast::enable_loopback
ip::multicast::hops
ip::multicast::join_group
ip::multicast::leave_group
ip::multicast::outbound_interface
ip::tcp::no_delay
ip::unicast::hops
ip::v6_only
socket_base::broadcast
socket_base::debug
socket_base::do_not_route
socket_base::enable_connection_aborted
socket_base::keep_alive
socket_base::linger
socket_base::receive_buffer_size
socket_base::receive_low_watermark
socket_base::reuse_address
socket_base::send_buffer_size
socket_base::send_low_watermark
+ 		+

+I/O Control Commands

+
socket_base::bytes_readable
+

+Type Requirements

+ + + + + + + + + + + + + + + + + + + + + + + + +
Synchronous socket operations
Asynchronous socket operations
AcceptableProtocol
AcceptHandler
AcceptToken
ConnectCondition
ConnectHandler
ConnectToken
Endpoint
EndpointSequence
GettableSocketOption
InternetProtocol
IoControlCommand
IteratorConnectHandler
IteratorConnectToken
MoveAcceptHandler
MoveAcceptToken
Protocol
RangeConnectHandler
RangeConnectToken
ResolveHandler
ResolveToken
SettableSocketOption
+
+ ++++++ + + + + + + + + + + + + +
+

+Timers

+ 		+

+SSL

+ 		+

+Serial Ports

+ 		+

+Signal Handling

+
+

+Classes

+ + + + + +
deadline_timer (deprecated)
high_resolution_timer
steady_timer
system_timer
+

+Class Templates

+ + + + + +
basic_deadline_timer (deprecated)
basic_waitable_timer
time_traits (deprecated)
wait_traits
+

+Type Requirements

+ + + + + +
TimeTraits (deprecated)
WaitHandler
WaitToken
WaitTraits
+ 		+

+Classes

+ + + + + + +
ssl::context
ssl::context_base
ssl::host_name_verification
ssl::stream_base
ssl::verify_context
+

+Class Templates

+
ssl::stream
+

+Error Codes

+
ssl::error::stream_errors
+

+Type Requirements

+ + + + + + + +
BufferedHandshakeHandler
BufferedHandshakeToken
HandshakeHandler
HandshakeToken
ShutdownHandler
ShutdownToken
+ 		+

+Classes

+ + + +
serial_port
serial_port_base
+

+Class templates

+
basic_serial_port
+

+Serial Port Options

+ + + + + + +
serial_port_base::baud_rate
serial_port_base::flow_control
serial_port_base::parity
serial_port_base::stop_bits
serial_port_base::character_size
+

+Type Requirements

+ + + +
GettableSerialPortOption
SettableSerialPortOption
+ 		+

+Classes

+
signal_set
+

+Class Templates

+
basic_signal_set
+

+Type Requirements

+ + + +
SignalHandler
SignalToken
+
+ ++++++ + + + + + + + + + + + +
+

+Files and Pipes

+ 		+

+POSIX-specific

+ 		+

+Windows-specific

+
+

+Class Templates

+ + + + + + +
basic_file
basic_random_access_file
basic_readable_pipe
basic_stream_file
basic_writable_pipe
+

+Classes

+ + + + + + +
file_base
random_access_file
readable_pipe
stream_file
writable_pipe
+

+Free Functions

+
connect_pipe
+ 		+

+Classes

+ + + + + + + + + + + + + + + + +
local::seq_packet_protocol
local::seq_packet_protocol::acceptor
local::seq_packet_protocol::endpoint
local::seq_packet_protocol::socket
local::stream_protocol
local::stream_protocol::acceptor
local::stream_protocol::endpoint
local::stream_protocol::iostream
local::stream_protocol::socket
local::datagram_protocol
local::datagram_protocol::endpoint
local::datagram_protocol::socket
posix::descriptor
posix::descriptor_base
posix::stream_descriptor
+ 		+

+Free Functions

+
local::connect_pair
+

+Class Templates

+ + + + +
local::basic_endpoint
posix::basic_descriptor
posix::basic_stream_descriptor
+ 		+

+Classes

+ + + + + + +
windows::object_handle
windows::overlapped_handle
windows::overlapped_ptr
windows::random_access_handle
windows::stream_handle
+

+Class Templates

+ + + + + +
windows::basic_object_handle
windows::basic_overlapped_handle
windows::basic_random_access_handle
windows::basic_stream_handle
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/AcceptHandler.html b/Packages/asio-1.36.0/doc/asio/reference/AcceptHandler.html new file mode 100644 index 0000000..8cfda01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/AcceptHandler.html @@ -0,0 +1,42 @@ + + + +Accept handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ An accept handler must meet the requirements for a handler. + A value h of an accept handler + class should work correctly in the expression h(ec), + where ec is an lvalue of + type const error_code. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/AcceptToken.html b/Packages/asio-1.36.0/doc/asio/reference/AcceptToken.html new file mode 100644 index 0000000..9792934 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/AcceptToken.html @@ -0,0 +1,134 @@ + + + +Accept token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A accept token is a completion + token for completion signature void(error_code). +

+
+ + Examples +
+

+ A free function as a accept token: +

+
void accept_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+
+

+ A accept token function object: +

+
struct accept_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a accept token: +

+
acceptor.async_accept(...,
+    [](const asio::error_code& ec)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a accept token using std::bind(): +

+
void my_class::accept_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+acceptor.async_accept(...,
+    std::bind(&my_class::accept_handler,
+      this, std::placeholders::_1));
+
+

+ A non-static class member function adapted to a accept token using boost::bind(): +

+
void my_class::accept_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+acceptor.async_accept(...,
+    boost::bind(&my_class::accept_handler,
+      this, asio::placeholders::error));
+
+

+ Using use_future as a accept + token: +

+
std::future<void> f = acceptor.async_accept(..., asio::use_future);
+...
+try
+{
+  f.get();
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a accept token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    co_await acceptor.async_accept(..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/AcceptableProtocol.html b/Packages/asio-1.36.0/doc/asio/reference/AcceptableProtocol.html new file mode 100644 index 0000000..721f230 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/AcceptableProtocol.html @@ -0,0 +1,86 @@ + + + +Acceptable protocol requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the AcceptableProtocol requirements if it satisfies + the requirements of Protocol as well as the additional + requirements listed below. +

+
+

Table 3. AcceptableProtocol requirements

+
+++++ + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X::socket +

+ 		+

+ A type that satisfies the requirements of Destructible + (C++Std [destructible]) and MoveConstructible + (C++Std [moveconstructible]), and that is publicly and unambiguously + derived from basic_socket<X>. +

+ 		+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/AsyncRandomAccessReadDevice.html b/Packages/asio-1.36.0/doc/asio/reference/AsyncRandomAccessReadDevice.html new file mode 100644 index 0000000..b7c9b76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/AsyncRandomAccessReadDevice.html @@ -0,0 +1,131 @@ + + + +Buffer-oriented asynchronous random-access read device requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In the table below, a denotes + an asynchronous random access read device object, o + denotes an offset of type boost::uint64_t, + mb denotes an object satisfying + mutable buffer sequence + requirements, and h denotes + an object satisfying read handler + requirements. +

+
+

Table 4. Buffer-oriented asynchronous random-access read device requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.get_executor() +

+ 		+

+ A type satisfying the Executor + requirements. +

+ 		+

+ Returns the associated I/O executor. +

+
+

+ a.async_read_some_at(o, + mb, + h); +

+ 		+

+ void +

+ 		+

+ Initiates an asynchronous operation to read one or more bytes of + data from the device a + at the offset o. + The operation is performed via the I/O executor a.get_executor() and behaves according to asynchronous operation + requirements.

The mutable buffer sequence mb specifies memory where the + data should be placed. The async_read_some_at + operation shall always fill a buffer in the sequence completely + before proceeding to the next.

The implementation + shall maintain one or more copies of mb + until such time as the read operation no longer requires access + to the memory specified by the buffers in the sequence. The program + must ensure the memory is valid until:

— the last copy + of mb is destroyed, + or

— the handler for the asynchronous read operation + is invoked,

whichever comes first.

If + the total size of all buffers in the sequence mb + is 0, the asynchronous + read operation shall complete immediately and pass 0 as the argument to the handler + that specifies the number of bytes read. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/AsyncRandomAccessWriteDevice.html b/Packages/asio-1.36.0/doc/asio/reference/AsyncRandomAccessWriteDevice.html new file mode 100644 index 0000000..4a386e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/AsyncRandomAccessWriteDevice.html @@ -0,0 +1,131 @@ + + + +Buffer-oriented asynchronous random-access write device requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In the table below, a denotes + an asynchronous write stream object, o + denotes an offset of type boost::uint64_t, + cb denotes an object satisfying + constant buffer sequence + requirements, and h denotes + an object satisfying write handler + requirements. +

+
+

Table 5. Buffer-oriented asynchronous random-access write device requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.get_executor() +

+ 		+

+ A type satisfying the Executor + requirements. +

+ 		+

+ Returns the associated I/O executor. +

+
+

+ a.async_write_some_at(o, + cb, + h); +

+ 		+

+ void +

+ 		+

+ Initiates an asynchronous operation to write one or more bytes + of data to the device a + at offset o. The + operation is performed via the I/O executor a.get_executor() and behaves according to asynchronous operation + requirements.

The constant buffer sequence cb specifies memory where the + data to be written is located. The async_write_some_at + operation shall always write a buffer in the sequence completely + before proceeding to the next.

The implementation + shall maintain one or more copies of cb + until such time as the write operation no longer requires access + to the memory specified by the buffers in the sequence. The program + must ensure the memory is valid until:

— the last copy + of cb is destroyed, + or

— the handler for the asynchronous write operation + is invoked,

whichever comes first.

If + the total size of all buffers in the sequence cb + is 0, the asynchronous + write operation shall complete immediately and pass 0 as the argument to the handler + that specifies the number of bytes written. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/AsyncReadStream.html b/Packages/asio-1.36.0/doc/asio/reference/AsyncReadStream.html new file mode 100644 index 0000000..c951823 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/AsyncReadStream.html @@ -0,0 +1,136 @@ + + + +Buffer-oriented asynchronous read stream requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the AsyncReadStream requirements if it satisfies + the requirements listed below. +

+

+ In the table below, a denotes + a value of type X, mb denotes a (possibly const) value satisfying + the MutableBufferSequence + requirements, and t is a + completion token. +

+
+

Table 6. AsyncReadStream requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.get_executor() +

+ 		+

+ A type satisfying the Executor + requirements. +

+ 		+

+ Returns the associated I/O executor. +

+
+

+ a.async_read_some(mb,t) +

+ 		+

+ The return type is determined according to the requirements for + an asynchronous + operation. +

+ 		+

+ Meets the requirements for a read + operation and an asynchronous + operation with completion signature void(error_code + ec, + size_t n).

If buffer_size(mb) + > 0, + initiates an asynchronous operation to read one or more bytes of + data from the stream a + into the buffer sequence mb. + If successful, ec + is set such that !ec is true, + and n is the number + of bytes read. If an error occurred, ec + is set such that !!ec is true, + and n is 0. If + all data has been read from the stream, and the stream performed + an orderly shutdown, ec + is stream_errc::eof + and n is 0.
+
If buffer_size(mb) == 0, the operation completes immediately. + ec is set such + that !ec + is true, and n is 0. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/AsyncWriteStream.html b/Packages/asio-1.36.0/doc/asio/reference/AsyncWriteStream.html new file mode 100644 index 0000000..0b100e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/AsyncWriteStream.html @@ -0,0 +1,132 @@ + + + +Buffer-oriented asynchronous write stream requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the AsyncWriteStream requirements if it satisfies + the requirements listed below. +

+

+ In the table below, a denotes + a value of type X, cb denotes a (possibly const) value satisfying + the ConstBufferSequence + requirements, and t is a + completion token. +

+
+

Table 7. AsyncWriteStream requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.get_executor() +

+ 		+

+ A type satisfying the Executor + requirements. +

+ 		+

+ Returns the associated I/O executor. +

+
+

+ a.async_write_some(cb,t) +

+ 		+

+ The return type is determined according to the requirements for + an asynchronous + operation. +

+ 		+

+ Meets the requirements for a write + operation and an asynchronous + operation with completion signature void(error_code + ec, + size_t n).

If buffer_size(cb) + > 0, + initiates an asynchronous operation to write one or more bytes + of data to the stream a + from the buffer sequence cb. + If successful, ec + is set such that !ec is true, + and n is the number + of bytes written. If an error occurred, ec + is set such that !!ec is true, + and n is 0.
+
If buffer_size(cb) == 0, the operation completes immediately. + ec is set such + that !ec + is true, and n is 0. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/BufferedHandshakeHandler.html b/Packages/asio-1.36.0/doc/asio/reference/BufferedHandshakeHandler.html new file mode 100644 index 0000000..f7f0b57 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/BufferedHandshakeHandler.html @@ -0,0 +1,46 @@ + + + +Buffered handshake handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A buffered handshake handler must meet the requirements for a handler. + A value h of a buffered handshake + handler class should work correctly in the expression h(ec, + s), + where ec is an lvalue of + type const error_code + and s is an lvalue of type + const size_t. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/BufferedHandshakeToken.html b/Packages/asio-1.36.0/doc/asio/reference/BufferedHandshakeToken.html new file mode 100644 index 0000000..b5b4567 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/BufferedHandshakeToken.html @@ -0,0 +1,148 @@ + + + +SSL buffered handshake token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A buffered_handshake token is a completion + token for completion signature void(error_code, size_t). +

+
+ + Examples +
+

+ A free function as a buffered_handshake token: +

+
void buffered_handshake_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+
+

+ A buffered_handshake token function object: +

+
struct buffered_handshake_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec,
+      std::size_t bytes_transferred)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a buffered_handshake token: +

+
ssl_stream.async_handshake(...,
+    [](const asio::error_code& ec,
+      std::size_t bytes_transferred)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a buffered_handshake token + using std::bind(): +

+
void my_class::buffered_handshake_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+...
+ssl_stream.async_handshake(...,
+    std::bind(&my_class::buffered_handshake_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ A non-static class member function adapted to a buffered_handshake token + using boost::bind(): +

+
void my_class::buffered_handshake_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+...
+ssl_stream.async_handshake(...,
+    boost::bind(&my_class::buffered_handshake_handler,
+      this, asio::placeholders::error,
+      asio::placeholders::bytes_transferred));
+
+

+ Using use_future as a buffered + handshake token: +

+
std::future<std::size_t> f =
+  ssl_stream.async_handshake(..., asio::use_future);
+...
+try
+{
+  std::size_t n = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a buffered handshake token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    std::size_t n =
+      co_await ssl_stream.async_handshake(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/CancellationHandler.html b/Packages/asio-1.36.0/doc/asio/reference/CancellationHandler.html new file mode 100644 index 0000000..ff6ffdf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/CancellationHandler.html @@ -0,0 +1,82 @@ + + + +Cancellation handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A value h of a cancellation + handler class should work correctly in the expression h(t), + where t is a value of type + asio::cancellation_type. +

+
+ + Examples +
+

+ A free function as a cancellation handler: +

+
void cancellation_handler(
+    asio::cancellation_type type)
+{
+  ...
+}
+
+slot.assign(cancellation_handler);
+
+

+ A cancellation handler function object: +

+
struct cancellation_handler
+{
+  ...
+  void operator()(
+      asio::cancellation_type type)
+  {
+    ...
+  }
+  ...
+};
+
+cancellation_handler& h = slot.assign(cancellation_handler{ ... });
+
+

+ A lambda as a cancellation handler: +

+
auto& h = slot.assign(
+    [](asio::cancellation_type type)
+    {
+      ...
+    });
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/CancellationSlot.html b/Packages/asio-1.36.0/doc/asio/reference/CancellationSlot.html new file mode 100644 index 0000000..5934f73 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/CancellationSlot.html @@ -0,0 +1,251 @@ + + + +Cancellation slot requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the CancellationSlot requirements if it satisfies + the requirements of CopyConstructible + (C++Std [copyconstructible]) and Destructible + (C++Std [destructible]), as well as the additional requirements listed below. +

+

+ In the table below, x1 and + x2 denote (possibly const) + values of type X, mx1 denotes an xvalue of type X, H + denotes a type that satisfies CancellationHandler, + h denotes an xvalue of type + H, and u0 + to uN denote identifiers. +

+
+

Table 8. CancellationSlot requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X u(x1); +

+ 		+ +

+ Shall not exit via an exception.

post: u == + x1. +

+
+

+ X u(mx1); +

+ 		+ +

+ Shall not exit via an exception.

post: u equals the prior value of + mx1. +

+
+

+ x1 == + x2 +

+ 		+

+ bool +

+ 		+

+ Returns true only + if x1 and x2 can be interchanged with identical + effects.
operator== shall be reflexive, symmetric, + and transitive, and shall not exit via an exception. +

+
+

+ x1 != + x2 +

+ 		+

+ bool +

+ 		+

+ Same as !(x1 + == x2). +

+
+

+ x1.is_connected() +

+ 		+

+ bool +

+ 		+

+ Returns false only + if the slot can never cause the invocation of a handler attached + to the slot using assign + or emplace. +

+
+

+ x1.has_handler() +

+ 		+

+ bool +

+ 		+

+ Returns true if a + handler has been attached to the slot. +

+
+

+ x1.assign(h) +

+ 		+

+ H& +

+ 		+

+ Destroys the existing handler that is attached to the slot, if + any, and attaches a move-constructed decay-copy of the handler + h.

+ Returns a reference to the newly attached handler.

+ post: x1.has_handler() + == true. +

+
+

+ x1.emplace<H>(u0, + ..., uN) +

+ 		+

+ H& +

+ 		+

+ Requires that is_constructible<H, decltype(u0), ..., + decltype(u0)>::value be true.

Destroys + the existing handler that is attached to the slot, if any, and + attaches a handler of type H + constructed with the specified arguments u0, ..., + uN.

Returns + a reference to the newly attached handler.

post: + x1.has_handler() + == true. +

+
+

+ x1.clear() +

+ 		+ +

+ Post: x1.has_handler() + == false. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/CompletionCondition.html b/Packages/asio-1.36.0/doc/asio/reference/CompletionCondition.html new file mode 100644 index 0000000..ebf3baf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/CompletionCondition.html @@ -0,0 +1,108 @@ + + + +Completion condition requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A completion condition is a function object that is + used with the algorithms read, async_read, write, and async_write to determine when the + algorithm has completed transferring data. +

+

+ A type X meets the CompletionCondition requirements if it + satisfies the requirements of Destructible + (C++Std [destructible]) and MoveConstructible + (C++Std [moveconstructible]), as well as the additional requirements listed + below. +

+

+ In the table below, x denotes + a value of type X, ec denotes a (possibly const) value of + type error_code, and n denotes a (possibly const) value of type + size_t. +

+
+

Table 9. CompletionCondition requirements

+
+++++ + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ x(ec, + n) +

+ 		+

+ size_t +

+ 		+

+ Let n be the total + number of bytes transferred by the read or write algorithm so far.
+
Returns the maximum number of bytes to be transferred on + the next read_some, + async_read_some, + write_some, or + async_write_some + operation performed by the algorithm. Returns 0 + to indicate that the algorithm is complete. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ConnectCondition.html b/Packages/asio-1.36.0/doc/asio/reference/ConnectCondition.html new file mode 100644 index 0000000..87203f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ConnectCondition.html @@ -0,0 +1,100 @@ + + + +Connect condition requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the ConnectCondition requirements if it satisfies + the requirements of Destructible + (C++Std [destructible]) and CopyConstructible + (C++Std [copyconstructible]), as well as the additional requirements listed + below. +

+

+ In the table below, x denotes + a value of type X, ec denotes a (possibly const) value of + type error_code, and ep denotes a (possibly const) value of + some type satisfying the endpoint + requirements. +

+
+

Table 10. ConnectCondition requirements

+
+++++ + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ x(ec, + ep) +

+ 		+

+ bool +

+ 		+

+ Returns true to indicate + that the connect + or async_connect + algorithm should attempt a connection to the endpoint ep. Otherwise, returns false to indicate that the algorithm + should not attempt connection to the endpoint ep, + and should instead skip to the next endpoint in the sequence. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ConnectHandler.html b/Packages/asio-1.36.0/doc/asio/reference/ConnectHandler.html new file mode 100644 index 0000000..a79b0c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ConnectHandler.html @@ -0,0 +1,42 @@ + + + +Connect handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A connect handler must meet the requirements for a handler. + A value h of a connect handler + class should work correctly in the expression h(ec), + where ec is an lvalue of + type const error_code. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ConnectToken.html b/Packages/asio-1.36.0/doc/asio/reference/ConnectToken.html new file mode 100644 index 0000000..1c5d255 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ConnectToken.html @@ -0,0 +1,134 @@ + + + +Connect token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A connect token is a completion + token for completion signature void(error_code). +

+
+ + Examples +
+

+ A free function as a connect token: +

+
void connect_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+
+

+ A connect token function object: +

+
struct connect_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a connect token: +

+
socket.async_connect(...,
+    [](const asio::error_code& ec)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a connect token using std::bind(): +

+
void my_class::connect_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+socket.async_connect(...,
+    std::bind(&my_class::connect_handler,
+      this, std::placeholders::_1));
+
+

+ A non-static class member function adapted to a connect token using boost::bind(): +

+
void my_class::connect_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+socket.async_connect(...,
+    boost::bind(&my_class::connect_handler,
+      this, asio::placeholders::error));
+
+

+ Using use_future as a connect + token: +

+
std::future<void> f = socket.async_connect(..., asio::use_future);
+...
+try
+{
+  f.get();
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a connect token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    co_await socket.async_connect(..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ConstBufferSequence.html b/Packages/asio-1.36.0/doc/asio/reference/ConstBufferSequence.html new file mode 100644 index 0000000..a7b08b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ConstBufferSequence.html @@ -0,0 +1,124 @@ + + + +Constant buffer sequence requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A constant buffer sequence represents a set of memory + regions that may be used as input to an operation, such as the send operation of a socket. +

+

+ A type X meets the ConstBufferSequence requirements if it + satisfies the requirements of Destructible + (C++Std [destructible]) and CopyConstructible + (C++Std [copyconstructible]), as well as the additional requirements listed + below. +

+

+ In the table below, x denotes + a (possibly const) value of type X, + and u denotes an identifier. +

+
+

Table 11. ConstBufferSequence requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ asio::buffer_sequence_begin(x)
+ asio::buffer_sequence_end(x) +

+ 		+

+ An iterator type meeting the requirements for bidirectional iterators + (C++Std [bidirectional.iterators]) whose value type is convertible + to const_buffer. +

+ 		+
+
X u(x);
+
+ 		+ +

+ post:
+

+
equal(
+  asio::buffer_sequence_begin(x),
+  asio::buffer_sequence_end(x),
+  asio::buffer_sequence_begin(u),
+  asio::buffer_sequence_end(u),
+  [](const const_buffer& b1,
+     const const_buffer& b2)
+   {
+     return b1.data() == b2.data()
+         && b1.size() == b2.size();
+   })
+
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/Disposition.html b/Packages/asio-1.36.0/doc/asio/reference/Disposition.html new file mode 100644 index 0000000..4442971 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/Disposition.html @@ -0,0 +1,114 @@ + + + +Disposition + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X satisfies the disposition concept if it is nothrow default-constructible, + nothrow move-constructible, nothrow move-assignable, as well as satisfying + the additional requirements listed below. In the following table x denotes a glvalue of type X. +

+
+

Table 12. Disposition requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ asio::disposition_traits<X>::not_an_error(x) +

+ 		+

+ bool +

+ 		+
+

+ asio::disposition_traits<X>::throw_exception(x) +

+ 		+ +

+ pre: asio::disposition_traits<X>::not_an_error(x) + is false.
+ This function call must exit via an exception. +

+
+

+ asio::disposition_traits<X>::to_exception_ptr(x) +

+ 		+

+ std::exception_ptr +

+ 		+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer.html b/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer.html new file mode 100644 index 0000000..07cd11e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer.html @@ -0,0 +1,48 @@ + + + +Dynamic buffer requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ See: +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer_v1.html b/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer_v1.html new file mode 100644 index 0000000..e0bc3d0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer_v1.html @@ -0,0 +1,261 @@ + + + +Dynamic buffer requirements (version 1) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A dynamic buffer encapsulates memory storage that may be automatically resized + as required, where the memory is divided into an input sequence followed + by an output sequence. These memory regions are internal to the dynamic buffer + sequence, but direct access to the elements is provided to permit them to + be efficiently used with I/O operations, such as the send + or receive operations of + a socket. Data written to the output sequence of a dynamic buffer sequence + object is appended to the input sequence of the same object. +

+

+ A dynamic buffer type X shall + satisfy the requirements of MoveConstructible + (C++ Std, [moveconstructible]) types in addition to those listed below. +

+

+ In the table below, X denotes + a dynamic buffer class, x + denotes a value of type X&, x1 + denotes values of type const X&, + and n denotes a value of + type size_t, and u denotes an identifier. +

+
+

Table 13. DynamicBuffer_v1 requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X::const_buffers_type +

+ 		+

+ type meeting ConstBufferSequence + requirements. +

+ 		+

+ This type represents the memory associated with the input sequence. +

+
+

+ X::mutable_buffers_type +

+ 		+

+ type meeting MutableBufferSequence + requirements. +

+ 		+

+ This type represents the memory associated with the output sequence. +

+
+

+ x1.size() +

+ 		+

+ size_t +

+ 		+

+ Returns the size, in bytes, of the input sequence. +

+
+

+ x1.max_size() +

+ 		+

+ size_t +

+ 		+

+ Returns the permitted maximum of the sum of the sizes of the input + sequence and output sequence. +

+
+

+ x1.capacity() +

+ 		+

+ size_t +

+ 		+

+ Returns the maximum sum of the sizes of the input sequence and + output sequence that the dynamic buffer can hold without requiring + reallocation. +

+
+

+ x1.data() +

+ 		+

+ X::const_buffers_type +

+ 		+

+ Returns a constant buffer sequence u + that represents the memory associated with the input sequence, + and where buffer_size(u) == size(). +

+
+

+ x.prepare(n) +

+ 		+

+ X::mutable_buffers_type +

+ 		+

+ Requires: size() + n <= + max_size().
+
Returns a mutable buffer sequence u + representing the output sequence, and where buffer_size(u) == n. The dynamic buffer reallocates + memory as required. All constant or mutable buffer sequences previously + obtained using data() or prepare() are invalidated.

+ Throws: length_error + if size() + + n + > max_size(). +

+
+

+ x.commit(n) +

+ 		+ +

+ Appends n bytes + from the start of the output sequence to the end of the input sequence. + The remainder of the output sequence is discarded. If n is greater than the size of + the output sequence, the entire output sequence is appended to + the input sequence. All constant or mutable buffer sequences previously + obtained using data() or prepare() are invalidated. +

+
+

+ x.consume(n) +

+ 		+ +

+ Removes n bytes + from beginning of the input sequence. If n + is greater than the size of the input sequence, the entire input + sequence is removed. All constant or mutable buffer sequences previously + obtained using data() or prepare() are invalidated. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer_v2.html b/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer_v2.html new file mode 100644 index 0000000..f7215d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/DynamicBuffer_v2.html @@ -0,0 +1,272 @@ + + + +Dynamic buffer requirements (version 2) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A dynamic buffer encapsulates memory storage that may be automatically resized + as required. +

+

+ A dynamic buffer type X shall + satisfy the requirements of CopyConstructible + (C++ Std, [copyconstructible]) types in addition to those listed below. +

+

+ In the table below, X denotes + a dynamic buffer class, x + denotes a value of type X&, x1 + denotes values of type const X&, + pos and n + denote values of type size_t, + and u denotes an identifier. +

+
+

Table 14. DynamicBuffer_v2 requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X::const_buffers_type +

+ 		+

+ type meeting ConstBufferSequence + requirements. +

+ 		+

+ This type represents the underlying memory as a sequence of @c + const_buffer objects. +

+
+

+ X::mutable_buffers_type +

+ 		+

+ type meeting MutableBufferSequence + requirements. +

+ 		+

+ This type represents the underlying memory as a sequence of @c + mutable_buffer objects. +

+
+

+ x1.size() +

+ 		+

+ size_t +

+ 		+

+ Returns the size, in bytes, of the underlying memory. +

+
+

+ x1.max_size() +

+ 		+

+ size_t +

+ 		+

+ Returns the permitted maximum size of the underlying memory. +

+
+

+ x1.capacity() +

+ 		+

+ size_t +

+ 		+

+ Returns the maximum size to which the underlying memory can grow + without requiring reallocation. +

+
+

+ x1.data(pos, + n) +

+ 		+

+ X::const_buffers_type +

+ 		+

+ Returns a constant buffer sequence u + that represents the underlying memory beginning at offset pos, and where buffer_size(u) + <= n. +

+
+

+ x.data(pos, + n) +

+ 		+

+ X::mutable_buffers_type +

+ 		+

+ Returns a mutable buffer sequence u + that represents the underlying memory beginning at offset pos, and where buffer_size(u) + <= n. +

+
+

+ x.grow(n) +

+ 		+ +

+ Requires: size() + n <= + max_size().
+
Extends the underlying memory to accommodate n additional bytes at the end. + The dynamic buffer reallocates memory as required. All constant + or mutable buffer sequences previously obtained using data() + are invalidated.

Throws: length_error + if size() + + n + > max_size(). +

+
+

+ x.shrink(n) +

+ 		+ +

+ Removes n bytes + from the end of the underlying memory. If n + is greater than the size of the underlying memory, the entire underlying + memory is emptied. All constant or mutable buffer sequences previously + obtained using data() are invalidated. +

+
+

+ x.consume(n) +

+ 		+ +

+ Removes n bytes + from the beginning of the underlying memory. If n + is greater than the size of the underlying memory, the entire underlying + memory is emptied. All constant or mutable buffer sequences previously + obtained using data() are invalidated. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/Endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/Endpoint.html new file mode 100644 index 0000000..4ade658 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/Endpoint.html @@ -0,0 +1,261 @@ + + + +Endpoint requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the Endpoint requirements if it satisfies the + requirements of Destructible + (C++Std [destructible]), DefaultConstructible + (C++Std [defaultconstructible]), CopyConstructible + (C++Std [copyconstructible]), and CopyAssignable + (C++Std [copyassignable]), as well as the additional requirements listed + below. +

+

+ The default constructor and move operations of the type X + shall not exit via an exception. +

+

+ In the table below, a denotes + a (possibly const) value of type X, + and u denotes an identifier. +

+
+

Table 15. Endpoint requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X::protocol_type +

+ 		+

+ type meeting Protocol requirements +

+ 		+
+

+ a.protocol() +

+ 		+

+ protocol_type +

+ 		+
+
+

+ In the table below, a denotes + a (possibly const) value of type X, + b denotes a value of type + X, and s + denotes a (possibly const) value of a type that is convertible to size_t and denotes a size in bytes. +

+
+

Table 16. Endpoint requirements for extensible implementations

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ a.data() +

+ 		+

+ const void* +

+ 		+

+ Returns a pointer suitable for passing as the address + argument to functions such as POSIX connect(), + or as the dest_addr argument to functions + such as POSIX sendto(). + The implementation shall perform a static_cast + on the pointer to convert it to const + sockaddr*. +

+
+

+ b.data() +

+ 		+

+ void* +

+ 		+

+ Returns a pointer suitable for passing as the address + argument to functions such as POSIX accept(), + getpeername(), + getsockname() + and recvfrom(). + The implementation shall perform a static_cast + on the pointer to convert it to sockaddr*. +

+
+

+ a.size() +

+ 		+

+ size_t +

+ 		+

+ Returns a value suitable for passing as the address_len + argument to functions such as POSIX connect(), + or as the dest_len argument to functions such + as POSIX sendto(), + after appropriate integer conversion has been performed. +

+
+

+ b.resize(s) +

+ 		+ +

+ pre: s >= + 0
post: a.size() + == s
+ Passed the value contained in the address_len + argument to functions such as POSIX accept(), + getpeername(), + getsockname() + and recvfrom(), + after successful completion of the function. Permitted to throw + an exception if the protocol associated with the endpoint object + a does not support + the specified size. +

+
+

+ a.capacity() +

+ 		+

+ size_t +

+ 		+

+ Returns a value suitable for passing as the address_len + argument to functions such as POSIX accept(), + getpeername(), + getsockname() + and recvfrom(), + after appropriate integer conversion has been performed. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/EndpointSequence.html b/Packages/asio-1.36.0/doc/asio/reference/EndpointSequence.html new file mode 100644 index 0000000..4589365 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/EndpointSequence.html @@ -0,0 +1,95 @@ + + + +Endpoint sequence requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the EndpointSequence requirements if it satisfies + the requirements of Destructible + (C++Std [destructible]) and CopyConstructible + (C++Std [copyconstructible]), as well as the additional requirements listed + below. +

+

+ In the table below, x denotes + a (possibly const) value of type X. +

+
+

Table 17. EndpointSequence requirements

+
+++++ + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ x.begin()
+ x.end() +

+ 		+

+ A type meeting the requirements for forward iterators (C++Std [forward.iterators]) + whose value type is convertible to a type satisfying the Endpoint + requirements. +

+ 		+

+ [x.begin(),x.end()) + is a valid range. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ExecutionContext.html b/Packages/asio-1.36.0/doc/asio/reference/ExecutionContext.html new file mode 100644 index 0000000..8cea2e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ExecutionContext.html @@ -0,0 +1,121 @@ + + + +Execution context requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the ExecutionContext requirements if it is + publicly and unambiguously derived from execution_context, + and satisfies the additional requirements listed below. +

+

+ In the table below, x denotes + a value of type X. +

+
+

Table 18. ExecutionContext requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ X::executor_type +

+ 		+

+ type meeting Executor requirements +

+ 		+
+

+ x.~X() +

+ 		+ +

+ Destroys all unexecuted function objects that were submitted via + an executor object that is associated with the execution context. +

+
+

+ x.get_executor() +

+ 		+

+ X::executor_type +

+ 		+

+ Returns an executor object that is associated with the execution + context. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/Executor1.html b/Packages/asio-1.36.0/doc/asio/reference/Executor1.html new file mode 100644 index 0000000..6d985e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/Executor1.html @@ -0,0 +1,425 @@ + + + +Executor requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + Standard + executors +
+

+ Let executor-of-impl + be the exposition-only concept +

+
template<class E, class F>
+  concept executor-of-impl =
+    invocable<decay_t<F>&> &&
+    constructible_from<decay_t<F>, F> &&
+    move_constructible<decay_t<F>> &&
+    copy_constructible<E> &&
+    is_nothrow_copy_constructible_v<E> &&
+    equality_comparable<E> /* nothrow */ &&
+    requires(const E& e, F&& f) {
+      e.execute((F&&)f);
+    };
+
+

+ Then the executor and executor_of concepts are defined as follows: +

+
template<class E>
+  concept executor =
+    executor-of-impl<E, execution::invocable_archetype>;
+
+template<class E, class F>
+  concept executor_of =
+    executor<E> &&
+    executor-of-impl<E, F>;
+
+

+ Neither an executor's equality comparison nor swap + operation shall exit via an exception. +

+

+ None of an executor type's copy constructor, destructor, equality comparison, + swap function, execute function, or associated query functions shall introduce data races + as a result of concurrent invocations of those functions from different threads. +

+

+ For any two (possibly const) values x1 + and x2 of some executor type + X, x1 + == x2 + shall return true only if asio::query(x1,p) == asio::query(x2,p) for + every property p where both + asio::query(x1,p) and asio::query(x2,p) are + well-formed and result in a non-void type that is equality_comparable + (C++Std [equalitycomparable]). [Note: The above requirements + imply that x1 == + x2 returns true + if x1 and x2 + can be interchanged with identical effects. An executor may conceptually + contain additional properties which are not exposed by a named property type + that can be observed via asio::query; + in this case, it is up to the concrete executor implementation to decide + if these properties affect equality. Returning false + does not necessarily imply that the effects are not identical. —end + note] +

+

+ An executor type's destructor shall not block pending completion of the submitted + function objects. [Note: The ability to wait for completion + of submitted function objects may be provided by the associated execution + context. —end note] +

+

+ In addition to the above requirements, types E + and F model executor_of only if they satisfy the requirements + of the Table below. +

+

+ Let: +

+
    +
  • + e denotes a (possibly + const) executor object of type E, +
    • +
  • + cf denotes the function + object DECAY_COPY(std::forward<F>(f)) +
    • +
  • + f denotes a function + of type F&& + invocable as cf() + and where decay_t<F> + models move_constructible. +
    • +
+

+ The expression e.execute(f): +

+
    +
  • + Evaluates DECAY_COPY(std::forward<F>(f)) on the calling thread to create cf that will be invoked at most once + by an execution agent. +
    • +
  • + May block pending completion of this invocation. Synchronizes with [intro.multithread] + the invocation of f. +
    • +
  • + Shall not propagate any exception thrown by the function object or any + other function submitted to the executor. +
    • +
+

+ [Note: The treatment of exceptions thrown by one-way + submitted functions is implementation-defined. The forward progress guarantee + of the associated execution agent(s) is implementation-defined. —end + note] +

+
+ + Networking + TS-style executors +
+

+ The library describes a standard set of requirements for executors. + A type meeting the Executor + requirements embodies a set of rules for determining how submitted function + objects are to be executed. +

+

+ A type X meets the Executor requirements if it satisfies the + requirements of CopyConstructible + (C++Std [copyconstructible]) and Destructible + (C++Std [destructible]), as well as the additional requirements listed below. +

+

+ No constructor, comparison operator, copy operation, move operation, swap + operation, or member functions context, + on_work_started, and on_work_finished on these types shall exit + via an exception. +

+

+ The executor copy constructor, comparison operators, and other member functions + defined in these requirements shall not introduce data races as a result + of concurrent calls to those functions from different threads. +

+

+ Let ctx be the execution + context returned by the executor's context() member function. An executor becomes invalid + when the first call to ctx.shutdown() returns. The effect of calling on_work_started, on_work_finished, + dispatch, post, + or defer on an invalid executor + is undefined. [Note: The copy constructor, comparison + operators, and context() + member function continue to remain valid until ctx + is destroyed. —end note] +

+

+ In the table below, x1 and + x2 denote (possibly const) + values of type X, mx1 denotes an xvalue of type X, f + denotes a MoveConstructible + (C++Std [moveconstructible]) function object callable with zero arguments, + a denotes a (possibly const) + value of type A meeting the + Allocator requirements (C++Std + [allocator.requirements]), and u + denotes an identifier. +

+
+

Table 19. Executor requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X u(x1); +

+ 		+ +

+ Shall not exit via an exception.

post: u == + x1 and std::addressof(u.context()) + == std::addressof(x1.context()). +

+
+

+ X u(mx1); +

+ 		+ +

+ Shall not exit via an exception.

post: u equals the prior value of + mx1 and std::addressof(u.context()) + equals the prior value of std::addressof(mx1.context()). +

+
+

+ x1 == + x2 +

+ 		+

+ bool +

+ 		+

+ Returns true only + if x1 and x2 can be interchanged with identical + effects in any of the expressions defined in these type requirements. + [Note: Returning false + does not necessarily imply that the effects are not identical. + —end note]

operator== shall be reflexive, symmetric, + and transitive, and shall not exit via an exception. +

+
+

+ x1 != + x2 +

+ 		+

+ bool +

+ 		+

+ Same as !(x1 + == x2). +

+
+

+ x1.context() +

+ 		+

+ execution_context&, or E& where E + is a type that satifisfies the ExecutionContext requirements. +

+ 		+

+ Shall not exit via an exception.

The comparison operators + and member functions defined in these requirements shall not alter + the reference returned by this function. +

+
+

+ x1.on_work_started() +

+ 		+ +

+ Shall not exit via an exception. +

+
+

+ x1.on_work_finished() +

+ 		+ +

+ Shall not exit via an exception.

Precondition: A preceding + call x2.on_work_started() + where x1 == + x2. +

+
+

+ x1.dispatch(std::move(f),a) +

+ 		+ +

+ Effects: Creates an object f1 + initialized with DECAY_COPY(forward<Func>(f)) (C++Std [thread.decaycopy]) in + the current thread of execution . Calls f1() at most once. The executor may + block forward progress of the caller until f1() finishes execution.

+ Executor implementations should use the supplied allocator to allocate + any memory required to store the function object. Prior to invoking + the function object, the executor shall deallocate any memory allocated. + [Note: Executors defined in this Technical + Specification always use the supplied allocator unless otherwise + specified. —end note]

Synchronization: + The invocation of dispatch + synchronizes with (C++Std [intro.multithread]) the invocation of + f1. +

+
+

+ x1.post(std::move(f),a)
+ x1.defer(std::move(f),a) +

+ 		+ +

+ Effects: Creates an object f1 + initialized with DECAY_COPY(forward<Func>(f)) in the current thread of execution. + Calls f1() + at most once. The executor shall not block forward progress of + the caller pending completion of f1().

Executor implementations + should use the supplied allocator to allocate any memory required + to store the function object. Prior to invoking the function object, + the executor shall deallocate any memory allocated. [Note: + Executors defined in this Technical Specification always use the + supplied allocator unless otherwise specified. —end note] +

Synchronization: The invocation of post or defer + synchronizes with (C++Std [intro.multithread]) the invocation of + f1.

+ [Note: Although the requirements placed on + defer are identical + to post, the use + of post conveys + a preference that the caller does not block + the first step of f1's progress, whereas defer conveys a preference that + the caller does block the first step of f1. + One use of defer + is to convey the intention of the caller that f1 + is a continuation of the current call context. The executor may + use this information to optimize or otherwise adjust the way in + which f1 is invoked. + —end note] +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/GettableSerialPortOption.html b/Packages/asio-1.36.0/doc/asio/reference/GettableSerialPortOption.html new file mode 100644 index 0000000..6ccd0d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/GettableSerialPortOption.html @@ -0,0 +1,96 @@ + + + +Gettable serial port option requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In the table below, X denotes + a serial port option class, a + denotes a value of X, ec denotes a value of type error_code, and s + denotes a value of implementation-defined type storage + (where storage is the type DCB on Windows and termios + on POSIX platforms), and u + denotes an identifier. +

+
+

Table 20. GettableSerialPortOption requirements

+
+++++ + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ const storage& u + = s;
a.load(u, ec); +

+ 		+

+ error_code +

+ 		+

+ Retrieves the value of the serial port option from the storage.
+
If successful, sets ec + such that !ec + is true. If an error occurred, sets ec + such that !!ec + is true. Returns ec. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/GettableSocketOption.html b/Packages/asio-1.36.0/doc/asio/reference/GettableSocketOption.html new file mode 100644 index 0000000..401882c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/GettableSocketOption.html @@ -0,0 +1,176 @@ + + + +Gettable socket option requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the GettableSocketOption requirements if it + satisfies the requirements listed below. +

+

+ In the table below, a denotes + a (possibly const) value of type X, + b denotes a value of type + X, p + denotes a (possibly const) value that meets the Protocol requirements, and s denotes a (possibly const) value of a + type that is convertible to size_t + and denotes a size in bytes. +

+
+

Table 21. GettableSocketOption requirements for extensible implementations

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ a.level(p) +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the level + argument to POSIX getsockopt() + (or equivalent). +

+
+

+ a.name(p) +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the option_name + argument to POSIX getsockopt() + (or equivalent). +

+
+

+ b.data(p) +

+ 		+

+ void* +

+ 		+

+ Returns a pointer suitable for passing as the option_value + argument to POSIX getsockopt() + (or equivalent). +

+
+

+ a.size(p) +

+ 		+

+ size_t +

+ 		+

+ Returns a value suitable for passing as the option_len + argument to POSIX getsockopt() + (or equivalent), after appropriate integer conversion has been + performed. +

+
+

+ b.resize(p,s) +

+ 		+ +

+ post: b.size(p) + == s.
+ Passed the value contained in the option_len + argument to POSIX getsockopt() + (or equivalent) after successful completion of the function. Permitted + to throw an exception if the socket option object b does not support the specified + size. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/Handler.html b/Packages/asio-1.36.0/doc/asio/reference/Handler.html new file mode 100644 index 0000000..9c1796d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/Handler.html @@ -0,0 +1,44 @@ + + + +Handlers + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A handler must satisfy the requirements of Destructible + (C++Std [destructible]) and MoveConstructible + (C++Std [moveconstructible]). +

+

+ A handler may expose additional information and behaviour via associators, + such as associated_allocator, associated_executor, and associated_cancellation_slot. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/HandshakeHandler.html b/Packages/asio-1.36.0/doc/asio/reference/HandshakeHandler.html new file mode 100644 index 0000000..57352b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/HandshakeHandler.html @@ -0,0 +1,43 @@ + + + +SSL handshake handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A handshake handler must meet the requirements for a handler. + A value h of a handshake + handler class should work correctly in the expression h(ec), + where ec is an lvalue of + type const error_code. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/HandshakeToken.html b/Packages/asio-1.36.0/doc/asio/reference/HandshakeToken.html new file mode 100644 index 0000000..6c37ac8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/HandshakeToken.html @@ -0,0 +1,134 @@ + + + +SSL handshake token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A handshake token is a completion + token for completion signature void(error_code). +

+
+ + Examples +
+

+ A free function as a handshake token: +

+
void handshake_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+
+

+ A handshake token function object: +

+
struct handshake_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a handshake token: +

+
ssl_stream.async_handshake(...,
+    [](const asio::error_code& ec)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a handshake token using std::bind(): +

+
void my_class::handshake_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+ssl_stream.async_handshake(...,
+    std::bind(&my_class::handshake_handler,
+      this, std::placeholders::_1));
+
+

+ A non-static class member function adapted to a handshake token using boost::bind(): +

+
void my_class::handshake_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+ssl_stream.async_handshake(...,
+    boost::bind(&my_class::handshake_handler,
+      this, asio::placeholders::error));
+
+

+ Using use_future as a handshake + token: +

+
std::future<void> f = ssl_stream.async_handshake(..., asio::use_future);
+...
+try
+{
+  f.get();
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a handshake token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    co_await ssl_stream.async_handshake(..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/InternetProtocol.html b/Packages/asio-1.36.0/doc/asio/reference/InternetProtocol.html new file mode 100644 index 0000000..f3caa6d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/InternetProtocol.html @@ -0,0 +1,165 @@ + + + +Internet protocol requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the InternetProtocol requirements if it satisfies + the requirements of AcceptableProtocol, as well as the + additional requirements listed below. +

+

+ In the table below, a denotes + a (possibly const) value of type X, + and b denotes a (possibly + const) value of type X. +

+
+

Table 22. InternetProtocol requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X::resolver +

+ 		+

+ ip::basic_resolver<X> +

+ 		+

+ The type of a resolver for the protocol. +

+
+

+ X::v4() +

+ 		+

+ X +

+ 		+

+ Returns an object representing the IP version 4 protocol. +

+
+

+ X::v6() +

+ 		+

+ X +

+ 		+

+ Returns an object representing the IP version 6 protocol. +

+
+

+ a == + b +

+ 		+

+ convertible to bool +

+ 		+

+ Returns true if a and b + represent the same IP protocol version, otherwise false. +

+
+

+ a != + b +

+ 		+

+ convertible to bool +

+ 		+

+ Returns !(a + == b). +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/IoControlCommand.html b/Packages/asio-1.36.0/doc/asio/reference/IoControlCommand.html new file mode 100644 index 0000000..3f2b458 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/IoControlCommand.html @@ -0,0 +1,109 @@ + + + +I/O control command requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the IoControlCommand requirements if it satisfies + the requirements listed below. +

+

+ In the table below, a denotes + a (possibly const) value of type X, + and b denotes a value of + type X. +

+
+

Table 23. IoControlCommand requirements for extensible implementations

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ a.name() +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the request + argument to POSIX ioctl() + (or equivalent). +

+
+

+ b.data() +

+ 		+

+ void* +

+ 		+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/IoObjectService.html b/Packages/asio-1.36.0/doc/asio/reference/IoObjectService.html new file mode 100644 index 0000000..478db4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/IoObjectService.html @@ -0,0 +1,154 @@ + + + +I/O object service requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ An I/O object service must meet the requirements for a service, + as well as the requirements listed below. +

+

+ In the table below, X denotes + an I/O object service class, a + and ao denote values of type + X, b + and c denote values of type + X::implementation_type, and u denotes an identifier. +

+
+

Table 24. IoObjectService requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ X::implementation_type +

+ 		+ +
+

+ X::implementation_type u; +

+ 		+ +

+ note: X::implementation_type has a public + default constructor and destructor. +

+
+
a.construct(b);
+
+ 		+ +
+
a.destroy(b);
+
+ 		+ +

+ note: destroy() + will only be called on a value that has previously been initialised + with construct() or move_construct(). +

+
+
a.move_construct(b, c);
+
+ 		+ +

+ note: only required for I/O objects that support movability. +

+
+
a.move_assign(b, ao, c);
+
+ 		+ +

+ note: only required for I/O objects that support movability. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/IteratorConnectHandler.html b/Packages/asio-1.36.0/doc/asio/reference/IteratorConnectHandler.html new file mode 100644 index 0000000..b2479b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/IteratorConnectHandler.html @@ -0,0 +1,46 @@ + + + +Iterator connect handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ An iterator connect handler must meet the requirements for a handler. + A value h of an iterator + connect handler class should work correctly in the expression h(ec, i), + where ec is an lvalue of + type const error_code + and i is an lvalue of the + type Iterator used in the + corresponding async_connect() function. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/IteratorConnectToken.html b/Packages/asio-1.36.0/doc/asio/reference/IteratorConnectToken.html new file mode 100644 index 0000000..25a5836 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/IteratorConnectToken.html @@ -0,0 +1,150 @@ + + + +Iterator connect token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ An iterator connect token is a completion + token for completion signature void(error_code, Iterator), where the type Iterator + is used in the corresponding async_connect() function. +

+
+ + Examples +
+

+ A free function as an iterator connect token: +

+
void connect_handler(
+    const asio::error_code& ec,
+    asio::ip::tcp::resolver::iterator iterator)
+{
+  ...
+}
+
+

+ An iterator connect token function object: +

+
struct connect_handler
+{
+  ...
+  template <typename Iterator>
+  void operator()(
+      const asio::error_code& ec,
+      Iterator iterator)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as an iterator connect token: +

+
asio::async_connect(...,
+    [](const asio::error_code& ec,
+      asio::ip::tcp::resolver::iterator iterator)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to an iterator connect token using + std::bind(): +

+
void my_class::connect_handler(
+    const asio::error_code& ec,
+    asio::ip::tcp::resolver::iterator iterator)
+{
+  ...
+}
+...
+asio::async_connect(...,
+    std::bind(&my_class::connect_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ A non-static class member function adapted to an iterator connect token using + boost::bind(): +

+
void my_class::connect_handler(
+    const asio::error_code& ec,
+    asio::ip::tcp::resolver::iterator iterator)
+{
+  ...
+}
+...
+asio::async_connect(...,
+    boost::bind(&my_class::connect_handler,
+      this, asio::placeholders::error,
+      asio::placeholders::iterator));
+
+

+ Using use_future as an iterator + connect token: +

+
std::future<asio::ip::tcp::resolver::iterator> f =
+  asio::async_connect(..., asio::use_future);
+...
+try
+{
+  asio::ip::tcp::resolver::iterator i = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + an iterator connect token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    asio::ip::tcp::resolver::iterator i =
+      co_await asio::async_connect(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/MoveAcceptHandler.html b/Packages/asio-1.36.0/doc/asio/reference/MoveAcceptHandler.html new file mode 100644 index 0000000..d2b85e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/MoveAcceptHandler.html @@ -0,0 +1,47 @@ + + + +Move accept handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A move accept handler must meet the requirements for a handler. + A value h of a move accept + handler class should work correctly in the expression h(ec, + s), + where ec is an lvalue of + type const error_code + and s is an lvalue of the + nested type Protocol::socket for the type Protocol + of the socket class template. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/MoveAcceptToken.html b/Packages/asio-1.36.0/doc/asio/reference/MoveAcceptToken.html new file mode 100644 index 0000000..bbc1924 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/MoveAcceptToken.html @@ -0,0 +1,129 @@ + + + +Move accept token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A move accept token is a completion + token for completion signature void(error_code, typename Protocol::socket) + or completion signature void(error_code, typename Protocol::socket::template rebind_executor<Executor>::other), for the type Protocol + of the acceptor class template. +

+
+ + Examples +
+

+ A free function as a move accept token: +

+
void accept_handler(
+    const asio::error_code& ec, asio::ip::tcp::socket s)
+{
+  ...
+}
+
+

+ A move accept token function object: +

+
struct accept_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec, asio::ip::tcp::socket s)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a move accept token: +

+
acceptor.async_accept(...,
+    [](const asio::error_code& ec, asio::ip::tcp::socket s)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a move accept token using + std::bind(): +

+
void my_class::accept_handler(
+    const asio::error_code& ec, asio::ip::tcp::socket socket)
+{
+  ...
+}
+...
+asio::async_accept(...,
+    std::bind(&my_class::accept_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ Using use_future as a move + accept token: +

+
std::future<asio::ip::tcp::socket> f =
+  acceptor.async_accept(..., asio::use_future);
+...
+try
+{
+  asio::ip::tcp::socket s = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a move accept token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    asio::ip::tcp::socket s =
+      co_await acceptor.async_accept(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/MutableBufferSequence.html b/Packages/asio-1.36.0/doc/asio/reference/MutableBufferSequence.html new file mode 100644 index 0000000..b225d48 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/MutableBufferSequence.html @@ -0,0 +1,125 @@ + + + +Mutable buffer sequence requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A mutable buffer sequence represents a set of memory + regions that may be used to receive the output of an operation, such as the + receive operation of a socket. +

+

+ A type X meets the MutableBufferSequence requirements if it + satisfies the requirements of Destructible + (C++Std [destructible]) and CopyConstructible + (C++Std [copyconstructible]), as well as the additional requirements listed + below. +

+

+ In the table below, x denotes + a (possibly const) value of type X, + and u denotes an identifier. +

+
+

Table 25. MutableBufferSequence requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ asio::buffer_sequence_begin(x)
+ asio::buffer_sequence_end(x) +

+ 		+

+ An iterator type meeting the requirements for bidirectional iterators + (C++Std [bidirectional.iterators]) whose value type is convertible + to mutable_buffer. +

+ 		+
+
X u(x);
+
+ 		+ +

+ post:
+

+
equal(
+  asio::buffer_sequence_begin(x),
+  asio::buffer_sequence_end(x),
+  asio::buffer_sequence_begin(u),
+  asio::buffer_sequence_end(u),
+  [](const mutable_buffer& b1,
+     const mutable_buffer& b2)
+   {
+     return b1.data() == b2.data()
+         && b1.size() == b2.size();
+   })
+
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/NullaryToken.html b/Packages/asio-1.36.0/doc/asio/reference/NullaryToken.html new file mode 100644 index 0000000..903400d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/NullaryToken.html @@ -0,0 +1,114 @@ + + + +Nullary token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A nullary token is a completion + token for completion signature void(). +

+
+ + Examples +
+

+ A free function as a nullary token: +

+
void nullary_handler()
+{
+  ...
+}
+
+

+ A nullary token function object: +

+
struct nullary_handler
+{
+  ...
+  void operator()()
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a nullary token: +

+
asio::post(...,
+    []()
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a nullary token using std::bind(): +

+
void my_class::nullary_handler()
+{
+  ...
+}
+...
+asio::post(...,
+    std::bind(&my_class::nullary_handler, this));
+
+

+ A non-static class member function adapted to a nullary token using boost::bind(): +

+
void my_class::nullary_handler()
+{
+  ...
+}
+...
+asio::post(...,
+    boost::bind(&my_class::nullary_handler, this));
+
+

+ Using use_future as a nullary + token: +

+
std::future<void> f = asio::post(..., asio::use_future);
+...
+f.get();
+
+

+ Using use_awaitable as + a nullary token: +

+
asio::awaitable<void> my_coroutine()
+{
+  ...
+  co_await asio::post(..., asio::use_awaitable);
+  ...
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ProtoAllocator.html b/Packages/asio-1.36.0/doc/asio/reference/ProtoAllocator.html new file mode 100644 index 0000000..1b0bfb1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ProtoAllocator.html @@ -0,0 +1,46 @@ + + + +Proto-allocator requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type A meets the proto-allocator + requirements if A is CopyConstructible (C++Std [copyconstructible]), + Destructible (C++Std [destructible]), + and allocator_traits<A>::rebind_alloc<U> meets + the allocator requirements (C++Std [allocator.requirements]), where U is an object type. [Note: + For example, std::allocator<void> meets + the proto-allocator requirements but not the allocator requirements. —end + note] No constructor, comparison operator, copy operation, move + operation, or swap operation on these types shall exit via an exception. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/Protocol.html b/Packages/asio-1.36.0/doc/asio/reference/Protocol.html new file mode 100644 index 0000000..dc74875 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/Protocol.html @@ -0,0 +1,180 @@ + + + +Protocol requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the Protocol requirements if it satisfies the + requirements of Destructible + (C++Std [destructible]), CopyConstructible + (C++Std [copyconstructible]), and CopyAssignable + (C++Std [copyassignable]), as well as the additional requirements listed + below. +

+

+ No copy or move operation of the type X + shall exit via an exception. +

+
+

Table 26. Protocol requirements

+
+++++ + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ X::endpoint +

+ 		+

+ type meeting endpoint + requirements +

+ 		+
+
+

+ In the table below, a denotes + a (possibly const) value of type X. +

+
+

Table 27. Protocol requirements for extensible implementations

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ a.family() +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the domain + argument to POSIX socket() + (or equivalent). +

+
+

+ a.type() +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the type + argument to POSIX socket() + (or equivalent). +

+
+

+ a.protocol() +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the protocol + argument to POSIX socket() + (or equivalent). +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/RangeConnectHandler.html b/Packages/asio-1.36.0/doc/asio/reference/RangeConnectHandler.html new file mode 100644 index 0000000..2c9cb3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/RangeConnectHandler.html @@ -0,0 +1,47 @@ + + + +Range connect handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A range connect handler must meet the requirements for a handler. + A value h of a range connect + handler class should work correctly in the expression h(ec, + ep), + where ec is an lvalue of + type const error_code + and ep is an lvalue of the + type Protocol::endpoint for the Protocol + type in the corresponding async_connect() function. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/RangeConnectToken.html b/Packages/asio-1.36.0/doc/asio/reference/RangeConnectToken.html new file mode 100644 index 0000000..89afecf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/RangeConnectToken.html @@ -0,0 +1,151 @@ + + + +Range connect token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A range connect token is a completion + token for completion signature void(error_code, typename Protocol::endpoint), + where the type Protocol is + used in the corresponding async_connect() function. +

+
+ + Examples +
+

+ A free function as a range connect token: +

+
void connect_handler(
+    const asio::error_code& ec,
+    const asio::ip::tcp::endpoint& endpoint)
+{
+  ...
+}
+
+

+ A range connect token function object: +

+
struct connect_handler
+{
+  ...
+  template <typename Range>
+  void operator()(
+      const asio::error_code& ec,
+      const asio::ip::tcp::endpoint& endpoint)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a range connect token: +

+
asio::async_connect(...,
+    [](const asio::error_code& ec,
+      const asio::ip::tcp::endpoint& endpoint)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a range connect token using + std::bind(): +

+
void my_class::connect_handler(
+    const asio::error_code& ec,
+    const asio::ip::tcp::endpoint& endpoint)
+{
+  ...
+}
+...
+asio::async_connect(...,
+    std::bind(&my_class::connect_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ A non-static class member function adapted to a range connect token using + boost::bind(): +

+
void my_class::connect_handler(
+    const asio::error_code& ec,
+    const asio::ip::tcp::endpoint& endpoint)
+{
+  ...
+}
+...
+asio::async_connect(...,
+    boost::bind(&my_class::connect_handler,
+      this, asio::placeholders::error,
+      asio::placeholders::endpoint));
+
+

+ Using use_future as a range + connect token: +

+
std::future<asio::ip::tcp::endpoint> f =
+  asio::async_connect(..., asio::use_future);
+...
+try
+{
+  asio::ip::tcp::endpoint e = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a range connect token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    asio::ip::tcp::endpoint e =
+      co_await asio::async_connect(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ReadHandler.html b/Packages/asio-1.36.0/doc/asio/reference/ReadHandler.html new file mode 100644 index 0000000..e174c59 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ReadHandler.html @@ -0,0 +1,45 @@ + + + +Read handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A read handler must meet the requirements for a handler. + A value h of a read handler + class should work correctly in the expression h(ec, + s), + where ec is an lvalue of + type const error_code + and s is an lvalue of type + const size_t. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ReadToken.html b/Packages/asio-1.36.0/doc/asio/reference/ReadToken.html new file mode 100644 index 0000000..03a1214 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ReadToken.html @@ -0,0 +1,145 @@ + + + +Read token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A read token is a completion + token for completion signature void(error_code, size_t). +

+
+ + Examples +
+

+ A free function as a read token: +

+
void read_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+
+

+ A read token function object: +

+
struct read_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec,
+      std::size_t bytes_transferred)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a read token: +

+
socket.async_read_some(...,
+    [](const asio::error_code& ec,
+      std::size_t bytes_transferred)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a read token using std::bind(): +

+
void my_class::read_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+...
+socket.async_read_some(...,
+    std::bind(&my_class::read_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ A non-static class member function adapted to a read token using boost::bind(): +

+
void my_class::read_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+...
+socket.async_read_some(...,
+    boost::bind(&my_class::read_handler,
+      this, asio::placeholders::error,
+      asio::placeholders::bytes_transferred));
+
+

+ Using use_future as a read + token: +

+
std::future<std::size_t> f =
+  socket.async_read_some(..., asio::use_future);
+...
+try
+{
+  std::size_t n = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a read token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    std::size_t n =
+      co_await socket.async_read_some(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ResolveHandler.html b/Packages/asio-1.36.0/doc/asio/reference/ResolveHandler.html new file mode 100644 index 0000000..c117943 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ResolveHandler.html @@ -0,0 +1,47 @@ + + + +Resolve handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A resolve handler must meet the requirements for a handler. + A value h of a resolve handler + class should work correctly in the expression h(ec, + r), + where ec is an lvalue of + type const error_code + and r is an lvalue of type + const ip::basic_resolver_results<InternetProtocol>. InternetProtocol + is the template parameter of the ip::basic_resolver<> which is used to initiate + the asynchronous operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ResolveToken.html b/Packages/asio-1.36.0/doc/asio/reference/ResolveToken.html new file mode 100644 index 0000000..5dad2c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ResolveToken.html @@ -0,0 +1,146 @@ + + + +Resolve token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A resolve token is a completion + token for completion signature void(error_code, ip::basic_resolver_results<InternetProtocol>), + for a specified InternetProtocol. +

+
+ + Examples +
+

+ A free function as a resolve token: +

+
void resolve_handler(
+    const asio::error_code& ec,
+    asio::ip::tcp::resolver::results_type results)
+{
+  ...
+}
+
+

+ A resolve token function object: +

+
struct resolve_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec,
+      asio::ip::tcp::resolver::results_type results)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a resolve token: +

+
resolver.async_resolve(...,
+    [](const asio::error_code& ec,
+      asio::ip::tcp::resolver::results_type results)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a resolve token using std::bind(): +

+
void my_class::resolve_handler(
+    const asio::error_code& ec,
+    asio::ip::tcp::resolver::results_type results)
+{
+  ...
+}
+...
+resolver.async_resolve(...,
+    std::bind(&my_class::resolve_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ A non-static class member function adapted to a resolve token using boost::bind(): +

+
void my_class::resolve_handler(
+    const asio::error_code& ec,
+    asio::ip::tcp::resolver::results_type results)
+{
+  ...
+}
+...
+resolver.async_resolve(...,
+    boost::bind(&my_class::resolve_handler,
+      this, asio::placeholders::error,
+      asio::placeholders::results));
+
+

+ Using use_future as a resolve + token: +

+
std::future<asio::ip::tcp::resolver::results_type> f =
+  resolver.async_resolve(..., asio::use_future);
+...
+try
+{
+  asio::ip::tcp::resolver::results_type r = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a resolve token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    asio::ip::tcp::resolver::results_type r =
+      co_await resolver.async_resolve(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/Service.html b/Packages/asio-1.36.0/doc/asio/reference/Service.html new file mode 100644 index 0000000..c95955a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/Service.html @@ -0,0 +1,74 @@ + + + +Service requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A class is a service if it is publicly and unambiguously + derived from execution_context::service, + or if it is publicly and unambiguously derived from another service. For + a service S, S::key_type + shall be valid and denote a type (C++Std [temp.deduct]), is_base_of_v<typename S::key_type, S> + shall be true, and S shall satisfy the Destructible + requirements (C++Std [destructible]). +

+

+ The first parameter of all service constructors shall be an lvalue reference + to execution_context. This + parameter denotes the execution_context + object that represents a set of services, of which the service object will + be a member. [Note: These constructors may be called + by the make_service function. + —end note] +

+

+ A service shall provide an explicit constructor with a single parameter of + lvalue reference to execution_context. + [Note: This constructor may be called by the use_service function. —end note] +

+
class my_service : public execution_context::service
+{
+public:
+  typedef my_service key_type;
+  explicit my_service(execution_context& ctx);
+  my_service(execution_context& ctx, int some_value);
+private:
+  virtual void shutdown() noexcept override;
+  ...
+};
+
+

+ A service's shutdown member + function shall destroy all copies of user-defined function objects that are + held by the service. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SettableSerialPortOption.html b/Packages/asio-1.36.0/doc/asio/reference/SettableSerialPortOption.html new file mode 100644 index 0000000..641d2b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SettableSerialPortOption.html @@ -0,0 +1,96 @@ + + + +Settable serial port option requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In the table below, X denotes + a serial port option class, a + denotes a value of X, ec denotes a value of type error_code, and s + denotes a value of implementation-defined type storage + (where storage is the type DCB on Windows and termios + on POSIX platforms), and u + denotes an identifier. +

+
+

Table 28. SettableSerialPortOption requirements

+
+++++ + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ const X& u + = a;
u.store(s, ec); +

+ 		+

+ error_code +

+ 		+

+ Saves the value of the serial port option to the storage.
+
If successful, sets ec + such that !ec + is true. If an error occurred, sets ec + such that !!ec + is true. Returns ec. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SettableSocketOption.html b/Packages/asio-1.36.0/doc/asio/reference/SettableSocketOption.html new file mode 100644 index 0000000..d02ae49 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SettableSocketOption.html @@ -0,0 +1,153 @@ + + + +Settable socket option requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the SettableSocketOption requirements if it + satisfies the requirements listed below. +

+

+ In the table below, a denotes + a (possibly const) value of type X, + p denotes a (possibly const) + value that meets the Protocol requirements, and u denotes an identifier. +

+
+

Table 29. SettableSocketOption requirements for extensible implementations

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ type +

+ 		+

+ assertion/note
pre/post-conditions +

+
+

+ a.level(p) +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the level + argument to POSIX setsockopt() + (or equivalent). +

+
+

+ a.name(p) +

+ 		+

+ int +

+ 		+

+ Returns a value suitable for passing as the option_name + argument to POSIX setsockopt() + (or equivalent). +

+
+

+ a.data(p) +

+ 		+

+ const void* +

+ 		+

+ Returns a pointer suitable for passing as the option_value + argument to POSIX setsockopt() + (or equivalent). +

+
+

+ a.size(p) +

+ 		+

+ size_t +

+ 		+

+ Returns a value suitable for passing as the option_len + argument to POSIX setsockopt() + (or equivalent), after appropriate integer conversion has been + performed. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ShutdownHandler.html b/Packages/asio-1.36.0/doc/asio/reference/ShutdownHandler.html new file mode 100644 index 0000000..c942dff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ShutdownHandler.html @@ -0,0 +1,43 @@ + + + +SSL shutdown handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A shutdown handler must meet the requirements for a handler. + A value h of a shutdown handler + class should work correctly in the expression h(ec), + where ec is an lvalue of + type const error_code. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ShutdownToken.html b/Packages/asio-1.36.0/doc/asio/reference/ShutdownToken.html new file mode 100644 index 0000000..48489b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ShutdownToken.html @@ -0,0 +1,134 @@ + + + +SSL shutdown token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A shutdown token is a completion + token for completion signature void(error_code). +

+
+ + Examples +
+

+ A free function as a shutdown token: +

+
void shutdown_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+
+

+ A shutdown token function object: +

+
struct shutdown_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a shutdown token: +

+
ssl_stream.async_shutdown(...,
+    [](const asio::error_code& ec)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a shutdown token using std::bind(): +

+
void my_class::shutdown_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+ssl_stream.async_shutdown(...,
+    std::bind(&my_class::shutdown_handler,
+      this, std::placeholders::_1));
+
+

+ A non-static class member function adapted to a shutdown token using boost::bind(): +

+
void my_class::shutdown_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+ssl_stream.async_shutdown(...,
+    boost::bind(&my_class::shutdown_handler,
+      this, asio::placeholders::error));
+
+

+ Using use_future as a shutdown + token: +

+
std::future<void> f = ssl_stream.async_shutdown(..., asio::use_future);
+...
+try
+{
+  f.get();
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a shutdown token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    co_await ssl_stream.async_shutdown(..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SignalHandler.html b/Packages/asio-1.36.0/doc/asio/reference/SignalHandler.html new file mode 100644 index 0000000..613a530 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SignalHandler.html @@ -0,0 +1,45 @@ + + + +Signal handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A signal handler must meet the requirements for a handler. + A value h of a signal handler + class should work correctly in the expression h(ec, + n), + where ec is an lvalue of + type const error_code + and n is an lvalue of type + const int. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SignalToken.html b/Packages/asio-1.36.0/doc/asio/reference/SignalToken.html new file mode 100644 index 0000000..d787e7b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SignalToken.html @@ -0,0 +1,144 @@ + + + +Signal token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A signal token is a completion + token for completion signature void(error_code, int). +

+
+ + Examples +
+

+ A free function as a signal token: +

+
void signal_handler(
+    const asio::error_code& ec,
+    int signal_number)
+{
+  ...
+}
+
+

+ A signal token function object: +

+
struct signal_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec,
+      int signal_number)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a signal token: +

+
signal_set.async_wait(...,
+    [](const asio::error_code& ec,
+      int signal_number)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a signal token using std::bind(): +

+
void my_class::signal_handler(
+    const asio::error_code& ec,
+    int signal_number)
+{
+  ...
+}
+...
+signal_set.async_wait(...,
+    std::bind(&my_class::signal_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ A non-static class member function adapted to a signal token using boost::bind(): +

+
void my_class::signal_handler(
+    const asio::error_code& ec,
+    int signal_number)
+{
+  ...
+}
+...
+signal_set.async_wait(...,
+    boost::bind(&my_class::signal_handler,
+      this, asio::placeholders::error,
+      asio::placeholders::signal_number));
+
+

+ Using use_future as a signal + token: +

+
std::future<int> f = signal_set.async_wait(..., asio::use_future);
+...
+try
+{
+  int signo = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a signal token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    int signo =
+      co_await signal_set.async_wait(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SyncRandomAccessReadDevice.html b/Packages/asio-1.36.0/doc/asio/reference/SyncRandomAccessReadDevice.html new file mode 100644 index 0000000..bc8cec7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SyncRandomAccessReadDevice.html @@ -0,0 +1,129 @@ + + + +Buffer-oriented synchronous random-access read device requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In the table below, a denotes + a synchronous random-access read device object, o + denotes an offset of type boost::uint64_t, + mb denotes an object satisfying + mutable buffer sequence + requirements, and ec denotes + an object of type error_code. +

+
+

Table 30. Buffer-oriented synchronous random-access read device requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.read_some_at(o, + mb); +

+ 		+

+ size_t +

+ 		+

+ Equivalent to: +

+
error_code ec;
+size_t s = a.read_some_at(o, mb, ec);
+if (ec) throw system_error(ec);
+return s;
+
+
+

+ a.read_some_at(o, + mb, + ec); +

+ 		+

+ size_t +

+ 		+

+ Reads one or more bytes of data from the device a + at offset o.
+
The mutable buffer sequence mb + specifies memory where the data should be placed. The read_some_at operation shall + always fill a buffer in the sequence completely before proceeding + to the next.

If successful, returns the number of + bytes read and sets ec + such that !ec + is true. If an error occurred, returns 0 + and sets ec such + that !!ec + is true.

If the total size of all buffers in the sequence + mb is 0, the function shall return 0 immediately. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SyncRandomAccessWriteDevice.html b/Packages/asio-1.36.0/doc/asio/reference/SyncRandomAccessWriteDevice.html new file mode 100644 index 0000000..d39ffbc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SyncRandomAccessWriteDevice.html @@ -0,0 +1,130 @@ + + + +Buffer-oriented synchronous random-access write device requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In the table below, a denotes + a synchronous random-access write device object, o + denotes an offset of type boost::uint64_t, + cb denotes an object satisfying + constant buffer sequence + requirements, and ec denotes + an object of type error_code. +

+
+

Table 31. Buffer-oriented synchronous random-access write device requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.write_some_at(o, + cb); +

+ 		+

+ size_t +

+ 		+

+ Equivalent to: +

+
error_code ec;
+size_t s = a.write_some(o, cb, ec);
+if (ec) throw system_error(ec);
+return s;
+
+
+

+ a.write_some_at(o, + cb, + ec); +

+ 		+

+ size_t +

+ 		+

+ Writes one or more bytes of data to the device a + at offset o.
+
The constant buffer sequence cb + specifies memory where the data to be written is located. The + write_some_at operation + shall always write a buffer in the sequence completely before proceeding + to the next.

If successful, returns the number of + bytes written and sets ec + such that !ec + is true. If an error occurred, returns 0 + and sets ec such + that !!ec + is true.

If the total size of all buffers in the sequence + cb is 0, the function shall return 0 immediately. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SyncReadStream.html b/Packages/asio-1.36.0/doc/asio/reference/SyncReadStream.html new file mode 100644 index 0000000..1ca2b72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SyncReadStream.html @@ -0,0 +1,109 @@ + + + +Buffer-oriented synchronous read stream requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the SyncReadStream requirements if it satisfies + the requirements listed below. +

+

+ In the table below, a denotes + a value of type X, mb denotes a (possibly const) value satisfying + the MutableBufferSequence + requirements, and ec denotes + an object of type error_code. +

+
+

Table 32. SyncReadStream requirements

+
+++++ + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.read_some(mb)
+ a.read_some(mb,ec) +

+ 		+

+ size_t +

+ 		+

+ Meets the requirements for a read + operation.

If buffer_size(mb) > + 0, reads one or more bytes + of data from the stream a + into the buffer sequence mb. + If successful, sets ec + such that !ec + is true, and returns + the number of bytes read. If an error occurred, sets ec such that !!ec is true, + and returns 0. If all data has been read from the stream, and the + stream performed an orderly shutdown, sets ec + to stream_errc::eof + and returns 0.

If buffer_size(mb) == 0, the operation shall not block. + Sets ec such that + !ec + is true, and returns + 0. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/SyncWriteStream.html b/Packages/asio-1.36.0/doc/asio/reference/SyncWriteStream.html new file mode 100644 index 0000000..fb8d977 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/SyncWriteStream.html @@ -0,0 +1,106 @@ + + + +Buffer-oriented synchronous write stream requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A type X meets the SyncWriteStream requirements if it satisfies + the requirements listed below. +

+

+ In the table below, a denotes + a value of type X, cb denotes a (possibly const) value satisfying + the ConstBufferSequence + requirements, and ec denotes + an object of type error_code. +

+
+

Table 33. SyncWriteStream requirements

+
+++++ + + + + + + + + + + +
+

+ operation +

+ 		+

+ type +

+ 		+

+ semantics, pre/post-conditions +

+
+

+ a.write_some(cb)
+ a.write_some(cb,ec) +

+ 		+

+ size_t +

+ 		+

+ Meets the requirements for a write + operation.

If buffer_size(cb) > + 0, writes one or more bytes + of data to the stream a + from the buffer sequence cb. + If successful, sets ec + such that !ec + is true, and returns + the number of bytes written. If an error occurred, sets ec such that !!ec is true, + and returns 0.

If buffer_size(cb) == 0, the operation shall not block. + Sets ec such that + !ec + is true, and returns + 0. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/TimeTraits.html b/Packages/asio-1.36.0/doc/asio/reference/TimeTraits.html new file mode 100644 index 0000000..333e57c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/TimeTraits.html @@ -0,0 +1,201 @@ + + + +Time traits requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In the table below, X denotes + a time traits class for time type Time, + t, t1, + and t2 denote values of type + Time, and d + denotes a value of type X::duration_type. +

+
+

Table 34. TimeTraits requirements

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ X::time_type +

+ 		+

+ Time +

+ 		+

+ Represents an absolute time. Must support default construction, + and meet the requirements for CopyConstructible + and Assignable. +

+
+

+ X::duration_type +

+ 		+ +

+ Represents the difference between two absolute times. Must support + default construction, and meet the requirements for CopyConstructible and Assignable. A duration can be + positive, negative, or zero. +

+
+

+ X::now(); +

+ 		+

+ time_type +

+ 		+

+ Returns the current time. +

+
+

+ X::add(t, + d); +

+ 		+

+ time_type +

+ 		+

+ Returns a new absolute time resulting from adding the duration + d to the absolute + time t. +

+
+

+ X::subtract(t1, + t2); +

+ 		+

+ duration_type +

+ 		+

+ Returns the duration resulting from subtracting t2 + from t1. +

+
+

+ X::less_than(t1, + t2); +

+ 		+

+ bool +

+ 		+

+ Returns whether t1 + is to be treated as less than t2. +

+
+

+ X::to_posix_duration(d); +

+ 		+

+ date_time::time_duration_type +

+ 		+

+ Returns the date_time::time_duration_type + value that most closely represents the duration d. +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/WaitHandler.html b/Packages/asio-1.36.0/doc/asio/reference/WaitHandler.html new file mode 100644 index 0000000..6f1f1dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/WaitHandler.html @@ -0,0 +1,42 @@ + + + +Wait handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A wait handler must meet the requirements for a handler. + A value h of a wait handler + class should work correctly in the expression h(ec), + where ec is an lvalue of + type const error_code. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/WaitToken.html b/Packages/asio-1.36.0/doc/asio/reference/WaitToken.html new file mode 100644 index 0000000..3d1b9ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/WaitToken.html @@ -0,0 +1,134 @@ + + + +Wait token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A wait token is a completion + token for completion signature void(error_code). +

+
+ + Examples +
+

+ A free function as a wait token: +

+
void wait_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+
+

+ A wait token function object: +

+
struct wait_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a wait token: +

+
socket.async_wait(...,
+    [](const asio::error_code& ec)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a wait token using std::bind(): +

+
void my_class::wait_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+socket.async_wait(...,
+    std::bind(&my_class::wait_handler,
+      this, std::placeholders::_1));
+
+

+ A non-static class member function adapted to a wait token using boost::bind(): +

+
void my_class::wait_handler(
+    const asio::error_code& ec)
+{
+  ...
+}
+...
+socket.async_wait(...,
+    boost::bind(&my_class::wait_handler,
+      this, asio::placeholders::error));
+
+

+ Using use_future as a wait + token: +

+
std::future<void> f = socket.async_wait(..., asio::use_future);
+...
+try
+{
+  f.get();
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a wait token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    co_await socket.async_wait(..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/WaitTraits.html b/Packages/asio-1.36.0/doc/asio/reference/WaitTraits.html new file mode 100644 index 0000000..aee7cbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/WaitTraits.html @@ -0,0 +1,137 @@ + + + +Wait traits requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The basic_waitable_timer + template uses wait traits to allow programs to customize wait + and async_wait behavior. + [Note: Possible uses of wait traits include:
— To + enable timers based on non-realtime clocks.
— Determining how quickly + wallclock-based timers respond to system time changes.
— Correcting for + errors or rounding timeouts to boundaries.
— Preventing duration overflow. + That is, a program may set a timer's expiry e + to be Clock::max() (meaning + never reached) or Clock::min() (meaning + always in the past). As a result, computing the duration until timer expiry + as e - + Clock::now() may + cause overflow. —end note] +

+

+ For a type Clock meeting + the Clock requirements (C++Std + [time.clock.req]), a type X + meets the WaitTraits requirements + if it satisfies the requirements listed below. +

+

+ In the table below, t denotes + a (possibly const) value of type Clock::time_point; + and d denotes a (possibly + const) value of type Clock::duration. +

+
+

Table 35. WaitTraits requirements

+
+++++ + + + + + + + + + + + + + + + + + +
+

+ expression +

+ 		+

+ return type +

+ 		+

+ assertion/note
pre/post-condition +

+
+

+ X::to_wait_duration(d) +

+ 		+

+ Clock::duration +

+ 		+

+ Returns a Clock::duration + value to be used in a wait + or async_wait operation. + [Note: The return value is typically representative + of the duration d. + —end note] +

+
+

+ X::to_wait_duration(t) +

+ 		+

+ Clock::duration +

+ 		+

+ Returns a Clock::duration + value to be used in a wait + or async_wait operation. + [Note: The return value is typically representative + of the duration from Clock::now() until the time point t. —end note] +

+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/WriteHandler.html b/Packages/asio-1.36.0/doc/asio/reference/WriteHandler.html new file mode 100644 index 0000000..153f550 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/WriteHandler.html @@ -0,0 +1,45 @@ + + + +Write handler requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A write handler must meet the requirements for a handler. + A value h of a write handler + class should work correctly in the expression h(ec, + s), + where ec is an lvalue of + type const error_code + and s is an lvalue of type + const size_t. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/WriteToken.html b/Packages/asio-1.36.0/doc/asio/reference/WriteToken.html new file mode 100644 index 0000000..734c532 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/WriteToken.html @@ -0,0 +1,145 @@ + + + +Write token requirements + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A write token is a completion + token for completion signature void(error_code, size_t). +

+
+ + Examples +
+

+ A free function as a write token: +

+
void write_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+
+

+ A write token function object: +

+
struct write_handler
+{
+  ...
+  void operator()(
+      const asio::error_code& ec,
+      std::size_t bytes_transferred)
+  {
+    ...
+  }
+  ...
+};
+
+

+ A lambda as a write token: +

+
socket.async_write_some(...,
+    [](const asio::error_code& ec,
+      std::size_t bytes_transferred)
+    {
+      ...
+    });
+
+

+ A non-static class member function adapted to a write token using std::bind(): +

+
void my_class::write_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+...
+socket.async_write_some(...,
+    std::bind(&my_class::write_handler,
+      this, std::placeholders::_1,
+      std::placeholders::_2));
+
+

+ A non-static class member function adapted to a write token using boost::bind(): +

+
void my_class::write_handler(
+    const asio::error_code& ec,
+    std::size_t bytes_transferred)
+{
+  ...
+}
+...
+socket.async_write_some(...,
+    boost::bind(&my_class::write_handler,
+      this, asio::placeholders::error,
+      asio::placeholders::bytes_transferred));
+
+

+ Using use_future as a write + token: +

+
std::future<std::size_t> f =
+  socket.async_write_some(..., asio::use_future);
+...
+try
+{
+  std::size_t n = f.get();
+  ...
+}
+catch (const system_error& e)
+{
+  ...
+}
+
+

+ Using use_awaitable as + a write token: +

+
asio::awaitable<void> my_coroutine()
+{
+  try
+  {
+    ...
+    std::size_t n =
+      co_await socket.async_write_some(
+          ..., asio::use_awaitable);
+    ...
+  }
+  catch (const system_error& e)
+  {
+    ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder.html new file mode 100644 index 0000000..99bfe24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder.html @@ -0,0 +1,247 @@ + + + +allocator_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A call wrapper type to bind an allocator of type Allocator + to an object of type T. +

+
template<
+    typename T,
+    typename Allocator>
+class allocator_binder
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The type of the associated allocator. +

+
+

+ argument_type +

+ 		+

+ The type of the function's argument. +

+
+

+ first_argument_type +

+ 		+

+ The type of the function's first argument. +

+
+

+ result_type +

+ 		+

+ The return type if a function. +

+
+

+ second_argument_type +

+ 		+

+ The type of the function's second argument. +

+
+

+ target_type +

+ 		+

+ The type of the target object. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_binder [constructor] +

+ 		+

+ Construct an allocator wrapper for the specified object.
+ —
Copy constructor.
—
Construct a copy, but specify + a different allocator.
—
Construct a copy of a different + allocator wrapper type.
—
Construct a copy of a different + allocator wrapper type, but specify a different allocator.
+ —
Move constructor.
—
Move construct the target + object, but specify a different allocator.
—
Move construct + from a different allocator wrapper type.
—
Move construct + from a different allocator wrapper type, but specify a different + allocator. +

+
+

+ get +

+ 		+

+ Obtain a reference to the target object. +

+
+

+ get_allocator +

+ 		+

+ Obtain the associated allocator. +

+
+

+ operator() +

+ 		+

+ Forwarding function call operator. +

+
+

+ ~allocator_binder [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/_allocator_binder.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/_allocator_binder.html new file mode 100644 index 0000000..cd48bf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/_allocator_binder.html @@ -0,0 +1,41 @@ + + + +allocator_binder::~allocator_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~allocator_binder();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder.html new file mode 100644 index 0000000..c085e9f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder.html @@ -0,0 +1,127 @@ + + + +allocator_binder::allocator_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an allocator wrapper for the specified object. +

+
template<
+    typename U>
+allocator_binder(
+    const allocator_type & s,
+    U && u);
+  » more...
+
+

+ Copy constructor. +

+
allocator_binder(
+    const allocator_binder & other);
+  » more...
+
+

+ Construct a copy, but specify a different allocator. +

+
allocator_binder(
+    const allocator_type & s,
+    const allocator_binder & other);
+  » more...
+
+

+ Construct a copy of a different allocator wrapper type. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    const allocator_binder< U, OtherAllocator > & other,
+    constraint_t< is_constructible< Allocator, OtherAllocator >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Construct a copy of a different allocator wrapper type, but specify a different + allocator. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    const allocator_type & s,
+    const allocator_binder< U, OtherAllocator > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move constructor. +

+
allocator_binder(
+    allocator_binder && other);
+  » more...
+
+

+ Move construct the target object, but specify a different allocator. +

+
allocator_binder(
+    const allocator_type & s,
+    allocator_binder && other);
+  » more...
+
+

+ Move construct from a different allocator wrapper type. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    allocator_binder< U, OtherAllocator > && other,
+    constraint_t< is_constructible< Allocator, OtherAllocator >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move construct from a different allocator wrapper type, but specify a different + allocator. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    const allocator_type & s,
+    allocator_binder< U, OtherAllocator > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload1.html new file mode 100644 index 0000000..9149c07 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload1.html @@ -0,0 +1,49 @@ + + + +allocator_binder::allocator_binder (1 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an allocator wrapper for the specified object. +

+
template<
+    typename U>
+allocator_binder(
+    const allocator_type & s,
+    U && u);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload2.html new file mode 100644 index 0000000..90b25e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload2.html @@ -0,0 +1,42 @@ + + + +allocator_binder::allocator_binder (2 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
allocator_binder(
+    const allocator_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload3.html new file mode 100644 index 0000000..3f85e01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload3.html @@ -0,0 +1,43 @@ + + + +allocator_binder::allocator_binder (3 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy, but specify a different allocator. +

+
allocator_binder(
+    const allocator_type & s,
+    const allocator_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload4.html new file mode 100644 index 0000000..b901e89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload4.html @@ -0,0 +1,53 @@ + + + +allocator_binder::allocator_binder (4 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different allocator wrapper type. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    const allocator_binder< U, OtherAllocator > & other,
+    constraint_t< is_constructible< Allocator, OtherAllocator >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the Allocator + type is constructible from type OtherAllocator, + and the type T is constructible + from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload5.html new file mode 100644 index 0000000..3d451b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload5.html @@ -0,0 +1,52 @@ + + + +allocator_binder::allocator_binder (5 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different allocator wrapper type, but specify a + different allocator. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    const allocator_type & s,
+    const allocator_binder< U, OtherAllocator > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload6.html new file mode 100644 index 0000000..20d0da9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload6.html @@ -0,0 +1,42 @@ + + + +allocator_binder::allocator_binder (6 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
allocator_binder(
+    allocator_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload7.html new file mode 100644 index 0000000..070404c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload7.html @@ -0,0 +1,43 @@ + + + +allocator_binder::allocator_binder (7 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct the target object, but specify a different allocator. +

+
allocator_binder(
+    const allocator_type & s,
+    allocator_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload8.html new file mode 100644 index 0000000..abdc588 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload8.html @@ -0,0 +1,47 @@ + + + +allocator_binder::allocator_binder (8 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different allocator wrapper type. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    allocator_binder< U, OtherAllocator > && other,
+    constraint_t< is_constructible< Allocator, OtherAllocator >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload9.html new file mode 100644 index 0000000..c84298b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_binder/overload9.html @@ -0,0 +1,48 @@ + + + +allocator_binder::allocator_binder (9 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different allocator wrapper type, but specify a + different allocator. +

+
template<
+    typename U,
+    typename OtherAllocator>
+allocator_binder(
+    const allocator_type & s,
+    allocator_binder< U, OtherAllocator > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_type.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_type.html new file mode 100644 index 0000000..ebd6c5f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/allocator_type.html @@ -0,0 +1,52 @@ + + + +allocator_binder::allocator_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the associated allocator. +

+
typedef Allocator allocator_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/argument_type.html new file mode 100644 index 0000000..9a5b77d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/argument_type.html @@ -0,0 +1,74 @@ + + + +allocator_binder::argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's argument. +

+
typedef see_below argument_type;
+
+

+ The type of argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting a single argument, argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type argument_type, + then argument_type + is a synonym for T::argument_type; +
    • +
  • + otherwise argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/first_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/first_argument_type.html new file mode 100644 index 0000000..5613512 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/first_argument_type.html @@ -0,0 +1,74 @@ + + + +allocator_binder::first_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's first argument. +

+
typedef see_below first_argument_type;
+
+

+ The type of first_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, first_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then first_argument_type + is a synonym for T::first_argument_type; +
    • +
  • + otherwise first_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get.html new file mode 100644 index 0000000..72c6404 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get.html @@ -0,0 +1,46 @@ + + + +allocator_binder::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain a reference + to the target object. +

+
target_type & get();
+  » more...
+
+const target_type & get() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get/overload1.html new file mode 100644 index 0000000..48e234a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get/overload1.html @@ -0,0 +1,41 @@ + + + +allocator_binder::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
target_type & get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get/overload2.html new file mode 100644 index 0000000..cc4c063 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get/overload2.html @@ -0,0 +1,41 @@ + + + +allocator_binder::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
const target_type & get() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get_allocator.html new file mode 100644 index 0000000..6d03271 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/get_allocator.html @@ -0,0 +1,42 @@ + + + +allocator_binder::get_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the associated allocator. +

+
allocator_type get_allocator() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_.html new file mode 100644 index 0000000..f589471 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_.html @@ -0,0 +1,58 @@ + + + +allocator_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwarding + function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..bf7b9af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +allocator_binder::operator() (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..6912cb9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload2.html @@ -0,0 +1,44 @@ + + + +allocator_binder::operator() (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload3.html new file mode 100644 index 0000000..d202867 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/operator_lp__rp_/overload3.html @@ -0,0 +1,44 @@ + + + +allocator_binder::operator() (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/result_type.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/result_type.html new file mode 100644 index 0000000..7ef0bae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/result_type.html @@ -0,0 +1,74 @@ + + + +allocator_binder::result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + return type if a function. +

+
typedef see_below result_type;
+
+

+ The type of result_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + function type, result_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type result_type, + then result_type is + a synonym for T::result_type; +
    • +
  • + otherwise result_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/second_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/second_argument_type.html new file mode 100644 index 0000000..469c3fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/second_argument_type.html @@ -0,0 +1,74 @@ + + + +allocator_binder::second_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's second argument. +

+
typedef see_below second_argument_type;
+
+

+ The type of second_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, second_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then second_argument_type + is a synonym for T::second_argument_type; +
    • +
  • + otherwise second_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/target_type.html new file mode 100644 index 0000000..e6e519b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/allocator_binder/target_type.html @@ -0,0 +1,52 @@ + + + +allocator_binder::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the target object. +

+
typedef T target_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor.html new file mode 100644 index 0000000..90815a5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor.html @@ -0,0 +1,292 @@ + + + +any_completion_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Polymorphic executor type for use with I/O objects. +

+
class any_completion_executor :
+  public execution::any_executor<... >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ any_completion_executor [constructor] +

+ 		+

+ Default constructor.
—
Construct in an empty state. + Equivalent effects to default constructor.
—
Copy constructor. +
—
Move constructor.
—
Construct to point + to the same target as another any_executor.
—
Construct + a polymorphic wrapper for the specified executor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ execute +

+ 		+

+ Execute the function on the target executor. +

+
+

+ operator bool +

+ 		+

+ Determine whether the wrapper has a target executor. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator.
+ —
Assignment operator that sets the polymorphic wrapper to + the empty state. +

+
+

+ prefer +

+ 		+

+ Obtain a polymorphic wrapper with the specified property.
+ —
+

+
+

+ query +

+ 		+

+ Obtain the value associated with the specified property. +

+
+

+ require +

+ 		+

+ Obtain a polymorphic wrapper with the specified property. +

+
+

+ swap +

+ 		+

+ Swap targets with another polymorphic wrapper. +

+
+

+ target +

+ 		+

+ Get a pointer to the target executor. +

+
+

+ target_type +

+ 		+

+ Get the type of the target executor. +

+
+

+ ~any_completion_executor [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+

+ The any_completion_executor + type is a polymorphic executor that supports the set of properties required + for the execution of completion handlers. It is defined as the execution::any_executor class template parameterised + as follows: +

+
execution::any_executor<
+  execution::prefer_only<execution::outstanding_work_t::tracked_t>,
+  execution::prefer_only<execution::outstanding_work_t::untracked_t>
+  execution::prefer_only<execution::relationship_t::fork_t>,
+  execution::prefer_only<execution::relationship_t::continuation_t>
+>
+
+
+ + Requirements +
+

+ Header: asio/any_completion_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/_any_completion_executor.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/_any_completion_executor.html new file mode 100644 index 0000000..b63facc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/_any_completion_executor.html @@ -0,0 +1,41 @@ + + + +any_completion_executor::~any_completion_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~any_completion_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor.html new file mode 100644 index 0000000..4210302 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor.html @@ -0,0 +1,106 @@ + + + +any_completion_executor::any_completion_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
any_completion_executor();
+  » more...
+
+

+ Construct in an empty state. Equivalent effects to default constructor. +

+
any_completion_executor(
+    nullptr_t );
+  » more...
+
+

+ Copy constructor. +

+
any_completion_executor(
+    const any_completion_executor & e);
+  » more...
+
+

+ Move constructor. +

+
any_completion_executor(
+    any_completion_executor && e);
+  » more...
+
+

+ Construct to point to the same target as another any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_completion_executor(
+    execution::any_executor< OtherSupportableProperties... > e);
+  » more...
+
+template<
+    class... OtherSupportableProperties>
+any_completion_executor(
+    std::nothrow_t ,
+    execution::any_executor< OtherSupportableProperties... > e);
+  » more...
+
+any_completion_executor(
+    std::nothrow_t ,
+    const any_completion_executor & e);
+  » more...
+
+any_completion_executor(
+    std::nothrow_t ,
+    any_completion_executor && e);
+  » more...
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_completion_executor(
+    Executor e);
+  » more...
+
+template<
+    typename Executor>
+any_completion_executor(
+    std::nothrow_t ,
+    Executor e);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload1.html new file mode 100644 index 0000000..6ac5ad1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload1.html @@ -0,0 +1,41 @@ + + + +any_completion_executor::any_completion_executor (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
any_completion_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload10.html new file mode 100644 index 0000000..08699bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload10.html @@ -0,0 +1,45 @@ + + + +any_completion_executor::any_completion_executor (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_completion_executor(
+    std::nothrow_t ,
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload2.html new file mode 100644 index 0000000..dd25071 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload2.html @@ -0,0 +1,42 @@ + + + +any_completion_executor::any_completion_executor (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct in an empty state. Equivalent effects to default constructor. +

+
any_completion_executor(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload3.html new file mode 100644 index 0000000..715db52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload3.html @@ -0,0 +1,42 @@ + + + +any_completion_executor::any_completion_executor (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
any_completion_executor(
+    const any_completion_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload4.html new file mode 100644 index 0000000..667391b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload4.html @@ -0,0 +1,42 @@ + + + +any_completion_executor::any_completion_executor (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
any_completion_executor(
+    any_completion_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload5.html new file mode 100644 index 0000000..cbadc32 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload5.html @@ -0,0 +1,44 @@ + + + +any_completion_executor::any_completion_executor (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_completion_executor(
+    execution::any_executor< OtherSupportableProperties... > e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload6.html new file mode 100644 index 0000000..153ac54 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload6.html @@ -0,0 +1,45 @@ + + + +any_completion_executor::any_completion_executor (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_completion_executor(
+    std::nothrow_t ,
+    execution::any_executor< OtherSupportableProperties... > e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload7.html new file mode 100644 index 0000000..248e1ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload7.html @@ -0,0 +1,43 @@ + + + +any_completion_executor::any_completion_executor (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
any_completion_executor(
+    std::nothrow_t ,
+    const any_completion_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload8.html new file mode 100644 index 0000000..195f20f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload8.html @@ -0,0 +1,43 @@ + + + +any_completion_executor::any_completion_executor (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
any_completion_executor(
+    std::nothrow_t ,
+    any_completion_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload9.html new file mode 100644 index 0000000..c6f70f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/any_completion_executor/overload9.html @@ -0,0 +1,44 @@ + + + +any_completion_executor::any_completion_executor (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_completion_executor(
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/context.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/context.html new file mode 100644 index 0000000..4db2607 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/context.html @@ -0,0 +1,50 @@ + + + +any_completion_executor::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Obtain + the underlying execution context. +

+
automatically_determined context() const;
+
+

+ This function is provided for backward compatibility. It is automatically + defined when the SupportableProperties... + list includes a property of type execution::context_as<U>, for some type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/execute.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/execute.html new file mode 100644 index 0000000..1c7503b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/execute.html @@ -0,0 +1,52 @@ + + + +any_completion_executor::execute + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Execute + the function on the target executor. +

+
template<
+    typename Function>
+void execute(
+    Function && f) const;
+
+

+ Throws bad_executor + if the polymorphic wrapper has no target. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_bool.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_bool.html new file mode 100644 index 0000000..a20eb6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_bool.html @@ -0,0 +1,55 @@ + + + +any_completion_executor::operator bool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Determine + whether the wrapper has a target executor. +

+
operator bool() const;
+
+
+ + Return + Value +
+

+ true if the polymorphic wrapper + has a target executor, otherwise false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_.html new file mode 100644 index 0000000..c016411 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_.html @@ -0,0 +1,58 @@ + + + +any_completion_executor::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment + operator. +

+
any_completion_executor & operator=(
+    const any_completion_executor & e);
+  » more...
+
+

+ Move assignment operator. +

+
any_completion_executor & operator=(
+    any_completion_executor && e);
+  » more...
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_completion_executor & operator=(
+    nullptr_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload1.html new file mode 100644 index 0000000..44ea420 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +any_completion_executor::operator= (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
any_completion_executor & operator=(
+    const any_completion_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload2.html new file mode 100644 index 0000000..9acc21b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +any_completion_executor::operator= (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
any_completion_executor & operator=(
+    any_completion_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload3.html new file mode 100644 index 0000000..ee25f8e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq_/overload3.html @@ -0,0 +1,42 @@ + + + +any_completion_executor::operator= (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_completion_executor & operator=(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_.html new file mode 100644 index 0000000..5d08dae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_.html @@ -0,0 +1,55 @@ + + + +any_completion_executor::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. +

+
bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+  » more...
+
+bool operator==(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload1.html new file mode 100644 index 0000000..2c9fda0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload1.html @@ -0,0 +1,48 @@ + + + +any_completion_executor::operator== (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload2.html new file mode 100644 index 0000000..ca2f133 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload2.html @@ -0,0 +1,48 @@ + + + +any_completion_executor::operator== (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload3.html new file mode 100644 index 0000000..cf13313 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_eq__eq_/overload3.html @@ -0,0 +1,48 @@ + + + +any_completion_executor::operator== (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_.html new file mode 100644 index 0000000..33ee2c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_.html @@ -0,0 +1,55 @@ + + + +any_completion_executor::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. +

+
bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+  » more...
+
+bool operator!=(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload1.html new file mode 100644 index 0000000..508591f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload1.html @@ -0,0 +1,48 @@ + + + +any_completion_executor::operator!= (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload2.html new file mode 100644 index 0000000..e8300d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload2.html @@ -0,0 +1,48 @@ + + + +any_completion_executor::operator!= (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload3.html new file mode 100644 index 0000000..b667f2f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/operator_not__eq_/overload3.html @@ -0,0 +1,48 @@ + + + +any_completion_executor::operator!= (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer.html new file mode 100644 index 0000000..beb0a02 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer.html @@ -0,0 +1,77 @@ + + + +any_completion_executor::prefer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_completion_executor prefer(
+    const Property & p,
+    constraint_t< traits::prefer_member< const base_type &, const Property & >::is_valid >  = 0) const;
+  » more...
+
+
+
+template<>
+any_completion_executor prefer(
+    const execution::outstanding_work_t::tracked_t & p,
+    int ) const;
+  » more...
+
+template<>
+any_completion_executor prefer(
+    const execution::outstanding_work_t::untracked_t & p,
+    int ) const;
+  » more...
+
+template<>
+any_completion_executor prefer(
+    const execution::relationship_t::fork_t & p,
+    int ) const;
+  » more...
+
+template<>
+any_completion_executor prefer(
+    const execution::relationship_t::continuation_t & p,
+    int ) const;
+  » more...
+
+any_executor prefer(
+    Property ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload1.html new file mode 100644 index 0000000..4077c53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload1.html @@ -0,0 +1,56 @@ + + + +any_completion_executor::prefer (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_completion_executor prefer(
+    const Property & p,
+    constraint_t< traits::prefer_member< const base_type &, const Property & >::is_valid >  = 0) const;
+
+

+ Do not call this function directly. It is intended for use with the + prefer + customisation point. +

+

+ For example: +

+
any_completion_executor ex = ...;
+auto ex2 = asio::prefer(ex, execution::relationship.fork);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload2.html new file mode 100644 index 0000000..45090cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload2.html @@ -0,0 +1,41 @@ + + + +any_completion_executor::prefer (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_completion_executor prefer(
+    const execution::outstanding_work_t::tracked_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload3.html new file mode 100644 index 0000000..3bc0fe3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload3.html @@ -0,0 +1,41 @@ + + + +any_completion_executor::prefer (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_completion_executor prefer(
+    const execution::outstanding_work_t::untracked_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload4.html new file mode 100644 index 0000000..098f762 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload4.html @@ -0,0 +1,41 @@ + + + +any_completion_executor::prefer (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_completion_executor prefer(
+    const execution::relationship_t::fork_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload5.html new file mode 100644 index 0000000..efc5bbb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload5.html @@ -0,0 +1,41 @@ + + + +any_completion_executor::prefer (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_completion_executor prefer(
+    const execution::relationship_t::continuation_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload6.html new file mode 100644 index 0000000..a785e31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/prefer/overload6.html @@ -0,0 +1,58 @@ + + + +any_completion_executor::prefer (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_executor prefer(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the + prefer + customisation point. +

+

+ For example: +

+
execution::any_executor<execution::blocking_t::possibly_t> ex = ...;
+auto ex2 = asio::prefer(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/query.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/query.html new file mode 100644 index 0000000..6e0455a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/query.html @@ -0,0 +1,58 @@ + + + +any_completion_executor::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Obtain + the value associated with the specified property. +

+
template<
+    typename Property>
+Property::polymorphic_query_result_type query(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the query + customisation point. +

+

+ For example: +

+
execution::any_executor<execution::occupancy_t> ex = ...;
+size_t n = asio::query(ex, execution::occupancy);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require.html new file mode 100644 index 0000000..c322afe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require.html @@ -0,0 +1,51 @@ + + + +any_completion_executor::require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_completion_executor require(
+    const Property & p,
+    constraint_t< traits::require_member< const base_type &, const Property & >::is_valid >  = 0) const;
+  » more...
+
+any_executor require(
+    Property ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require/overload1.html new file mode 100644 index 0000000..e02bf06 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require/overload1.html @@ -0,0 +1,57 @@ + + + +any_completion_executor::require (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_completion_executor require(
+    const Property & p,
+    constraint_t< traits::require_member< const base_type &, const Property & >::is_valid >  = 0) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + and prefer + customisation points. +

+

+ For example: +

+
any_completion_executor ex = ...;
+auto ex2 = asio::require(ex, execution::relationship.fork);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require/overload2.html new file mode 100644 index 0000000..8373a6c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/require/overload2.html @@ -0,0 +1,59 @@ + + + +any_completion_executor::require (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_executor require(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + and prefer + customisation points. +

+

+ For example: +

+
execution::any_executor<execution::blocking_t::possibly_t> ex = ...;
+auto ex2 = asio::require(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap.html new file mode 100644 index 0000000..db68c7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap.html @@ -0,0 +1,48 @@ + + + +any_completion_executor::swap + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Swap + targets with another polymorphic wrapper. +

+
void swap(
+    any_completion_executor & other);
+  » more...
+
+void swap(
+    any_executor & other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap/overload1.html new file mode 100644 index 0000000..04c77e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap/overload1.html @@ -0,0 +1,42 @@ + + + +any_completion_executor::swap (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Swap targets with another polymorphic wrapper. +

+
void swap(
+    any_completion_executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap/overload2.html new file mode 100644 index 0000000..836b46c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/swap/overload2.html @@ -0,0 +1,45 @@ + + + +any_completion_executor::swap (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Swap targets with another polymorphic wrapper. +

+
void swap(
+    any_executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target.html new file mode 100644 index 0000000..7e62f86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target.html @@ -0,0 +1,46 @@ + + + +any_completion_executor::target + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a pointer to the target executor. +

+
Executor * target();
+  » more...
+
+const Executor * target() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target/overload1.html new file mode 100644 index 0000000..d7f0eac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target/overload1.html @@ -0,0 +1,46 @@ + + + +any_completion_executor::target (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Get a pointer to the target executor. +

+
template<
+    typename Executor>
+Executor * target();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target/overload2.html new file mode 100644 index 0000000..9efa255 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target/overload2.html @@ -0,0 +1,46 @@ + + + +any_completion_executor::target (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Get a pointer to the target executor. +

+
template<
+    typename Executor>
+const Executor * target() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target_type.html new file mode 100644 index 0000000..77bf6bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_executor/target_type.html @@ -0,0 +1,45 @@ + + + +any_completion_executor::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Get + the type of the target executor. +

+
const type_info & target_type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler.html new file mode 100644 index 0000000..79a108d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler.html @@ -0,0 +1,313 @@ + + + +any_completion_handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Polymorphic wrapper for completion handlers. +

+
template<
+    typename... Signatures>
+class any_completion_handler
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The associated allocator type. +

+
+

+ cancellation_slot_type +

+ 		+

+ The associated cancellation slot type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ any_completion_handler [constructor] +

+ 		+

+ Construct an any_completion_handler in an empty state, without + a target object.
—
Construct an any_completion_handler + to contain the specified target.
—
Move-construct an + any_completion_handler from another. +

+
+

+ get_allocator +

+ 		+

+ Get the associated allocator. +

+
+

+ get_cancellation_slot +

+ 		+

+ Get the associated cancellation slot. +

+
+

+ operator bool +

+ 		+

+ Test if the polymorphic wrapper is empty. +

+
+

+ operator! +

+ 		+

+ Test if the polymorphic wrapper is non-empty. +

+
+

+ operator() +

+ 		+

+ Function call operator. +

+
+

+ operator= +

+ 		+

+ Move-assign an any_completion_handler from another.
—
+ Assignment operator that sets the polymorphic wrapper to the empty + state. +

+
+

+ swap +

+ 		+

+ Swap the content of an any_completion_handler with another. +

+
+

+ ~any_completion_handler [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+

+ The any_completion_handler + class template is a polymorphic wrapper for completion handlers that propagates + the associated executor, associated allocator, and associated cancellation + slot through a type-erasing interface. +

+

+ When using any_completion_handler, + specify one or more completion signatures as template parameters. These will + dictate the arguments that may be passed to the handler through the polymorphic + interface. +

+

+ Typical uses for any_completion_handler + include: +

+
    +
  • + Separate compilation of asynchronous operation implementations. +
    • +
  • + Enabling interoperability between asynchronous operations and virtual + functions. +
    • +
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/_any_completion_handler.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/_any_completion_handler.html new file mode 100644 index 0000000..d335f1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/_any_completion_handler.html @@ -0,0 +1,41 @@ + + + +any_completion_handler::~any_completion_handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~any_completion_handler();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/allocator_type.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/allocator_type.html new file mode 100644 index 0000000..efd9b47 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/allocator_type.html @@ -0,0 +1,172 @@ + + + +any_completion_handler::allocator_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + associated allocator type. +

+
typedef any_completion_handler_allocator< void, Signatures... > allocator_type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value_type +

+ 		+

+ The type of objects that may be allocated by the allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate space for n objects of the allocator's value type. +

+
+

+ any_completion_handler_allocator + [constructor] +

+ 		+

+ Construct from another any_completion_handler_allocator. +

+
+

+ deallocate +

+ 		+

+ Deallocate space for n objects of the allocator's value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler.html new file mode 100644 index 0000000..6871268 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler.html @@ -0,0 +1,68 @@ + + + +any_completion_handler::any_completion_handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an any_completion_handler + in an empty state, without a target object. +

+
constexpr any_completion_handler();
+  » more...
+
+constexpr any_completion_handler(
+    nullptr_t );
+  » more...
+
+

+ Construct an any_completion_handler + to contain the specified target. +

+
template<
+    typename H,
+    typename Handler = decay_t<H>>
+any_completion_handler(
+    H && h,
+    constraint_t< !is_same< decay_t< H >, any_completion_handler >::value >  = 0);
+  » more...
+
+

+ Move-construct an any_completion_handler + from another. +

+
any_completion_handler(
+    any_completion_handler && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload1.html new file mode 100644 index 0000000..1259f72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload1.html @@ -0,0 +1,42 @@ + + + +any_completion_handler::any_completion_handler (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an any_completion_handler + in an empty state, without a target object. +

+
constexpr any_completion_handler();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload2.html new file mode 100644 index 0000000..6dee137 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload2.html @@ -0,0 +1,43 @@ + + + +any_completion_handler::any_completion_handler (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an any_completion_handler + in an empty state, without a target object. +

+
constexpr any_completion_handler(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload3.html new file mode 100644 index 0000000..b54fa2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload3.html @@ -0,0 +1,47 @@ + + + +any_completion_handler::any_completion_handler (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an any_completion_handler + to contain the specified target. +

+
template<
+    typename H,
+    typename Handler = decay_t<H>>
+any_completion_handler(
+    H && h,
+    constraint_t< !is_same< decay_t< H >, any_completion_handler >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload4.html new file mode 100644 index 0000000..838d598 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/any_completion_handler/overload4.html @@ -0,0 +1,47 @@ + + + +any_completion_handler::any_completion_handler (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct an any_completion_handler + from another. +

+
any_completion_handler(
+    any_completion_handler && other);
+
+

+ After the operation, the moved-from object other + has no target. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/cancellation_slot_type.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/cancellation_slot_type.html new file mode 100644 index 0000000..cfdd152 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/cancellation_slot_type.html @@ -0,0 +1,198 @@ + + + +any_completion_handler::cancellation_slot_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + associated cancellation slot type. +

+
typedef cancellation_slot cancellation_slot_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Installs a handler into the slot. +

+
+

+ cancellation_slot [constructor] +

+ 		+

+ Creates a slot that is not connected to any cancellation signal. +

+
+

+ clear +

+ 		+

+ Clears the slot. +

+
+

+ emplace +

+ 		+

+ Installs a handler into the slot, constructing the new object + directly. +

+
+

+ has_handler +

+ 		+

+ Returns whether the slot is connected and has an installed handler. +

+
+

+ is_connected +

+ 		+

+ Returns whether the slot is connected to a signal. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two slots for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two slots for equality. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/get_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/get_allocator.html new file mode 100644 index 0000000..2395e14 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/get_allocator.html @@ -0,0 +1,42 @@ + + + +any_completion_handler::get_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the associated allocator. +

+
allocator_type get_allocator() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/get_cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/get_cancellation_slot.html new file mode 100644 index 0000000..e09a223 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/get_cancellation_slot.html @@ -0,0 +1,42 @@ + + + +any_completion_handler::get_cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the associated cancellation slot. +

+
cancellation_slot_type get_cancellation_slot() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_bool.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_bool.html new file mode 100644 index 0000000..3d384a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_bool.html @@ -0,0 +1,43 @@ + + + +any_completion_handler::operator bool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + if the polymorphic wrapper is empty. +

+
constexpr operator bool() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_.html new file mode 100644 index 0000000..fd22a9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_.html @@ -0,0 +1,52 @@ + + + +any_completion_handler::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + an any_completion_handler + from another. +

+
any_completion_handler & operator=(
+    any_completion_handler && other);
+  » more...
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_completion_handler & operator=(
+    nullptr_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_/overload1.html new file mode 100644 index 0000000..5310ca3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_/overload1.html @@ -0,0 +1,47 @@ + + + +any_completion_handler::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign an any_completion_handler + from another. +

+
any_completion_handler & operator=(
+    any_completion_handler && other);
+
+

+ After the operation, the moved-from object other + has no target. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_/overload2.html new file mode 100644 index 0000000..eb300ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +any_completion_handler::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_completion_handler & operator=(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_.html new file mode 100644 index 0000000..9dd51da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_.html @@ -0,0 +1,50 @@ + + + +any_completion_handler::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. +

+
constexpr bool operator==(
+    const any_completion_handler & a,
+    nullptr_t );
+  » more...
+
+constexpr bool operator==(
+    nullptr_t ,
+    const any_completion_handler & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_/overload1.html new file mode 100644 index 0000000..b82e38f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_/overload1.html @@ -0,0 +1,53 @@ + + + +any_completion_handler::operator== (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator. +

+
constexpr bool operator==(
+    const any_completion_handler & a,
+    nullptr_t );
+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_/overload2.html new file mode 100644 index 0000000..5cddec3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_eq__eq_/overload2.html @@ -0,0 +1,53 @@ + + + +any_completion_handler::operator== (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator. +

+
constexpr bool operator==(
+    nullptr_t ,
+    const any_completion_handler & b);
+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_lp__rp_.html new file mode 100644 index 0000000..20f839d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_lp__rp_.html @@ -0,0 +1,56 @@ + + + +any_completion_handler::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + call operator. +

+
template<
+    typename... Args>
+auto operator()(
+    Args &&... args);
+
+

+ Invokes target completion handler with the supplied arguments. +

+

+ This function may only be called once, as the target handler is moved from. + The polymorphic wrapper is left in an empty state. +

+

+ Throws std::bad_function_call if the polymorphic + wrapper is empty. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not_.html new file mode 100644 index 0000000..48ae26d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not_.html @@ -0,0 +1,42 @@ + + + +any_completion_handler::operator! + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + if the polymorphic wrapper is non-empty. +

+
constexpr bool operator!() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_.html new file mode 100644 index 0000000..572e03f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_.html @@ -0,0 +1,50 @@ + + + +any_completion_handler::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. +

+
constexpr bool operator!=(
+    const any_completion_handler & a,
+    nullptr_t );
+  » more...
+
+constexpr bool operator!=(
+    nullptr_t ,
+    const any_completion_handler & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_/overload1.html new file mode 100644 index 0000000..7d3ed9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_/overload1.html @@ -0,0 +1,53 @@ + + + +any_completion_handler::operator!= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator. +

+
constexpr bool operator!=(
+    const any_completion_handler & a,
+    nullptr_t );
+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_/overload2.html new file mode 100644 index 0000000..c8fc08f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/operator_not__eq_/overload2.html @@ -0,0 +1,53 @@ + + + +any_completion_handler::operator!= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator. +

+
constexpr bool operator!=(
+    nullptr_t ,
+    const any_completion_handler & b);
+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/swap.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/swap.html new file mode 100644 index 0000000..3d9d092 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler/swap.html @@ -0,0 +1,44 @@ + + + +any_completion_handler::swap + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Swap + the content of an any_completion_handler + with another. +

+
void swap(
+    any_completion_handler & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator.html new file mode 100644 index 0000000..c9c28d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator.html @@ -0,0 +1,177 @@ + + + +any_completion_handler_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An allocator type that forwards memory allocation operations through an instance + of any_completion_handler. +

+
template<
+    typename T,
+    typename... Signatures>
+class any_completion_handler_allocator
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value_type +

+ 		+

+ The type of objects that may be allocated by the allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate space for n objects of the allocator's value type. +

+
+

+ any_completion_handler_allocator + [constructor] +

+ 		+

+ Construct from another any_completion_handler_allocator. +

+
+

+ deallocate +

+ 		+

+ Deallocate space for n objects of the allocator's value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/allocate.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/allocate.html new file mode 100644 index 0000000..7eb5579 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/allocate.html @@ -0,0 +1,44 @@ + + + +any_completion_handler_allocator::allocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Allocate + space for n objects of + the allocator's value type. +

+
T * allocate(
+    std::size_t n) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/any_completion_handler_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/any_completion_handler_allocator.html new file mode 100644 index 0000000..9cf53cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/any_completion_handler_allocator.html @@ -0,0 +1,45 @@ + + + +any_completion_handler_allocator::any_completion_handler_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + from another any_completion_handler_allocator. +

+
template<
+    typename U>
+constexpr any_completion_handler_allocator(
+    const any_completion_handler_allocator< U, Signatures... > & a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/deallocate.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/deallocate.html new file mode 100644 index 0000000..bfa83ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/deallocate.html @@ -0,0 +1,45 @@ + + + +any_completion_handler_allocator::deallocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Deallocate + space for n objects of + the allocator's value type. +

+
void deallocate(
+    T * p,
+    std::size_t n) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/operator_eq__eq_.html new file mode 100644 index 0000000..c9a60f8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/operator_eq__eq_.html @@ -0,0 +1,43 @@ + + + +any_completion_handler_allocator::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. +

+
constexpr bool operator==(
+    const any_completion_handler_allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/operator_not__eq_.html new file mode 100644 index 0000000..163c6b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/operator_not__eq_.html @@ -0,0 +1,43 @@ + + + +any_completion_handler_allocator::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. +

+
constexpr bool operator!=(
+    const any_completion_handler_allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/value_type.html new file mode 100644 index 0000000..bb00f1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator/value_type.html @@ -0,0 +1,52 @@ + + + +any_completion_handler_allocator::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of objects that may be allocated by the allocator. +

+
typedef T value_type;
+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator__rebind.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator__rebind.html new file mode 100644 index 0000000..9c5d7d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator__rebind.html @@ -0,0 +1,89 @@ + + + +any_completion_handler_allocator::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds an allocator to another value type. +

+
template<
+    typename U>
+struct rebind
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ Specifies the type of the rebound allocator. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator__rebind/other.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator__rebind/other.html new file mode 100644 index 0000000..4c75fd0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator__rebind/other.html @@ -0,0 +1,172 @@ + + + +any_completion_handler_allocator::rebind::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specifies + the type of the rebound allocator. +

+
typedef any_completion_handler_allocator< U, Signatures... > other;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value_type +

+ 		+

+ The type of objects that may be allocated by the allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate space for n objects of the allocator's value type. +

+
+

+ any_completion_handler_allocator + [constructor] +

+ 		+

+ Construct from another any_completion_handler_allocator. +

+
+

+ deallocate +

+ 		+

+ Deallocate space for n objects of the allocator's value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_.html new file mode 100644 index 0000000..e772d1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_.html @@ -0,0 +1,152 @@ + + + +any_completion_handler_allocator< void, Signatures... > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A protoco-allocator type that may be rebound to obtain an allocator that + forwards memory allocation operations through an instance of any_completion_handler. +

+
template<
+    typename... Signatures>
+class any_completion_handler_allocator< void, Signatures... >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value_type +

+ 		+

+ void as no objects can be allocated through a proto-allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ any_completion_handler_allocator +

+ 		+

+ Construct from another any_completion_handler_allocator. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/any_completion_handler_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/any_completion_handler_allocator.html new file mode 100644 index 0000000..e507dc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/any_completion_handler_allocator.html @@ -0,0 +1,45 @@ + + + +any_completion_handler_allocator< void, Signatures... >::any_completion_handler_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct from another any_completion_handler_allocator. +

+
template<
+    typename U>
+constexpr any_completion_handler_allocator(
+    const any_completion_handler_allocator< U, Signatures... > & a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/operator_eq__eq_.html new file mode 100644 index 0000000..e2df1c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/operator_eq__eq_.html @@ -0,0 +1,43 @@ + + + +any_completion_handler_allocator< void, Signatures... >::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality operator. +

+
constexpr bool operator==(
+    const any_completion_handler_allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/operator_not__eq_.html new file mode 100644 index 0000000..d3d2423 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/operator_not__eq_.html @@ -0,0 +1,43 @@ + + + +any_completion_handler_allocator< void, Signatures... >::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality operator. +

+
constexpr bool operator!=(
+    const any_completion_handler_allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/value_type.html new file mode 100644 index 0000000..2beff71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt_/value_type.html @@ -0,0 +1,53 @@ + + + +any_completion_handler_allocator< void, Signatures... >::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +void + as no objects can be allocated through a proto-allocator. +

+
typedef void value_type;
+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt___rebind.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt___rebind.html new file mode 100644 index 0000000..51fadb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt___rebind.html @@ -0,0 +1,90 @@ + + + +any_completion_handler_allocator< void, Signatures... >::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds an allocator to another value type. +

+
template<
+    typename U>
+struct any_completion_handler_allocator< void, Signatures... >::rebind
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ Specifies the type of the rebound allocator. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt___rebind/other.html b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt___rebind/other.html new file mode 100644 index 0000000..5232578 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_completion_handler_allocator_lt__void_comma__Signatures_ellipsis___gt___rebind/other.html @@ -0,0 +1,172 @@ + + + +any_completion_handler_allocator< void, Signatures... >::rebind::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specifies the type of the rebound allocator. +

+
typedef any_completion_handler_allocator< U, Signatures... > other;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value_type +

+ 		+

+ The type of objects that may be allocated by the allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate space for n objects of the allocator's value type. +

+
+

+ any_completion_handler_allocator + [constructor] +

+ 		+

+ Construct from another any_completion_handler_allocator. +

+
+

+ deallocate +

+ 		+

+ Deallocate space for n objects of the allocator's value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/any_completion_handler.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor.html new file mode 100644 index 0000000..5506f24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor.html @@ -0,0 +1,295 @@ + + + +any_io_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Polymorphic executor type for use with I/O objects. +

+
class any_io_executor :
+  public execution::any_executor<... >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ any_io_executor [constructor] +

+ 		+

+ Default constructor.
—
Construct in an empty state. + Equivalent effects to default constructor.
—
Copy constructor. +
—
Move constructor.
—
Construct to point + to the same target as another any_executor.
—
Construct + a polymorphic wrapper for the specified executor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ execute +

+ 		+

+ Execute the function on the target executor. +

+
+

+ operator bool +

+ 		+

+ Determine whether the wrapper has a target executor. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator.
+ —
Assignment operator that sets the polymorphic wrapper to + the empty state. +

+
+

+ prefer +

+ 		+

+ Obtain a polymorphic wrapper with the specified property. +

+
+

+ query +

+ 		+

+ Obtain the value associated with the specified property. +

+
+

+ require +

+ 		+

+ Obtain a polymorphic wrapper with the specified property.
+ —
+

+
+

+ swap +

+ 		+

+ Swap targets with another polymorphic wrapper. +

+
+

+ target +

+ 		+

+ Get a pointer to the target executor. +

+
+

+ target_type +

+ 		+

+ Get the type of the target executor. +

+
+

+ ~any_io_executor [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+

+ The any_io_executor type + is a polymorphic executor that supports the set of properties required by + I/O objects. It is defined as the execution::any_executor class template parameterised + as follows: +

+
execution::any_executor<
+  execution::context_as_t<execution_context&>,
+  execution::blocking_t::never_t,
+  execution::prefer_only<execution::blocking_t::possibly_t>,
+  execution::prefer_only<execution::outstanding_work_t::tracked_t>,
+  execution::prefer_only<execution::outstanding_work_t::untracked_t>,
+  execution::prefer_only<execution::relationship_t::fork_t>,
+  execution::prefer_only<execution::relationship_t::continuation_t>
+>
+
+
+ + Requirements +
+

+ Header: asio/any_io_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/_any_io_executor.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/_any_io_executor.html new file mode 100644 index 0000000..91c61fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/_any_io_executor.html @@ -0,0 +1,41 @@ + + + +any_io_executor::~any_io_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~any_io_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor.html new file mode 100644 index 0000000..d087129 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor.html @@ -0,0 +1,106 @@ + + + +any_io_executor::any_io_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
any_io_executor();
+  » more...
+
+

+ Construct in an empty state. Equivalent effects to default constructor. +

+
any_io_executor(
+    nullptr_t );
+  » more...
+
+

+ Copy constructor. +

+
any_io_executor(
+    const any_io_executor & e);
+  » more...
+
+

+ Move constructor. +

+
any_io_executor(
+    any_io_executor && e);
+  » more...
+
+

+ Construct to point to the same target as another any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_io_executor(
+    execution::any_executor< OtherSupportableProperties... > e);
+  » more...
+
+template<
+    class... OtherSupportableProperties>
+any_io_executor(
+    std::nothrow_t ,
+    execution::any_executor< OtherSupportableProperties... > e);
+  » more...
+
+any_io_executor(
+    std::nothrow_t ,
+    const any_io_executor & e);
+  » more...
+
+any_io_executor(
+    std::nothrow_t ,
+    any_io_executor && e);
+  » more...
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_io_executor(
+    Executor e);
+  » more...
+
+template<
+    typename Executor>
+any_io_executor(
+    std::nothrow_t ,
+    Executor e);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload1.html new file mode 100644 index 0000000..0479f5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload1.html @@ -0,0 +1,41 @@ + + + +any_io_executor::any_io_executor (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
any_io_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload10.html new file mode 100644 index 0000000..3d7fa60 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload10.html @@ -0,0 +1,45 @@ + + + +any_io_executor::any_io_executor (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_io_executor(
+    std::nothrow_t ,
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload2.html new file mode 100644 index 0000000..fcac6c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload2.html @@ -0,0 +1,42 @@ + + + +any_io_executor::any_io_executor (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct in an empty state. Equivalent effects to default constructor. +

+
any_io_executor(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload3.html new file mode 100644 index 0000000..76981ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload3.html @@ -0,0 +1,42 @@ + + + +any_io_executor::any_io_executor (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
any_io_executor(
+    const any_io_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload4.html new file mode 100644 index 0000000..3635ba8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload4.html @@ -0,0 +1,42 @@ + + + +any_io_executor::any_io_executor (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
any_io_executor(
+    any_io_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload5.html new file mode 100644 index 0000000..d073d78 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload5.html @@ -0,0 +1,44 @@ + + + +any_io_executor::any_io_executor (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_io_executor(
+    execution::any_executor< OtherSupportableProperties... > e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload6.html new file mode 100644 index 0000000..6453f17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload6.html @@ -0,0 +1,45 @@ + + + +any_io_executor::any_io_executor (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_io_executor(
+    std::nothrow_t ,
+    execution::any_executor< OtherSupportableProperties... > e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload7.html new file mode 100644 index 0000000..45f5c9c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload7.html @@ -0,0 +1,43 @@ + + + +any_io_executor::any_io_executor (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
any_io_executor(
+    std::nothrow_t ,
+    const any_io_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload8.html new file mode 100644 index 0000000..aa0e49c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload8.html @@ -0,0 +1,43 @@ + + + +any_io_executor::any_io_executor (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another any_executor. +

+
any_io_executor(
+    std::nothrow_t ,
+    any_io_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload9.html new file mode 100644 index 0000000..8d5b414 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/any_io_executor/overload9.html @@ -0,0 +1,44 @@ + + + +any_io_executor::any_io_executor (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_io_executor(
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/context.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/context.html new file mode 100644 index 0000000..f3fe0f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/context.html @@ -0,0 +1,50 @@ + + + +any_io_executor::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Obtain the + underlying execution context. +

+
automatically_determined context() const;
+
+

+ This function is provided for backward compatibility. It is automatically + defined when the SupportableProperties... + list includes a property of type execution::context_as<U>, for some type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/execute.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/execute.html new file mode 100644 index 0000000..fd557e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/execute.html @@ -0,0 +1,52 @@ + + + +any_io_executor::execute + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Execute the + function on the target executor. +

+
template<
+    typename Function>
+void execute(
+    Function && f) const;
+
+

+ Throws bad_executor + if the polymorphic wrapper has no target. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_bool.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_bool.html new file mode 100644 index 0000000..2a3b118 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_bool.html @@ -0,0 +1,55 @@ + + + +any_io_executor::operator bool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Determine + whether the wrapper has a target executor. +

+
operator bool() const;
+
+
+ + Return + Value +
+

+ true if the polymorphic wrapper + has a target executor, otherwise false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_.html new file mode 100644 index 0000000..79619aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_.html @@ -0,0 +1,58 @@ + + + +any_io_executor::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment + operator. +

+
any_io_executor & operator=(
+    const any_io_executor & e);
+  » more...
+
+

+ Move assignment operator. +

+
any_io_executor & operator=(
+    any_io_executor && e);
+  » more...
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_io_executor & operator=(
+    nullptr_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload1.html new file mode 100644 index 0000000..9aa1bc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +any_io_executor::operator= (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
any_io_executor & operator=(
+    const any_io_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload2.html new file mode 100644 index 0000000..cb65b98 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +any_io_executor::operator= (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
any_io_executor & operator=(
+    any_io_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload3.html new file mode 100644 index 0000000..06a6ace --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq_/overload3.html @@ -0,0 +1,42 @@ + + + +any_io_executor::operator= (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_io_executor & operator=(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_.html new file mode 100644 index 0000000..34d0174 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_.html @@ -0,0 +1,55 @@ + + + +any_io_executor::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. +

+
bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+  » more...
+
+bool operator==(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload1.html new file mode 100644 index 0000000..d443fce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload1.html @@ -0,0 +1,48 @@ + + + +any_io_executor::operator== (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload2.html new file mode 100644 index 0000000..b229dfd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload2.html @@ -0,0 +1,48 @@ + + + +any_io_executor::operator== (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload3.html new file mode 100644 index 0000000..d335de0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_eq__eq_/overload3.html @@ -0,0 +1,48 @@ + + + +any_io_executor::operator== (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_.html new file mode 100644 index 0000000..5c89b0c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_.html @@ -0,0 +1,55 @@ + + + +any_io_executor::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. +

+
bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+  » more...
+
+bool operator!=(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload1.html new file mode 100644 index 0000000..989bc4f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload1.html @@ -0,0 +1,48 @@ + + + +any_io_executor::operator!= (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload2.html new file mode 100644 index 0000000..5b044e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload2.html @@ -0,0 +1,48 @@ + + + +any_io_executor::operator!= (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload3.html new file mode 100644 index 0000000..540359e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/operator_not__eq_/overload3.html @@ -0,0 +1,48 @@ + + + +any_io_executor::operator!= (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer.html new file mode 100644 index 0000000..2deb940 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer.html @@ -0,0 +1,81 @@ + + + +any_io_executor::prefer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain a polymorphic + wrapper with the specified property. +

+
template<
+    typename Property>
+any_io_executor prefer(
+    const Property & p,
+    constraint_t< traits::prefer_member< const base_type &, const Property & >::is_valid >  = 0) const;
+  » more...
+
+template<>
+any_io_executor prefer(
+    const execution::blocking_t::possibly_t & p,
+    int ) const;
+  » more...
+
+template<>
+any_io_executor prefer(
+    const execution::outstanding_work_t::tracked_t & p,
+    int ) const;
+  » more...
+
+template<>
+any_io_executor prefer(
+    const execution::outstanding_work_t::untracked_t & p,
+    int ) const;
+  » more...
+
+template<>
+any_io_executor prefer(
+    const execution::relationship_t::fork_t & p,
+    int ) const;
+  » more...
+
+template<>
+any_io_executor prefer(
+    const execution::relationship_t::continuation_t & p,
+    int ) const;
+  » more...
+
+any_executor prefer(
+    Property ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload1.html new file mode 100644 index 0000000..d418a62 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload1.html @@ -0,0 +1,56 @@ + + + +any_io_executor::prefer (1 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_io_executor prefer(
+    const Property & p,
+    constraint_t< traits::prefer_member< const base_type &, const Property & >::is_valid >  = 0) const;
+
+

+ Do not call this function directly. It is intended for use with the + prefer + customisation point. +

+

+ For example: +

+
any_io_executor ex = ...;
+auto ex2 = asio::prefer(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload2.html new file mode 100644 index 0000000..0bab85a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload2.html @@ -0,0 +1,41 @@ + + + +any_io_executor::prefer (2 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_io_executor prefer(
+    const execution::blocking_t::possibly_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload3.html new file mode 100644 index 0000000..b60aec2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload3.html @@ -0,0 +1,41 @@ + + + +any_io_executor::prefer (3 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_io_executor prefer(
+    const execution::outstanding_work_t::tracked_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload4.html new file mode 100644 index 0000000..ed75b0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload4.html @@ -0,0 +1,41 @@ + + + +any_io_executor::prefer (4 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_io_executor prefer(
+    const execution::outstanding_work_t::untracked_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload5.html new file mode 100644 index 0000000..704f1e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload5.html @@ -0,0 +1,41 @@ + + + +any_io_executor::prefer (5 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_io_executor prefer(
+    const execution::relationship_t::fork_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload6.html new file mode 100644 index 0000000..98fe95c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload6.html @@ -0,0 +1,41 @@ + + + +any_io_executor::prefer (6 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_io_executor prefer(
+    const execution::relationship_t::continuation_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload7.html new file mode 100644 index 0000000..68380c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/prefer/overload7.html @@ -0,0 +1,58 @@ + + + +any_io_executor::prefer (7 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_executor prefer(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the + prefer + customisation point. +

+

+ For example: +

+
execution::any_executor<execution::blocking_t::possibly_t> ex = ...;
+auto ex2 = asio::prefer(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/query.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/query.html new file mode 100644 index 0000000..2f7477c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/query.html @@ -0,0 +1,58 @@ + + + +any_io_executor::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Obtain the value + associated with the specified property. +

+
template<
+    typename Property>
+Property::polymorphic_query_result_type query(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the query + customisation point. +

+

+ For example: +

+
execution::any_executor<execution::occupancy_t> ex = ...;
+size_t n = asio::query(ex, execution::occupancy);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require.html new file mode 100644 index 0000000..0c5994e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require.html @@ -0,0 +1,59 @@ + + + +any_io_executor::require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain a polymorphic + wrapper with the specified property. +

+
template<
+    typename Property>
+any_io_executor require(
+    const Property & p,
+    constraint_t< traits::require_member< const base_type &, const Property & >::is_valid >  = 0) const;
+  » more...
+
+
+
+template<>
+any_io_executor require(
+    const execution::blocking_t::never_t & p,
+    int ) const;
+  » more...
+
+any_executor require(
+    Property ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload1.html new file mode 100644 index 0000000..22df13a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload1.html @@ -0,0 +1,57 @@ + + + +any_io_executor::require (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_io_executor require(
+    const Property & p,
+    constraint_t< traits::require_member< const base_type &, const Property & >::is_valid >  = 0) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + and prefer + customisation points. +

+

+ For example: +

+
any_io_executor ex = ...;
+auto ex2 = asio::require(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload2.html new file mode 100644 index 0000000..8c56446 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload2.html @@ -0,0 +1,41 @@ + + + +any_io_executor::require (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<>
+any_io_executor require(
+    const execution::blocking_t::never_t & p,
+    int ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload3.html new file mode 100644 index 0000000..739bb79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/require/overload3.html @@ -0,0 +1,59 @@ + + + +any_io_executor::require (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Obtain a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_executor require(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + and prefer + customisation points. +

+

+ For example: +

+
execution::any_executor<execution::blocking_t::possibly_t> ex = ...;
+auto ex2 = asio::require(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap.html new file mode 100644 index 0000000..4c9c46e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap.html @@ -0,0 +1,48 @@ + + + +any_io_executor::swap + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Swap targets with + another polymorphic wrapper. +

+
void swap(
+    any_io_executor & other);
+  » more...
+
+void swap(
+    any_executor & other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap/overload1.html new file mode 100644 index 0000000..5b02c6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap/overload1.html @@ -0,0 +1,42 @@ + + + +any_io_executor::swap (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Swap targets with another polymorphic wrapper. +

+
void swap(
+    any_io_executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap/overload2.html new file mode 100644 index 0000000..a6410d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/swap/overload2.html @@ -0,0 +1,45 @@ + + + +any_io_executor::swap (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Swap targets with another polymorphic wrapper. +

+
void swap(
+    any_executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target.html new file mode 100644 index 0000000..b01df80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target.html @@ -0,0 +1,46 @@ + + + +any_io_executor::target + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a pointer + to the target executor. +

+
Executor * target();
+  » more...
+
+const Executor * target() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target/overload1.html new file mode 100644 index 0000000..6530870 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target/overload1.html @@ -0,0 +1,46 @@ + + + +any_io_executor::target (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Get a pointer to the target executor. +

+
template<
+    typename Executor>
+Executor * target();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target/overload2.html new file mode 100644 index 0000000..ab17c98 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target/overload2.html @@ -0,0 +1,46 @@ + + + +any_io_executor::target (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ Get a pointer to the target executor. +

+
template<
+    typename Executor>
+const Executor * target() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target_type.html new file mode 100644 index 0000000..153f4fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/any_io_executor/target_type.html @@ -0,0 +1,45 @@ + + + +any_io_executor::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution::any_executor. +

+

+ +Get + the type of the target executor. +

+
const type_info & target_type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/append.html b/Packages/asio-1.36.0/doc/asio/reference/append.html new file mode 100644 index 0000000..ab25650 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/append.html @@ -0,0 +1,59 @@ + + + +append + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+append +

+

+ +

+

+ Completion token type used to specify that the completion handler arguments + should be passed additional values after the results of the operation. +

+
template<
+    typename CompletionToken,
+    typename... Values>
+constexpr append_t< decay_t< CompletionToken >, decay_t< Values >... > append(
+    CompletionToken && completion_token,
+    Values &&... values);
+
+
+ + Requirements +
+

+ Header: asio/append.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/append_t.html b/Packages/asio-1.36.0/doc/asio/reference/append_t.html new file mode 100644 index 0000000..20104ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/append_t.html @@ -0,0 +1,136 @@ + + + +append_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Completion token type used to specify that the completion handler arguments + should be passed additional values after the results of the operation. +

+
template<
+    typename CompletionToken,
+    typename... Values>
+class append_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append_t + [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ token_ +

+ 		+
+

+ values_ +

+ 		+
+
+ + Requirements +
+

+ Header: asio/append.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/append_t/append_t.html b/Packages/asio-1.36.0/doc/asio/reference/append_t/append_t.html new file mode 100644 index 0000000..f04bdef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/append_t/append_t.html @@ -0,0 +1,46 @@ + + + +append_t::append_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T,
+    typename... V>
+constexpr append_t(
+    T && completion_token,
+    V &&... values);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/append_t/token_.html b/Packages/asio-1.36.0/doc/asio/reference/append_t/token_.html new file mode 100644 index 0000000..5526044 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/append_t/token_.html @@ -0,0 +1,40 @@ + + + +append_t::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/append_t/values_.html b/Packages/asio-1.36.0/doc/asio/reference/append_t/values_.html new file mode 100644 index 0000000..90f3869 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/append_t/values_.html @@ -0,0 +1,40 @@ + + + +append_t::values_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::tuple< Values... > values_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple.html new file mode 100644 index 0000000..4ca6e32 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple.html @@ -0,0 +1,59 @@ + + + +as_tuple + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object that adapts a completion + token to specify that the completion handler arguments should be combined + into a single tuple argument. +

+
constexpr partial_as_tuple as_tuple;
+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/as_tuple.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t.html new file mode 100644 index 0000000..750a3c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t.html @@ -0,0 +1,209 @@ + + + +as_tuple_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + adapter used to specify that the completion handler arguments should be combined + into a single tuple argument. +

+
template<
+    typename CompletionToken>
+class as_tuple_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use as_tuple_t as its default + completion token type. +

+
+

+ default_constructor_tag +

+ 		+

+ Tag type used to prevent the "default" constructor from + being used for conversions. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the as_tuple_t completion token as the + default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use as_tuple_t as its + default completion token type. +

+
+

+ as_tuple_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ token_ +

+ 		+
+

+ The as_tuple_t + class is used to indicate that any arguments to the completion handler should + be combined and passed as a single tuple argument. The arguments are first + moved into a std::tuple and that tuple is then passed to + the completion handler. +

+
+ + Requirements +
+

+ Header: asio/as_tuple.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_default_on.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_default_on.html new file mode 100644 index 0000000..d79a40a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_default_on.html @@ -0,0 +1,46 @@ + + + +as_tuple_t::as_default_on + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + helper to adapt an I/O object to use as_tuple_t + as its default completion token type. +

+
template<
+    typename T>
+static decay_t< T >::template rebind_executor< executor_with_default< typenamedecay_t< T >::executor_type > >::other as_default_on(
+    T && object);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_default_on_t.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_default_on_t.html new file mode 100644 index 0000000..0e09a2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_default_on_t.html @@ -0,0 +1,122 @@ + + + +as_tuple_t::as_default_on_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + alias to adapt an I/O object to use as_tuple_t + as its default completion token type. +

+
typedef typename T::template rebind_executor< executor_with_default< typename T::executor_type > >::other as_default_on_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify as_tuple_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/as_tuple.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t.html new file mode 100644 index 0000000..a54e84e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t.html @@ -0,0 +1,53 @@ + + + +as_tuple_t::as_tuple_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
constexpr as_tuple_t(
+    default_constructor_tag  = default_constructor_tag(),
+    CompletionToken token = CompletionToken());
+  » more...
+
+

+ Constructor. +

+
template<
+    typename T>
+explicit constexpr as_tuple_t(
+    T && completion_token);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t/overload1.html new file mode 100644 index 0000000..91ab4b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t/overload1.html @@ -0,0 +1,49 @@ + + + +as_tuple_t::as_tuple_t (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr as_tuple_t(
+    default_constructor_tag  = default_constructor_tag(),
+    CompletionToken token = CompletionToken());
+
+

+ This constructor is only valid if the underlying completion token is + default constructible and move constructible. The underlying completion + token is itself defaulted as an argument to allow it to capture a source + location. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t/overload2.html new file mode 100644 index 0000000..103152c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/as_tuple_t/overload2.html @@ -0,0 +1,44 @@ + + + +as_tuple_t::as_tuple_t (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename T>
+constexpr as_tuple_t(
+    T && completion_token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/token_.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/token_.html new file mode 100644 index 0000000..354c6e7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t/token_.html @@ -0,0 +1,40 @@ + + + +as_tuple_t::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__default_constructor_tag.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__default_constructor_tag.html new file mode 100644 index 0000000..6442698 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__default_constructor_tag.html @@ -0,0 +1,54 @@ + + + +as_tuple_t::default_constructor_tag + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Tag type used to prevent the "default" constructor from being used + for conversions. +

+
struct default_constructor_tag
+
+
+ + Requirements +
+

+ Header: asio/as_tuple.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default.html new file mode 100644 index 0000000..05d3672 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default.html @@ -0,0 +1,126 @@ + + + +as_tuple_t::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts an executor to add the as_tuple_t + completion token as the default. +

+
template<
+    typename InnerExecutor>
+struct executor_with_default :
+  public InnerExecutor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify as_tuple_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/as_tuple.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default/default_completion_token_type.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default/default_completion_token_type.html new file mode 100644 index 0000000..19ece58 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default/default_completion_token_type.html @@ -0,0 +1,205 @@ + + + +as_tuple_t::executor_with_default::default_completion_token_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + as_tuple_t as the default + completion token type. +

+
typedef as_tuple_t default_completion_token_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use as_tuple_t as its default + completion token type. +

+
+

+ default_constructor_tag +

+ 		+

+ Tag type used to prevent the "default" constructor + from being used for conversions. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the as_tuple_t completion token as + the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use as_tuple_t as its + default completion token type. +

+
+

+ as_tuple_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ token_ +

+ 		+
+

+ The as_tuple_t + class is used to indicate that any arguments to the completion handler + should be combined and passed as a single tuple argument. The arguments + are first moved into a std::tuple + and that tuple is then passed to the completion handler. +

+
+ + Requirements +
+

+ Header: asio/as_tuple.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default/executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default/executor_with_default.html new file mode 100644 index 0000000..d074bb0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/as_tuple_t__executor_with_default/executor_with_default.html @@ -0,0 +1,46 @@ + + + +as_tuple_t::executor_with_default::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + the adapted executor from the inner executor type. +

+
template<
+    typename InnerExecutor1>
+executor_with_default(
+    const InnerExecutor1 & ex,
+    constraint_t< conditional_t< !is_same< InnerExecutor1, executor_with_default >::value, is_convertible< InnerExecutor1, InnerExecutor >, false_type >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/asio_handler_is_continuation.html b/Packages/asio-1.36.0/doc/asio/reference/asio_handler_is_continuation.html new file mode 100644 index 0000000..c2e2325 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/asio_handler_is_continuation.html @@ -0,0 +1,77 @@ + + + +asio_handler_is_continuation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Default continuation function for handlers. +

+
bool asio_handler_is_continuation(
+    ... );
+
+

+ Asynchronous operations may represent a continuation of the asynchronous + control flow associated with the current handler. The implementation can + use this knowledge to optimise scheduling of the handler. +

+

+ Implement asio_handler_is_continuation for your own handlers to indicate + when a handler represents a continuation. +

+

+ The default implementation of the continuation hook returns false. +

+
+ + Example +
+
class my_handler;
+
+bool asio_handler_is_continuation(my_handler* context)
+{
+  return true;
+}
+
+
+ + Requirements +
+

+ Header: asio/handler_continuation_hook.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator.html new file mode 100644 index 0000000..4b24156 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator.html @@ -0,0 +1,155 @@ + + + +associated_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Traits type used to obtain the allocator associated with an object. +

+
template<
+    typename T,
+    typename Allocator = std::allocator<void>>
+struct associated_allocator
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type allocator_type, T::allocator_type. Otherwise + Allocator. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type allocator_type, returns t.get_allocator(). + Otherwise returns type().
—
If T has a nested type + allocator_type, returns t.get_allocator(). Otherwise returns a. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Allocator shall + be a type meeting the Allocator requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and a is an object of type Allocator. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Allocator requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,a) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get.html new file mode 100644 index 0000000..132bfa0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get.html @@ -0,0 +1,56 @@ + + + +associated_allocator::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If T has a nested type allocator_type, + returns t.get_allocator(). + Otherwise returns type(). +

+
static decltype(auto) get(
+    const T & t);
+  » more...
+
+

+ If T has a nested type + allocator_type, returns + t.get_allocator(). + Otherwise returns a. +

+
static decltype(auto) get(
+    const T & t,
+    const Allocator & a);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get/overload1.html new file mode 100644 index 0000000..2adaa05 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get/overload1.html @@ -0,0 +1,45 @@ + + + +associated_allocator::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ If T has a nested type + allocator_type, returns + t.get_allocator(). + Otherwise returns type(). +

+
static decltype(auto) get(
+    const T & t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get/overload2.html new file mode 100644 index 0000000..a23b250 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/get/overload2.html @@ -0,0 +1,46 @@ + + + +associated_allocator::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ If T has a nested type + allocator_type, returns + t.get_allocator(). + Otherwise returns a. +

+
static decltype(auto) get(
+    const T & t,
+    const Allocator & a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/type.html new file mode 100644 index 0000000..1daed06 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator/type.html @@ -0,0 +1,52 @@ + + + +associated_allocator::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If T has a nested type allocator_type, + T::allocator_type. Otherwise Allocator. +

+
typedef see_below type;
+
+
+ + Requirements +
+

+ Header: asio/associated_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_.html new file mode 100644 index 0000000..5613698 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_.html @@ -0,0 +1,128 @@ + + + +associated_allocator< reference_wrapper< T >, Allocator > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Specialisation of associated_allocator for std::reference_wrapper. +

+
template<
+    typename T,
+    typename Allocator>
+struct associated_allocator< reference_wrapper< T >, Allocator >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ Forwards type to the associator specialisation for the unwrapped + type T. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ Forwards the request to get the allocator to the associator specialisation + for the unwrapped type T. +

+
+
+ + Requirements +
+

+ Header: asio/associated_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get.html new file mode 100644 index 0000000..95cb1d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get.html @@ -0,0 +1,51 @@ + + + +associated_allocator< reference_wrapper< T >, Allocator >::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards the request to get + the allocator to the associator specialisation for the unwrapped type + T. +

+
static type get(
+    reference_wrapper< T > t);
+  » more...
+
+static auto get(
+    reference_wrapper< T > t,
+    const Allocator & a);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get/overload1.html new file mode 100644 index 0000000..6d30557 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get/overload1.html @@ -0,0 +1,43 @@ + + + +associated_allocator< reference_wrapper< T >, Allocator >::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwards the request to get the allocator to the associator specialisation + for the unwrapped type T. +

+
static type get(
+    reference_wrapper< T > t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get/overload2.html new file mode 100644 index 0000000..53049bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/get/overload2.html @@ -0,0 +1,44 @@ + + + +associated_allocator< reference_wrapper< T >, Allocator >::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwards the request to get the allocator to the associator specialisation + for the unwrapped type T. +

+
static auto get(
+    reference_wrapper< T > t,
+    const Allocator & a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/type.html new file mode 100644 index 0000000..e5d2fed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_lt__reference_wrapper_lt__T__gt__comma__Allocator__gt_/type.html @@ -0,0 +1,154 @@ + + + +associated_allocator< reference_wrapper< T >, Allocator >::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards type + to the associator specialisation for the unwrapped type T. +

+
typedef associated_allocator< T, Allocator >::type type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type allocator_type, T::allocator_type. Otherwise + Allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type allocator_type, returns t.get_allocator(). + Otherwise returns type().
—
If T has a nested type + allocator_type, returns t.get_allocator(). Otherwise returns + a. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Allocator shall + be a type meeting the Allocator requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and a is an object of type Allocator. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Allocator requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,a) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_t.html b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_t.html new file mode 100644 index 0000000..624c092 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_allocator_t.html @@ -0,0 +1,149 @@ + + + +associated_allocator_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef typename associated_allocator< T, Allocator >::type associated_allocator_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type allocator_type, T::allocator_type. Otherwise + Allocator. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type allocator_type, returns t.get_allocator(). + Otherwise returns type().
—
If T has a nested type + allocator_type, returns t.get_allocator(). Otherwise returns a. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Allocator shall + be a type meeting the Allocator requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and a is an object of type Allocator. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Allocator requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,a) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot.html new file mode 100644 index 0000000..1cdb53d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot.html @@ -0,0 +1,158 @@ + + + +associated_cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Traits type used to obtain the cancellation_slot associated with + an object. +

+
template<
+    typename T,
+    typename CancellationSlot = cancellation_slot>
+struct associated_cancellation_slot
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type cancellation_slot_type, T::cancellation_slot_type. + Otherwise CancellationSlot. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type cancellation_slot_type, returns t.get_cancellation_slot(). + Otherwise returns type().
—
If T has a nested type + cancellation_slot_type, returns t.get_cancellation_slot(). Otherwise + returns s. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter CancellationSlot + shall be a type meeting the CancellationSlot requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and s is an object of type CancellationSlot. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the CancellationSlot requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,s) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get.html new file mode 100644 index 0000000..628d82b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get.html @@ -0,0 +1,55 @@ + + + +associated_cancellation_slot::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If + T has a nested type cancellation_slot_type, returns t.get_cancellation_slot(). Otherwise returns type(). +

+
static decltype(auto) get(
+    const T & t);
+  » more...
+
+

+ If T has a nested type + cancellation_slot_type, + returns t.get_cancellation_slot(). + Otherwise returns s. +

+
static decltype(auto) get(
+    const T & t,
+    const CancellationSlot & s);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get/overload1.html new file mode 100644 index 0000000..36546da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get/overload1.html @@ -0,0 +1,45 @@ + + + +associated_cancellation_slot::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ If T has a nested type + cancellation_slot_type, + returns t.get_cancellation_slot(). + Otherwise returns type(). +

+
static decltype(auto) get(
+    const T & t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get/overload2.html new file mode 100644 index 0000000..496d439 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/get/overload2.html @@ -0,0 +1,46 @@ + + + +associated_cancellation_slot::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ If T has a nested type + cancellation_slot_type, + returns t.get_cancellation_slot(). + Otherwise returns s. +

+
static decltype(auto) get(
+    const T & t,
+    const CancellationSlot & s);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/type.html new file mode 100644 index 0000000..8223503 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot/type.html @@ -0,0 +1,53 @@ + + + +associated_cancellation_slot::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If + T has a nested type cancellation_slot_type, T::cancellation_slot_type. + Otherwise CancellationSlot. +

+
typedef see_below type;
+
+
+ + Requirements +
+

+ Header: asio/associated_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_.html new file mode 100644 index 0000000..30a6cf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_.html @@ -0,0 +1,129 @@ + + + +associated_cancellation_slot< reference_wrapper< T >, CancellationSlot > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Specialisation of associated_cancellation_slot for + std::reference_wrapper. +

+
template<
+    typename T,
+    typename CancellationSlot>
+struct associated_cancellation_slot< reference_wrapper< T >, CancellationSlot >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ Forwards type to the associator specialisation for the unwrapped + type T. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ Forwards the request to get the cancellation slot to the associator + specialisation for the unwrapped type T. +

+
+
+ + Requirements +
+

+ Header: asio/associated_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get.html new file mode 100644 index 0000000..7723711 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get.html @@ -0,0 +1,51 @@ + + + +associated_cancellation_slot< reference_wrapper< T >, CancellationSlot >::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards the request + to get the cancellation slot to the associator specialisation for the unwrapped + type T. +

+
static type get(
+    reference_wrapper< T > t);
+  » more...
+
+static auto get(
+    reference_wrapper< T > t,
+    const CancellationSlot & s);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get/overload1.html new file mode 100644 index 0000000..4799497 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get/overload1.html @@ -0,0 +1,43 @@ + + + +associated_cancellation_slot< reference_wrapper< T >, CancellationSlot >::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwards the request to get the cancellation slot to the associator specialisation + for the unwrapped type T. +

+
static type get(
+    reference_wrapper< T > t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get/overload2.html new file mode 100644 index 0000000..8603126 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/get/overload2.html @@ -0,0 +1,44 @@ + + + +associated_cancellation_slot< reference_wrapper< T >, CancellationSlot >::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwards the request to get the cancellation slot to the associator specialisation + for the unwrapped type T. +

+
static auto get(
+    reference_wrapper< T > t,
+    const CancellationSlot & s);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/type.html new file mode 100644 index 0000000..ec219ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_lt__reference_wrapper_lt__T__gt__comma__CancellationSlot__gt_/type.html @@ -0,0 +1,154 @@ + + + +associated_cancellation_slot< reference_wrapper< T >, CancellationSlot >::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards type to the associator specialisation + for the unwrapped type T. +

+
typedef associated_cancellation_slot< T, CancellationSlot >::type type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type cancellation_slot_type, T::cancellation_slot_type. + Otherwise CancellationSlot. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type cancellation_slot_type, returns t.get_cancellation_slot(). + Otherwise returns type().
—
If T has a nested type + cancellation_slot_type, returns t.get_cancellation_slot(). Otherwise + returns s. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter CancellationSlot + shall be a type meeting the CancellationSlot requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and s is an object of type CancellationSlot. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the CancellationSlot requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,s) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_t.html b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_t.html new file mode 100644 index 0000000..b108274 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_cancellation_slot_t.html @@ -0,0 +1,151 @@ + + + +associated_cancellation_slot_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef typename associated_cancellation_slot< T, CancellationSlot >::type associated_cancellation_slot_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type cancellation_slot_type, T::cancellation_slot_type. + Otherwise CancellationSlot. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type cancellation_slot_type, returns t.get_cancellation_slot(). + Otherwise returns type().
—
If T has a nested type + cancellation_slot_type, returns t.get_cancellation_slot(). Otherwise + returns s. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter CancellationSlot + shall be a type meeting the CancellationSlot requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and s is an object of type CancellationSlot. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the CancellationSlot requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,s) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor.html new file mode 100644 index 0000000..faba705 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor.html @@ -0,0 +1,156 @@ + + + +associated_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Traits type used to obtain the executor associated with an object. +

+
template<
+    typename T,
+    typename Executor = system_executor>
+struct associated_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type executor_type, T::executor_type. Otherwise + Executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type executor_type, returns t.get_executor(). + Otherwise returns type().
—
If T has a nested type + executor_type, returns t.get_executor(). Otherwise returns ex. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Executor shall + be a type meeting the Executor requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and e is an object of type Executor. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Executor requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,e) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get.html new file mode 100644 index 0000000..8354fa7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get.html @@ -0,0 +1,56 @@ + + + +associated_executor::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If T has a nested type executor_type, + returns t.get_executor(). + Otherwise returns type(). +

+
static decltype(auto) get(
+    const T & t);
+  » more...
+
+

+ If T has a nested type + executor_type, returns + t.get_executor(). + Otherwise returns ex. +

+
static decltype(auto) get(
+    const T & t,
+    const Executor & ex);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get/overload1.html new file mode 100644 index 0000000..6d6c18d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get/overload1.html @@ -0,0 +1,45 @@ + + + +associated_executor::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ If T has a nested type + executor_type, returns + t.get_executor(). + Otherwise returns type(). +

+
static decltype(auto) get(
+    const T & t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get/overload2.html new file mode 100644 index 0000000..14ef12c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/get/overload2.html @@ -0,0 +1,46 @@ + + + +associated_executor::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ If T has a nested type + executor_type, returns + t.get_executor(). + Otherwise returns ex. +

+
static decltype(auto) get(
+    const T & t,
+    const Executor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/type.html new file mode 100644 index 0000000..ca792cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor/type.html @@ -0,0 +1,52 @@ + + + +associated_executor::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If T has a nested type executor_type, + T::executor_type. Otherwise Executor. +

+
typedef see_below type;
+
+
+ + Requirements +
+

+ Header: asio/associated_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_.html new file mode 100644 index 0000000..df8bc96 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_.html @@ -0,0 +1,128 @@ + + + +associated_executor< reference_wrapper< T >, Executor > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Specialisation of associated_executor for std::reference_wrapper. +

+
template<
+    typename T,
+    typename Executor>
+struct associated_executor< reference_wrapper< T >, Executor >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ Forwards type to the associator specialisation for the unwrapped + type T. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ Forwards the request to get the executor to the associator specialisation + for the unwrapped type T. +

+
+
+ + Requirements +
+

+ Header: asio/associated_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get.html new file mode 100644 index 0000000..d1fff13 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get.html @@ -0,0 +1,50 @@ + + + +associated_executor< reference_wrapper< T >, Executor >::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards the request to get + the executor to the associator specialisation for the unwrapped type T. +

+
static type get(
+    reference_wrapper< T > t);
+  » more...
+
+static auto get(
+    reference_wrapper< T > t,
+    const Executor & ex);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get/overload1.html new file mode 100644 index 0000000..4667092 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get/overload1.html @@ -0,0 +1,43 @@ + + + +associated_executor< reference_wrapper< T >, Executor >::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwards the request to get the executor to the associator specialisation + for the unwrapped type T. +

+
static type get(
+    reference_wrapper< T > t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get/overload2.html new file mode 100644 index 0000000..f7772b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get/overload2.html @@ -0,0 +1,44 @@ + + + +associated_executor< reference_wrapper< T >, Executor >::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwards the request to get the executor to the associator specialisation + for the unwrapped type T. +

+
static auto get(
+    reference_wrapper< T > t,
+    const Executor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/type.html new file mode 100644 index 0000000..87f97fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/type.html @@ -0,0 +1,153 @@ + + + +associated_executor< reference_wrapper< T >, Executor >::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards type + to the associator specialisation for the unwrapped type T. +

+
typedef associated_executor< T, Executor >::type type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type executor_type, T::executor_type. Otherwise + Executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type executor_type, returns t.get_executor(). + Otherwise returns type().
—
If T has a nested type + executor_type, returns t.get_executor(). Otherwise returns ex. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Executor shall + be a type meeting the Executor requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and e is an object of type Executor. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Executor requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,e) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_executor_t.html b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_t.html new file mode 100644 index 0000000..1ec575f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_executor_t.html @@ -0,0 +1,149 @@ + + + +associated_executor_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef typename associated_executor< T, Executor >::type associated_executor_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type executor_type, T::executor_type. Otherwise + Executor. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type executor_type, returns t.get_executor(). + Otherwise returns type().
—
If T has a nested type + executor_type, returns t.get_executor(). Otherwise returns ex. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Executor shall + be a type meeting the Executor requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and e is an object of type Executor. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Executor requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,e) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor.html b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor.html new file mode 100644 index 0000000..39a8f28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor.html @@ -0,0 +1,154 @@ + + + +associated_immediate_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Traits type used to obtain the immediate executor associated with an object. +

+
template<
+    typename T,
+    typename Executor>
+struct associated_immediate_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type immediate_executor_type,. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type immediate_executor_type, returns t.get_immediate_executor(). + Otherwise returns asio::require(ex, asio::execution::blocking.never). +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Executor shall + be a type meeting the Executor requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and e is an object of type Executor. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Executor requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,e) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor/get.html new file mode 100644 index 0000000..2025ef1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor/get.html @@ -0,0 +1,45 @@ + + + +associated_immediate_executor::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If + T has a nested type immediate_executor_type, returns t.get_immediate_executor(). Otherwise returns asio::require(ex, + asio::execution::blocking.never). +

+
static decltype(auto) get(
+    const T & t,
+    const Executor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor/type.html new file mode 100644 index 0000000..6a80801 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor/type.html @@ -0,0 +1,52 @@ + + + +associated_immediate_executor::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If + T has a nested type immediate_executor_type,. +

+
typedef see_below type;
+
+
+ + Requirements +
+

+ Header: asio/associated_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_.html new file mode 100644 index 0000000..bb83a63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_.html @@ -0,0 +1,129 @@ + + + +associated_immediate_executor< reference_wrapper< T >, Executor > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Specialisation of associated_immediate_executor for + std::reference_wrapper. +

+
template<
+    typename T,
+    typename Executor>
+struct associated_immediate_executor< reference_wrapper< T >, Executor >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ Forwards type to the associator specialisation for the unwrapped + type T. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ Forwards the request to get the executor to the associator specialisation + for the unwrapped type T. +

+
+
+ + Requirements +
+

+ Header: asio/associated_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get.html b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get.html new file mode 100644 index 0000000..6221be4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/get.html @@ -0,0 +1,45 @@ + + + +associated_immediate_executor< reference_wrapper< T >, Executor >::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards the request to get + the executor to the associator specialisation for the unwrapped type T. +

+
static auto get(
+    reference_wrapper< T > t,
+    const Executor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/type.html b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/type.html new file mode 100644 index 0000000..2b8fdc5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_lt__reference_wrapper_lt__T__gt__comma__Executor__gt_/type.html @@ -0,0 +1,151 @@ + + + +associated_immediate_executor< reference_wrapper< T >, Executor >::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwards type + to the associator specialisation for the unwrapped type T. +

+
typedef associated_immediate_executor< T, Executor >::type type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type immediate_executor_type,. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type immediate_executor_type, returns t.get_immediate_executor(). + Otherwise returns asio::require(ex, asio::execution::blocking.never). +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Executor shall + be a type meeting the Executor requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and e is an object of type Executor. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Executor requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,e) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_t.html b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_t.html new file mode 100644 index 0000000..6473d4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associated_immediate_executor_t.html @@ -0,0 +1,148 @@ + + + +associated_immediate_executor_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef typename associated_immediate_executor< T, Executor >::type associated_immediate_executor_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type immediate_executor_type,. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get [static] +

+ 		+

+ If T has a nested type immediate_executor_type, returns t.get_immediate_executor(). + Otherwise returns asio::require(ex, asio::execution::blocking.never). +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. The template + parameter Executor shall + be a type meeting the Executor requirements. +

+

+ Specialisations shall meet the following requirements, where t is a const reference to an object of + type T, and e is an object of type Executor. +

+
    +
  • + Provide a nested typedef type + that identifies a type meeting the Executor requirements. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t) + and with return type type + or a (possibly const) reference to type. +
    • +
  • + Provide a noexcept static member function named get, + callable as get(t,e) + and with return type type + or a (possibly const) reference to type. +
    • +
+
+ + Requirements +
+

+ Header: asio/associated_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/associator.html b/Packages/asio-1.36.0/doc/asio/reference/associator.html new file mode 100644 index 0000000..6c6f573 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/associator.html @@ -0,0 +1,58 @@ + + + +associator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Used to generically specialise associators for a type. +

+
template<
+    template< typename, typename > class Associator,
+    typename T,
+    typename DefaultCandidate,
+    typename _ = void>
+struct associator
+
+
+ + Requirements +
+

+ Header: asio/associator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_completion.html b/Packages/asio-1.36.0/doc/asio/reference/async_completion.html new file mode 100644 index 0000000..c2421b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_completion.html @@ -0,0 +1,175 @@ + + + +async_completion + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper template to deduce the handler type from a CompletionToken, capture + a local copy of the handler, and then create an async_result for the handler. +

+
template<
+    typename CompletionToken,
+    typename... Signatures>
+struct async_completion
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ completion_handler_type +

+ 		+

+ The real handler type to be used for the asynchronous operation. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_completion [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ completion_handler +

+ 		+

+ A copy of, or reference to, a real handler object. +

+
+

+ result +

+ 		+

+ The result of the asynchronous operation's initiating function. +

+
+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_completion/async_completion.html b/Packages/asio-1.36.0/doc/asio/reference/async_completion/async_completion.html new file mode 100644 index 0000000..9048758 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_completion/async_completion.html @@ -0,0 +1,46 @@ + + + +async_completion::async_completion + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
async_completion(
+    CompletionToken & token);
+
+

+ The constructor creates the concrete completion handler and makes the link + between the handler and the asynchronous result. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_completion/completion_handler.html b/Packages/asio-1.36.0/doc/asio/reference/async_completion/completion_handler.html new file mode 100644 index 0000000..5724d7f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_completion/completion_handler.html @@ -0,0 +1,42 @@ + + + +async_completion::completion_handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + copy of, or reference to, a real handler object. +

+
conditional_t< is_same< CompletionToken, completion_handler_type >::value, completion_handler_type &, completion_handler_type > completion_handler;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_completion/completion_handler_type.html b/Packages/asio-1.36.0/doc/asio/reference/async_completion/completion_handler_type.html new file mode 100644 index 0000000..738a0e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_completion/completion_handler_type.html @@ -0,0 +1,223 @@ + + + +async_completion::completion_handler_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + real handler type to be used for the asynchronous operation. +

+
typedef asio::async_result< decay_t< CompletionToken >, Signatures... >::completion_handler_type completion_handler_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ completion_handler_type +

+ 		+

+ (Legacy.) The concrete completion handler type for the specific + signature. +

+
+

+ return_type +

+ 		+

+ (Legacy.) The return type of the initiating function. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_result [constructor] +

+ 		+

+ (Legacy.) Construct an async result from a given handler. +

+
+

+ get +

+ 		+

+ (Legacy.) Obtain the value to be returned from the initiating + function. +

+
+

+ initiate [static] +

+ 		+

+ Initiate the asynchronous operation that will produce the result, + and obtain the value to be returned from the initiating function. +

+
+

+ The async_result + trait is a customisation point that is used within the initiating function + for an asynchronous operation. + The trait combines: +

+
    +
  • + the completion signature (or signatures) that describe the arguments + that an asynchronous operation will pass to a completion handler; +
    • +
  • + the completion + token type supplied by the caller; and +
    • +
  • + the operation's internal implementation. +
    • +
+

+ Specialisations of the trait must satisfy the async_result + requirements, and are reponsible for determining: +

+
    +
  • + the concrete completion handler type to be called at the end of the + asynchronous operation; +
    • +
  • + the initiating function return type; +
    • +
  • + how the return value of the initiating function is obtained; and +
    • +
  • + how and when to launch the operation by invoking the supplied initiation + function object. +
    • +
+

+ This template may be specialised for user-defined completion token types. + The primary template assumes that the CompletionToken is the already a + concrete completion handler. +

+
+ + Remarks +
+

+ For backwards compatibility, the primary template implements member types + and functions that are associated with legacy forms of the async_result trait. These are + annotated as "Legacy" in the documentation below. User specialisations + of this trait do not need to implement these in order to satisfy the async_result + requirements. +

+

+ In general, implementers of asynchronous operations should use the async_initiate + function rather than using the async_result trait directly. +

+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_completion/result.html b/Packages/asio-1.36.0/doc/asio/reference/async_completion/result.html new file mode 100644 index 0000000..7f4fd31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_completion/result.html @@ -0,0 +1,42 @@ + + + +async_completion::result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The result + of the asynchronous operation's initiating function. +

+
async_result< decay_t< CompletionToken >, Signatures... > result;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_compose.html b/Packages/asio-1.36.0/doc/asio/reference/async_compose.html new file mode 100644 index 0000000..c932604 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_compose.html @@ -0,0 +1,164 @@ + + + +async_compose + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Launch an asynchronous operation with a stateful implementation. +

+
template<
+    typename CompletionToken,
+    typename Signature,
+    typename Implementation,
+    typename... IoObjectsOrExecutors>
+DEDUCED async_compose(
+    Implementation && implementation,
+    type_identity_t< CompletionToken > & token,
+    IoObjectsOrExecutors &&... io_objects_or_executors);
+
+

+ The async_compose function simplifies the implementation of composed asynchronous + operations automatically wrapping a stateful function object with a conforming + intermediate completion handler. +

+
+ + Parameters +
+
+

+
+
implementation
+

+ A function object that contains the implementation of the composed + asynchronous operation. The first argument to the function object is + a non-const reference to the enclosing intermediate completion handler. + The remaining arguments are any arguments that originate from the completion + handlers of any asynchronous operations performed by the implementation. +

+
token
+

+ The completion token. +

+
io_objects_or_executors
+

+ Zero or more I/O objects or I/O executors for which outstanding work + must be maintained. +

+
+
+
+ + Per-Operation + Cancellation +
+

+ By default, terminal per-operation cancellation is enabled for composed operations + that are implemented using async_compose. + To disable cancellation for the composed operation, or to alter its supported + cancellation types, call the self + object's reset_cancellation_state + function. +

+
+ + Example: +
+
struct async_echo_implementation
+{
+  tcp::socket& socket_;
+  asio::mutable_buffer buffer_;
+  enum { starting, reading, writing } state_;
+
+  template <typename Self>
+  void operator()(Self& self,
+      asio::error_code error = {},
+      std::size_t n = 0)
+  {
+    switch (state_)
+    {
+    case starting:
+      state_ = reading;
+      socket_.async_read_some(
+          buffer_, std::move(self));
+      break;
+    case reading:
+      if (error)
+      {
+        self.complete(error, 0);
+      }
+      else
+      {
+        state_ = writing;
+        asio::async_write(socket_, buffer_,
+            asio::transfer_exactly(n),
+            std::move(self));
+      }
+      break;
+    case writing:
+      self.complete(error, n);
+      break;
+    }
+  }
+};
+
+template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    asio::mutable_buffer buffer,
+    CompletionToken&& token)
+  -> decltype(
+    asio::async_compose<CompletionToken,
+      void(asio::error_code, std::size_t)>(
+        std::declval<async_echo_implementation>(),
+        token, socket))
+{
+  return asio::async_compose<CompletionToken,
+    void(asio::error_code, std::size_t)>(
+      async_echo_implementation{socket, buffer,
+        async_echo_implementation::starting},
+      token, socket);
+}
+
+
+ + Requirements +
+

+ Header: asio/compose.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_connect.html b/Packages/asio-1.36.0/doc/asio/reference/async_connect.html new file mode 100644 index 0000000..9125063 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_connect.html @@ -0,0 +1,113 @@ + + + +async_connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The async_connect function + is a composed asynchronous operation that establishes a socket connection + by trying each endpoint in a sequence. +

+

+ Asynchronously establishes a socket connection by trying each endpoint in + a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename RangeConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    RangeConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< !is_connect_condition< RangeConnectToken, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename IteratorConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    IteratorConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< !is_connect_condition< IteratorConnectToken, Iterator >::value >  = 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename ConnectCondition,
+    typename RangeConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    ConnectCondition connect_condition,
+    RangeConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< is_connect_condition< ConnectCondition, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename ConnectCondition,
+    typename IteratorConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    ConnectCondition connect_condition,
+    IteratorConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_connect_condition< ConnectCondition, Iterator >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/connect.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload1.html new file mode 100644 index 0000000..ea9acc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload1.html @@ -0,0 +1,168 @@ + + + +async_connect (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously establishes a socket connection by trying each endpoint + in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename RangeConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    RangeConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< !is_connect_condition< RangeConnectToken, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+
+

+ This function attempts to connect a socket to one of a sequence of endpoints. + It does this by repeated calls to the socket's async_connect + member function, once for each endpoint in the sequence, until a connection + is successfully established. It is an initiating function for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The socket to be connected. If the socket is already open, it will + be closed. +

+
endpoints
+

+ A sequence of endpoints. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation. if the sequence is empty, set to
+  // asio::error::not_found. Otherwise, contains the
+  // error from the last connection attempt.
+  const asio::error_code& error,
+
+  // On success, the successfully connected endpoint.
+  // Otherwise, a default-constructed endpoint.
+  const typename Protocol::endpoint& endpoint
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, typename Protocol::endpoint)
+
+
+ + Example +
+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::socket s(my_context);
+
+// ...
+
+r.async_resolve(q, resolve_handler);
+
+// ...
+
+void resolve_handler(
+    const asio::error_code& ec,
+    tcp::resolver::results_type results)
+{
+  if (!ec)
+  {
+    asio::async_connect(s, results, connect_handler);
+  }
+}
+
+// ...
+
+void connect_handler(
+    const asio::error_code& ec,
+    const tcp::endpoint& endpoint)
+{
+  // ...
+}
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the socket's async_connect + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload2.html new file mode 100644 index 0000000..4eced2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload2.html @@ -0,0 +1,158 @@ + + + +async_connect (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously establishes a socket connection by trying each endpoint + in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename IteratorConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    IteratorConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< !is_connect_condition< IteratorConnectToken, Iterator >::value >  = 0);
+
+

+ This function attempts to connect a socket to one of a sequence of endpoints. + It does this by repeated calls to the socket's async_connect + member function, once for each endpoint in the sequence, until a connection + is successfully established. It is an initiating function for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
end
+

+ An iterator pointing to the end of a sequence of endpoints. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation. if the sequence is empty, set to
+  // asio::error::not_found. Otherwise, contains the
+  // error from the last connection attempt.
+  const asio::error_code& error,
+
+  // On success, an iterator denoting the successfully
+  // connected endpoint. Otherwise, the end iterator.
+  Iterator iterator
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, Iterator)
+
+
+ + Example +
+
std::vector<tcp::endpoint> endpoints = ...;
+tcp::socket s(my_context);
+asio::async_connect(s,
+    endpoints.begin(), endpoints.end(),
+    connect_handler);
+
+// ...
+
+void connect_handler(
+    const asio::error_code& ec,
+    std::vector<tcp::endpoint>::iterator i)
+{
+  // ...
+}
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the socket's async_connect + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload3.html new file mode 100644 index 0000000..eb1db21 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload3.html @@ -0,0 +1,218 @@ + + + +async_connect (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously establishes a socket connection by trying each endpoint + in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename ConnectCondition,
+    typename RangeConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    ConnectCondition connect_condition,
+    RangeConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< is_connect_condition< ConnectCondition, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+
+

+ This function attempts to connect a socket to one of a sequence of endpoints. + It does this by repeated calls to the socket's async_connect + member function, once for each endpoint in the sequence, until a connection + is successfully established. It is an initiating function for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The socket to be connected. If the socket is already open, it will + be closed. +

+
endpoints
+

+ 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: +

+
bool connect_condition(
+   const asio::error_code& ec,
+   const typename Protocol::endpoint& 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 the next endpoint to be tried. The function object should + return true if the next endpoint should be tried, and false if it + should be skipped. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation. if the sequence is empty, set to
+  // asio::error::not_found. Otherwise, contains the
+  // error from the last connection attempt.
+  const asio::error_code& error,
+
+  // On success, an iterator denoting the successfully
+  // connected endpoint. Otherwise, the end iterator.
+  Iterator iterator
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, typename Protocol::endpoint)
+
+
+ + Example +
+

+ The following connect condition function object can be used to output information + about the individual connection attempts: +

+
struct my_connect_condition
+{
+  bool operator()(
+      const asio::error_code& ec,
+      const::tcp::endpoint& next)
+  {
+    if (ec) std::cout << "Error: " << ec.message() << std::endl;
+    std::cout << "Trying: " << next << std::endl;
+    return true;
+  }
+};
+
+

+ It would be used with the connect function as follows: +

+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::socket s(my_context);
+
+// ...
+
+r.async_resolve(q, resolve_handler);
+
+// ...
+
+void resolve_handler(
+    const asio::error_code& ec,
+    tcp::resolver::results_type results)
+{
+  if (!ec)
+  {
+    asio::async_connect(s, results,
+        my_connect_condition(),
+        connect_handler);
+  }
+}
+
+// ...
+
+void connect_handler(
+    const asio::error_code& ec,
+    const tcp::endpoint& endpoint)
+{
+  if (ec)
+  {
+    // An error occurred.
+  }
+  else
+  {
+    std::cout << "Connected to: " << endpoint << std::endl;
+  }
+}
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the socket's async_connect + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload4.html new file mode 100644 index 0000000..d5c9a1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_connect/overload4.html @@ -0,0 +1,223 @@ + + + +async_connect (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously establishes a socket connection by trying each endpoint + in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename ConnectCondition,
+    typename IteratorConnectToken = default_completion_token_t<Executor>>
+DEDUCED async_connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    ConnectCondition connect_condition,
+    IteratorConnectToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_connect_condition< ConnectCondition, Iterator >::value >  = 0);
+
+

+ This function attempts to connect a socket to one of a sequence of endpoints. + It does this by repeated calls to the socket's async_connect + member function, once for each endpoint in the sequence, until a connection + is successfully established. It is an initiating function for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
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: +

+
bool connect_condition(
+   const asio::error_code& ec,
+   const typename Protocol::endpoint& 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 the next endpoint to be tried. The function object should + return true if the next endpoint should be tried, and false if it + should be skipped. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation. if the sequence is empty, set to
+  // asio::error::not_found. Otherwise, contains the
+  // error from the last connection attempt.
+  const asio::error_code& error,
+
+  // On success, an iterator denoting the successfully
+  // connected endpoint. Otherwise, the end iterator.
+  Iterator iterator
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, Iterator)
+
+
+ + Example +
+

+ The following connect condition function object can be used to output information + about the individual connection attempts: +

+
struct my_connect_condition
+{
+  bool operator()(
+      const asio::error_code& ec,
+      const::tcp::endpoint& next)
+  {
+    if (ec) std::cout << "Error: " << ec.message() << std::endl;
+    std::cout << "Trying: " << next << std::endl;
+    return true;
+  }
+};
+
+

+ It would be used with the connect function as follows: +

+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::socket s(my_context);
+
+// ...
+
+r.async_resolve(q, resolve_handler);
+
+// ...
+
+void resolve_handler(
+    const asio::error_code& ec,
+    tcp::resolver::iterator i)
+{
+  if (!ec)
+  {
+    tcp::resolver::iterator end;
+    asio::async_connect(s, i, end,
+        my_connect_condition(),
+        connect_handler);
+  }
+}
+
+// ...
+
+void connect_handler(
+    const asio::error_code& ec,
+    tcp::resolver::iterator i)
+{
+  if (ec)
+  {
+    // An error occurred.
+  }
+  else
+  {
+    std::cout << "Connected to: " << i->endpoint() << std::endl;
+  }
+}
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the socket's async_connect + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_immediate.html b/Packages/asio-1.36.0/doc/asio/reference/async_immediate.html new file mode 100644 index 0000000..28ab3ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_immediate.html @@ -0,0 +1,69 @@ + + + +async_immediate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Launch a trivial asynchronous operation that completes immediately. +

+
template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+DEDUCED async_immediate(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t<(execution::is_executor< Executor >::value &&can_require< Executor, execution::blocking_t::never_t >::value)||is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+DEDUCED async_immediate(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/immediate.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_immediate/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/async_immediate/overload1.html new file mode 100644 index 0000000..70b0b0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_immediate/overload1.html @@ -0,0 +1,85 @@ + + + +async_immediate (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Launch a trivial asynchronous operation that completes immediately. +

+
template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+DEDUCED async_immediate(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t<(execution::is_executor< Executor >::value &&can_require< Executor, execution::blocking_t::never_t >::value)||is_executor< Executor >::value >  = 0);
+
+

+ The async_immediate function is intended for use by composed operations, + which can delegate to this operation in order to implement the correct + semantics for immediate completion. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The asynchronous operation's I/O executor. +

+
token
+

+ The completion token. +

+
+
+

+ The completion handler is immediately submitted for execution by calling + dispatch + on the handler's associated immediate executor. +

+

+ If the completion handler does not have a customised associated immediate + executor, then the handler is submitted as if by calling post on the supplied I/O executor. +

+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_immediate/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/async_immediate/overload2.html new file mode 100644 index 0000000..854c255 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_immediate/overload2.html @@ -0,0 +1,87 @@ + + + +async_immediate (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Launch a trivial asynchronous operation that completes immediately. +

+
template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+DEDUCED async_immediate(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ The async_immediate function is intended for use by composed operations, + which can delegate to this operation in order to implement the correct + semantics for immediate completion. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The execution context used to obtain the asynchronous operation's + I/O executor. +

+
token
+

+ The completion token. +

+
+
+

+ The completion handler is immediately submitted for execution by calling + dispatch + on the handler's associated immediate executor. +

+

+ If the completion handler does not have a customised associated immediate + executor, then the handler is submitted as if by calling post on the I/O executor obtained + from the supplied execution context. +

+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_initiate.html b/Packages/asio-1.36.0/doc/asio/reference/async_initiate.html new file mode 100644 index 0000000..9b6b2f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_initiate.html @@ -0,0 +1,58 @@ + + + +async_initiate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename CompletionToken,
+    completion_signature... Signatures,
+    typename Initiation,
+    typename... Args>
+DEDUCED async_initiate(
+    Initiation && initiation,
+    type_identity_t< CompletionToken > & token,
+    Args &&... args);
+
+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read.html b/Packages/asio-1.36.0/doc/asio/reference/async_read.html new file mode 100644 index 0000000..f13991c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read.html @@ -0,0 +1,160 @@ + + + +async_read + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The async_read function is + a composed asynchronous operation that reads a certain amount of data from + a stream before completion. +

+

+ Start an asynchronous operation to read a certain amount of data from a stream. +

+
template<
+    typename AsyncReadStream,
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename MutableBufferSequence,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/read.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload1.html new file mode 100644 index 0000000..0e51278 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload1.html @@ -0,0 +1,180 @@ + + + +async_read (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue 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. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + The program must ensure that the stream performs no other read operations + (such as async_read, the stream's async_read_some function, or any other + composed operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream 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. 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 completion + handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::async_read(s, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::async_read(
+   s, buffers,
+   asio::transfer_all(),
+   handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload2.html new file mode 100644 index 0000000..09c0175 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload2.html @@ -0,0 +1,186 @@ + + + +async_read (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename MutableBufferSequence,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue 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 completion_condition function object returns 0. +
    • +
+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream 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. 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 completion + handler is called. +

+
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 async_read_some operation.
+  const asio::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 async_read_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::async_read(s,
+   asio::buffer(data, size),
+   asio::transfer_at_least(32),
+   handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload3.html new file mode 100644 index 0000000..68dfafd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload3.html @@ -0,0 +1,165 @@ + + + +async_read (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + The program must ensure that the stream performs no other read operations + (such as async_read, the stream's async_read_some function, or any other + composed operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::async_read(
+   s, buffers,
+   asio::transfer_all(),
+   handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload4.html new file mode 100644 index 0000000..bbabc9d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload4.html @@ -0,0 +1,175 @@ + + + +async_read (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + The program must ensure that the stream performs no other read operations + (such as async_read, the stream's async_read_some function, or any other + composed operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
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 async_read_some operation.
+  const asio::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 async_read_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload5.html new file mode 100644 index 0000000..f0374b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload5.html @@ -0,0 +1,162 @@ + + + +async_read (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The supplied buffer is full (that is, it has reached maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + The program must ensure that the stream performs no other read operations + (such as async_read, the stream's async_read_some function, or any other + composed operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
b
+

+ A basic_streambuf + object into which the data will be read. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::async_read(
+   s, b,
+   asio::transfer_all(),
+   handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload6.html new file mode 100644 index 0000000..52df151 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload6.html @@ -0,0 +1,172 @@ + + + +async_read (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The supplied buffer is full (that is, it has reached maximum size). +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + The program must ensure that the stream performs no other read operations + (such as async_read, the stream's async_read_some function, or any other + composed operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
b
+

+ A basic_streambuf + object into which the data will be read. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
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 async_read_some operation.
+  const asio::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 async_read_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload7.html new file mode 100644 index 0000000..5cc0816 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload7.html @@ -0,0 +1,164 @@ + + + +async_read (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + The program must ensure that the stream performs no other read operations + (such as async_read, the stream's async_read_some function, or any other + composed operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::async_read(
+   s, buffers,
+   asio::transfer_all(),
+   handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload8.html new file mode 100644 index 0000000..27bb4d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read/overload8.html @@ -0,0 +1,174 @@ + + + +async_read (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data from a + stream. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + The program must ensure that the stream performs no other read operations + (such as async_read, the stream's async_read_some function, or any other + composed operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
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 async_read_some operation.
+  const asio::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 async_read_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_at.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_at.html new file mode 100644 index 0000000..462b436 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_at.html @@ -0,0 +1,109 @@ + + + +async_read_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The async_read_at function + is a composed asynchronous operation that reads a certain amount of data + at the specified offset. +

+

+ Start an asynchronous operation to read a certain amount of data at the specified + offset. +

+
template<
+    typename AsyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncRandomAccessReadDevice,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncRandomAccessReadDevice,
+    typename Allocator,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/read_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload1.html new file mode 100644 index 0000000..bb0ffce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload1.html @@ -0,0 +1,181 @@ + + + +async_read_at (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a random access device at the specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue 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. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + async_read_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device from which the data is to be read. The type must support + the AsyncRandomAccessReadDevice 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. 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 completion + handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::async_read_at(d, 42, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::async_read_at(
+   d, 42, buffers,
+   asio::transfer_all(),
+   handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessReadDevice + type's async_read_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload2.html new file mode 100644 index 0000000..8eacb6d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload2.html @@ -0,0 +1,190 @@ + + + +async_read_at (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a random access device at the specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue 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 completion_condition function object returns 0. +
    • +
+
+ + Parameters +
+
+

+
+
d
+

+ The device from which the data is to be read. The type must support + the AsyncRandomAccessReadDevice 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. 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 completion + handler is called. +

+
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 async_read_some_at operation.
+  const asio::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 async_read_some_at function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::async_read_at(d, 42,
+   asio::buffer(data, size),
+   asio::transfer_at_least(32),
+   handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessReadDevice + type's async_read_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload3.html new file mode 100644 index 0000000..18eda06 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload3.html @@ -0,0 +1,159 @@ + + + +async_read_at (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessReadDevice,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< !is_completion_condition< ReadToken >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a random access device at the specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
  • + An error occurred. +
+

+ This operation is implemented in terms of zero or more calls to the device's + async_read_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device from which the data is to be read. The type must support + the AsyncRandomAccessReadDevice concept. +

+
offset
+

+ The offset at which the data will be read. +

+
b
+

+ A basic_streambuf + object into which the data will be read. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::async_read_at(
+   d, 42, b,
+   asio::transfer_all(),
+   handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessReadDevice + type's async_read_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload4.html new file mode 100644 index 0000000..e04909f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_at/overload4.html @@ -0,0 +1,169 @@ + + + +async_read_at (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessReadDevice,
+    typename Allocator,
+    typename CompletionCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncRandomAccessReadDevice::executor_type>>
+DEDUCED async_read_at(
+    AsyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncRandomAccessReadDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously read a certain number of bytes + of data from a random access device at the specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
  • + The completion_condition function object returns 0. +
+

+ This operation is implemented in terms of zero or more calls to the device's + async_read_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device from which the data is to be read. The type must support + the AsyncRandomAccessReadDevice concept. +

+
offset
+

+ The offset at which the data will be read. +

+
b
+

+ A basic_streambuf + object into which the data will be read. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
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 async_read_some_at operation.
+  const asio::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 async_read_some_at function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes copied into the buffers. If an error
+  // occurred, this will be the number of bytes successfully
+  // transferred prior to the error.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessReadDevice + type's async_read_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until.html new file mode 100644 index 0000000..b869291 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until.html @@ -0,0 +1,243 @@ + + + +async_read_until + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The async_read_until function + is a composed asynchronous operation that reads data into a dynamic buffer + sequence, or into a streambuf, until it contains a delimiter, matches a regular + expression, or a function object indicates a match. +

+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until it contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    char delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    string_view delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until some part of its data matches a regular expression. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename Traits,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until a function object indicates a match. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename MatchCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    MatchCondition match_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to read data into a streambuf until it contains + a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    char delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >());
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    string_view delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >());
+  » more...
+
+

+ Start an asynchronous operation to read data into a streambuf until some + part of its data matches a regular expression. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename Traits,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    const boost::basic_regex< char, Traits > & expr,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >());
+  » more...
+
+

+ Start an asynchronous operation to read data into a streambuf until a function + object indicates a match. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename MatchCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    MatchCondition match_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until it contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    char delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    string_view delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until some part of its data matches a regular expression. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename Traits,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until a function object indicates a match. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename MatchCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    MatchCondition match_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/read_until.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload1.html new file mode 100644 index 0000000..acbd4f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload1.html @@ -0,0 +1,216 @@ + + + +async_read_until (1 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until it contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    char delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until the dynamic buffer sequence's get area contains the + specified delimiter. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + If the dynamic buffer sequence's get area already contains the delimiter, + this asynchronous operation completes immediately. The program must ensure + that the stream performs no other read operations (such as async_read, + async_read_until, the stream's async_read_some function, or any other composed + operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
delim
+

+ The delimiter character. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer sequence's
+  // get area up to and including the delimiter.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent async_read_until + operation to examine. +

+
+ + Example +
+

+ To asynchronously read data into a std::string + until a newline is encountered: +

+
std::string data;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::string line = data.substr(0, n);
+    data.erase(0, n);
+    ...
+  }
+}
+...
+asio::async_read_until(s, data, '\n', handler);
+
+

+ After the async_read_until + operation completes successfully, the buffer data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer data + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload10.html new file mode 100644 index 0000000..681617c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload10.html @@ -0,0 +1,215 @@ + + + +async_read_until (10 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until it contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    string_view delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until the dynamic buffer sequence's get area contains the + specified delimiter. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + If the dynamic buffer sequence's get area already contains the delimiter, + this asynchronous operation completes immediately. The program must ensure + that the stream performs no other read operations (such as async_read, + async_read_until, the stream's async_read_some function, or any other composed + operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
delim
+

+ The delimiter string. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer sequence's
+  // get area up to and including the delimiter.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent async_read_until + operation to examine. +

+
+ + Example +
+

+ To asynchronously read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::string line = data.substr(0, n);
+    data.erase(0, n);
+    ...
+  }
+}
+...
+asio::async_read_until(s, data, "\r\n", handler);
+
+

+ After the async_read_until + operation completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the string data + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload11.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload11.html new file mode 100644 index 0000000..ac53f3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload11.html @@ -0,0 +1,220 @@ + + + +async_read_until (11 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until some part of its data matches a regular expression. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename Traits,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until the dynamic buffer sequence's get area contains some + data that matches a regular expression. It is an initiating function for + an asynchronous operation, + and always returns immediately. The asynchronous operation will continue + until one of the following conditions is true: +

+
    +
  • + A substring of the dynamic buffer sequence'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 + async_read_some function, and is known as a composed operation. + If the dynamic buffer sequence's get area already contains data that matches + the regular expression, this asynchronous operation completes immediately. + The program must ensure that the stream performs no other read operations + (such as async_read, async_read_until, the stream's async_read_some function, + or any other composed operations that perform reads) until this operation + completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
expr
+

+ The regular expression. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer
+  // sequence's get area up to and including the
+  // substring that matches the regular expression.
+  // 0 if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond that which matched the regular expression. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent async_read_until operation to examine. +

+
+ + Example +
+

+ To asynchronously read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::string line = data.substr(0, n);
+    data.erase(0, n);
+    ...
+  }
+}
+...
+asio::async_read_until(s, data,
+    boost::regex("\r\n"), handler);
+
+

+ After the async_read_until + operation completes successfully, the string data + contains the data which matched the regular expression: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the match, so that the string line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the string data + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload12.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload12.html new file mode 100644 index 0000000..fe34f00 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload12.html @@ -0,0 +1,265 @@ + + + +async_read_until (12 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until a function object indicates a match. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename MatchCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    MatchCondition match_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until a user-defined match condition function object, when + applied to the data contained in the dynamic buffer sequence, indicates + a successful match. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + 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 + async_read_some function, and is known as a composed operation. + If the match condition function object already indicates a match, this + asynchronous operation completes immediately. The program must ensure that + the stream performs no other read operations (such as async_read, async_read_until, + the stream's async_read_some function, or any other composed operations + that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
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<typename DynamicBuffer_v2::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. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer sequence's
+  // get area that have been fully consumed by the match
+  // function. O if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond that which matched the function object. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent async_read_until operation to examine. +

+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ 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. +

+
+ + Examples +
+

+ To asynchronously read data into a std::string + until whitespace is encountered: +

+
typedef asio::buffers_iterator<
+    asio::const_buffer> 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);
+}
+...
+void handler(const asio::error_code& e, std::size_t size);
+...
+std::string data;
+asio::async_read_until(s, data, match_whitespace, handler);
+
+

+ To asynchronously read data into a std::string + 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
+...
+void handler(const asio::error_code& e, std::size_t size);
+...
+std::string data;
+asio::async_read_until(s, data, match_char('a'), handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload2.html new file mode 100644 index 0000000..70e3fe1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload2.html @@ -0,0 +1,216 @@ + + + +async_read_until (2 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until it contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    string_view delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until the dynamic buffer sequence's get area contains the + specified delimiter. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + If the dynamic buffer sequence's get area already contains the delimiter, + this asynchronous operation completes immediately. The program must ensure + that the stream performs no other read operations (such as async_read, + async_read_until, the stream's async_read_some function, or any other composed + operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
delim
+

+ The delimiter string. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer sequence's
+  // get area up to and including the delimiter.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent async_read_until + operation to examine. +

+
+ + Example +
+

+ To asynchronously read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::string line = data.substr(0, n);
+    data.erase(0, n);
+    ...
+  }
+}
+...
+asio::async_read_until(s, data, "\r\n", handler);
+
+

+ After the async_read_until + operation completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the string data + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload3.html new file mode 100644 index 0000000..1f1529b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload3.html @@ -0,0 +1,221 @@ + + + +async_read_until (3 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until some part of its data matches a regular expression. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename Traits,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until the dynamic buffer sequence's get area contains some + data that matches a regular expression. It is an initiating function for + an asynchronous operation, + and always returns immediately. The asynchronous operation will continue + until one of the following conditions is true: +

+
    +
  • + A substring of the dynamic buffer sequence'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 + async_read_some function, and is known as a composed operation. + If the dynamic buffer sequence's get area already contains data that matches + the regular expression, this asynchronous operation completes immediately. + The program must ensure that the stream performs no other read operations + (such as async_read, async_read_until, the stream's async_read_some function, + or any other composed operations that perform reads) until this operation + completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
expr
+

+ The regular expression. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer
+  // sequence's get area up to and including the
+  // substring that matches the regular expression.
+  // 0 if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond that which matched the regular expression. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent async_read_until operation to examine. +

+
+ + Example +
+

+ To asynchronously read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::string line = data.substr(0, n);
+    data.erase(0, n);
+    ...
+  }
+}
+...
+asio::async_read_until(s, data,
+    boost::regex("\r\n"), handler);
+
+

+ After the async_read_until + operation completes successfully, the string data + contains the data which matched the regular expression: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the match, so that the string line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the string data + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload4.html new file mode 100644 index 0000000..43e0318 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload4.html @@ -0,0 +1,266 @@ + + + +async_read_until (4 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until a function object indicates a match. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v1,
+    typename MatchCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    MatchCondition match_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until a user-defined match condition function object, when + applied to the data contained in the dynamic buffer sequence, indicates + a successful match. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + 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 + async_read_some function, and is known as a composed operation. + If the match condition function object already indicates a match, this + asynchronous operation completes immediately. The program must ensure that + the stream performs no other read operations (such as async_read, async_read_until, + the stream's async_read_some function, or any other composed operations + that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
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<typename DynamicBuffer_v1::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. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer sequence's
+  // get area that have been fully consumed by the match
+  // function. O if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond that which matched the function object. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent async_read_until operation to examine. +

+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ 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. +

+
+ + Examples +
+

+ To asynchronously read data into a std::string + until whitespace is encountered: +

+
typedef asio::buffers_iterator<
+    asio::const_buffer> 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);
+}
+...
+void handler(const asio::error_code& e, std::size_t size);
+...
+std::string data;
+asio::async_read_until(s, data, match_whitespace, handler);
+
+

+ To asynchronously read data into a std::string + 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
+...
+void handler(const asio::error_code& e, std::size_t size);
+...
+std::string data;
+asio::async_read_until(s, data, match_char('a'), handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload5.html new file mode 100644 index 0000000..0441d17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload5.html @@ -0,0 +1,211 @@ + + + +async_read_until (5 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a streambuf until it + contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    char delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >());
+
+

+ This function is used to asynchronously read data into the specified streambuf + until the streambuf's get area contains the specified delimiter. It is + an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The get area of the streambuf contains the specified delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + If the streambuf's get area already contains the delimiter, this asynchronous + operation completes immediately. The program must ensure that the stream + performs no other read operations (such as async_read, async_read_until, + the stream's async_read_some function, or any other composed operations + that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
b
+

+ A streambuf object into which the data will be read. Ownership of + the streambuf is retained by the caller, which must guarantee that + it remains valid until the completion handler is called. +

+
delim
+

+ The delimiter character. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the streambuf's get
+  // area up to and including the delimiter.
+  // 0 if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_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 async_read_until operation + to examine. +

+
+ + Example +
+

+ To asynchronously read data into a streambuf until a newline is encountered: +

+
asio::streambuf b;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::istream is(&b);
+    std::string line;
+    std::getline(is, line);
+    ...
+  }
+}
+...
+asio::async_read_until(s, b, '\n', handler);
+
+

+ After the async_read_until + operation completes successfully, the buffer b + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
+
+

+ The call to std::getline then extracts the data up to + and including the newline (which is discarded), so that the string line contains: +

+
{ 'a', 'b', ..., 'c' }
+
+

+ The remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload6.html new file mode 100644 index 0000000..10aa8f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload6.html @@ -0,0 +1,211 @@ + + + +async_read_until (6 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a streambuf until it + contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    string_view delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >());
+
+

+ This function is used to asynchronously read data into the specified streambuf + until the streambuf's get area contains the specified delimiter. It is + an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The get area of the streambuf contains the specified delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + If the streambuf's get area already contains the delimiter, this asynchronous + operation completes immediately. The program must ensure that the stream + performs no other read operations (such as async_read, async_read_until, + the stream's async_read_some function, or any other composed operations + that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
b
+

+ A streambuf object into which the data will be read. Ownership of + the streambuf is retained by the caller, which must guarantee that + it remains valid until the completion handler is called. +

+
delim
+

+ The delimiter string. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the streambuf's get
+  // area up to and including the delimiter.
+  // 0 if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_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 async_read_until operation + to examine. +

+
+ + Example +
+

+ To asynchronously read data into a streambuf until a newline is encountered: +

+
asio::streambuf b;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::istream is(&b);
+    std::string line;
+    std::getline(is, line);
+    ...
+  }
+}
+...
+asio::async_read_until(s, b, "\r\n", handler);
+
+

+ After the async_read_until + operation completes successfully, the buffer b + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to std::getline then extracts the data up to + and including the newline (which is discarded), so that the string line contains: +

+
{ 'a', 'b', ..., 'c', '\r' }
+
+

+ The remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload7.html new file mode 100644 index 0000000..f8712bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload7.html @@ -0,0 +1,215 @@ + + + +async_read_until (7 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a streambuf until some + part of its data matches a regular expression. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename Traits,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    const boost::basic_regex< char, Traits > & expr,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >());
+
+

+ This function is used to asynchronously read data into the specified streambuf + until the streambuf's get area contains some data that matches a regular + expression. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + 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 + async_read_some function, and is known as a composed operation. + If the streambuf's get area already contains data that matches the regular + expression, this asynchronous operation completes immediately. The program + must ensure that the stream performs no other read operations (such as + async_read, async_read_until, the stream's async_read_some function, or + any other composed operations that perform reads) until this operation + completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
b
+

+ A streambuf object into which the data will be read. Ownership of + the streambuf is retained by the caller, which must guarantee that + it remains valid until the completion handler is called. +

+
expr
+

+ The regular expression. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the streambuf's get
+  // area up to and including the substring
+  // that matches the regular. expression.
+  // 0 if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_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 async_read_until + operation to examine. +

+
+ + Example +
+

+ To asynchronously read data into a streambuf until a CR-LF sequence is + encountered: +

+
asio::streambuf b;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::istream is(&b);
+    std::string line;
+    std::getline(is, line);
+    ...
+  }
+}
+...
+asio::async_read_until(s, b, boost::regex("\r\n"), handler);
+
+

+ After the async_read_until + operation completes successfully, the buffer b + contains the data which matched the regular expression: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to std::getline then extracts the data up to + and including the newline (which is discarded), so that the string line contains: +

+
{ 'a', 'b', ..., 'c', '\r' }
+
+

+ The remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload8.html new file mode 100644 index 0000000..2221390 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload8.html @@ -0,0 +1,260 @@ + + + +async_read_until (8 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a streambuf until a function + object indicates a match. +

+
template<
+    typename AsyncReadStream,
+    typename Allocator,
+    typename MatchCondition,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    MatchCondition match_condition,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0);
+
+

+ This function is used to asynchronously 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. It is an + initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + 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 + async_read_some function, and is known as a composed operation. + If the match condition function object already indicates a match, this + asynchronous operation completes immediately. The program must ensure that + the stream performs no other read operations (such as async_read, async_read_until, + the stream's async_read_some function, or any other composed operations + that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
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. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the streambuf's get
+  // area that have been fully consumed by the
+  // match function. O if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Remarks +
+

+ After a successful async_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 async_read_until + operation to examine. +

+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ 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. +

+
+ + Examples +
+

+ To asynchronously read data into a streambuf until whitespace is encountered: +

+
typedef asio::buffers_iterator<
+    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);
+}
+...
+void handler(const asio::error_code& e, std::size_t size);
+...
+asio::streambuf b;
+asio::async_read_until(s, b, match_whitespace, handler);
+
+

+ To asynchronously 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
+...
+void handler(const asio::error_code& e, std::size_t size);
+...
+asio::streambuf b;
+asio::async_read_until(s, b, match_char('a'), handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload9.html new file mode 100644 index 0000000..388b6e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_read_until/overload9.html @@ -0,0 +1,216 @@ + + + +async_read_until (9 of 12 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to read data into a dynamic buffer sequence + until it contains a specified delimiter. +

+
template<
+    typename AsyncReadStream,
+    typename DynamicBuffer_v2,
+    typename ReadToken = default_completion_token_t<        typename AsyncReadStream::executor_type>>
+DEDUCED async_read_until(
+    AsyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    char delim,
+    ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to asynchronously read data into the specified dynamic + buffer sequence until the dynamic buffer sequence's get area contains the + specified delimiter. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_read_some function, and is known as a composed operation. + If the dynamic buffer sequence's get area already contains the delimiter, + this asynchronous operation completes immediately. The program must ensure + that the stream performs no other read operations (such as async_read, + async_read_until, the stream's async_read_some function, or any other composed + operations that perform reads) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the AsyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 completion handler is called. +

+
delim
+

+ The delimiter character. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // The number of bytes in the dynamic buffer sequence's
+  // get area up to and including the delimiter.
+  // 0 if an error occurred.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ After a successful async_read_until operation, the dynamic buffer sequence + may contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent async_read_until + operation to examine. +

+
+ + Example +
+

+ To asynchronously read data into a std::string + until a newline is encountered: +

+
std::string data;
+...
+void handler(const asio::error_code& e, std::size_t size)
+{
+  if (!e)
+  {
+    std::string line = data.substr(0, n);
+    data.erase(0, n);
+    ...
+  }
+}
+...
+asio::async_read_until(s, data, '\n', handler);
+
+

+ After the async_read_until + operation completes successfully, the buffer data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer data + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + async_read_until operation. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncReadStream + type's async_read_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result.html b/Packages/asio-1.36.0/doc/asio/reference/async_result.html new file mode 100644 index 0000000..46f130b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result.html @@ -0,0 +1,226 @@ + + + +async_result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An interface for customising the behaviour of an initiating function. +

+
template<
+    typename CompletionToken,
+    typename... Signatures>
+class async_result
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ completion_handler_type +

+ 		+

+ (Legacy.) The concrete completion handler type for the specific + signature. +

+
+

+ return_type +

+ 		+

+ (Legacy.) The return type of the initiating function. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_result [constructor] +

+ 		+

+ (Legacy.) Construct an async result from a given handler. +

+
+

+ get +

+ 		+

+ (Legacy.) Obtain the value to be returned from the initiating function. +

+
+

+ initiate [static] +

+ 		+

+ Initiate the asynchronous operation that will produce the result, + and obtain the value to be returned from the initiating function. +

+
+

+ The async_result + trait is a customisation point that is used within the initiating function + for an asynchronous operation. + The trait combines: +

+
    +
  • + the completion signature (or signatures) that describe the arguments + that an asynchronous operation will pass to a completion handler; +
    • +
  • + the completion + token type supplied by the caller; and +
    • +
  • + the operation's internal implementation. +
    • +
+

+ Specialisations of the trait must satisfy the async_result + requirements, and are reponsible for determining: +

+
    +
  • + the concrete completion handler type to be called at the end of the asynchronous + operation; +
    • +
  • + the initiating function return type; +
    • +
  • + how the return value of the initiating function is obtained; and +
    • +
  • + how and when to launch the operation by invoking the supplied initiation + function object. +
    • +
+

+ This template may be specialised for user-defined completion token types. + The primary template assumes that the CompletionToken is the already a concrete + completion handler. +

+
+ + Remarks +
+

+ For backwards compatibility, the primary template implements member types + and functions that are associated with legacy forms of the async_result trait. These are annotated + as "Legacy" in the documentation below. User specialisations of + this trait do not need to implement these in order to satisfy the async_result + requirements. +

+

+ In general, implementers of asynchronous operations should use the async_initiate + function rather than using the async_result trait directly. +

+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result/async_result.html b/Packages/asio-1.36.0/doc/asio/reference/async_result/async_result.html new file mode 100644 index 0000000..1864d19 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result/async_result.html @@ -0,0 +1,48 @@ + + + +async_result::async_result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +(Legacy.) + Construct an async result from a given handler. +

+
async_result(
+    completion_handler_type & h);
+
+

+ When using a specalised async_result, the constructor + has an opportunity to initialise some state associated with the completion + handler, which is then returned from the initiating function. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result/completion_handler_type.html b/Packages/asio-1.36.0/doc/asio/reference/async_result/completion_handler_type.html new file mode 100644 index 0000000..be91419 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result/completion_handler_type.html @@ -0,0 +1,52 @@ + + + +async_result::completion_handler_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +(Legacy.) + The concrete completion handler type for the specific signature. +

+
typedef CompletionToken completion_handler_type;
+
+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result/get.html b/Packages/asio-1.36.0/doc/asio/reference/async_result/get.html new file mode 100644 index 0000000..3804422 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result/get.html @@ -0,0 +1,42 @@ + + + +async_result::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +(Legacy.) Obtain the value + to be returned from the initiating function. +

+
return_type get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result/initiate.html b/Packages/asio-1.36.0/doc/asio/reference/async_result/initiate.html new file mode 100644 index 0000000..54a20e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result/initiate.html @@ -0,0 +1,50 @@ + + + +async_result::initiate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Initiate the asynchronous + operation that will produce the result, and obtain the value to be returned + from the initiating function. +

+
template<
+    typename Initiation,
+    typename RawCompletionToken,
+    typename... Args>
+static return_type initiate(
+    Initiation && initiation,
+    RawCompletionToken && token,
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result/return_type.html b/Packages/asio-1.36.0/doc/asio/reference/async_result/return_type.html new file mode 100644 index 0000000..d5059d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result/return_type.html @@ -0,0 +1,52 @@ + + + +async_result::return_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +(Legacy.) + The return type of the initiating function. +

+
typedef void return_type;
+
+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_.html new file mode 100644 index 0000000..2ffbdf6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_.html @@ -0,0 +1,157 @@ + + + +async_result< std::packaged_task< Result(Args...)>, Signature > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Partial specialisation of async_result + for std::packaged_task. +

+
template<
+    typename Result,
+    typename... Args,
+    typename Signature>
+class async_result< std::packaged_task< Result(Args...)>, Signature >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ completion_handler_type +

+ 		+

+ The packaged task is the concrete completion handler type. +

+
+

+ return_type +

+ 		+

+ The return type of the initiating function is the future obtained + from the packaged task. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_result +

+ 		+

+ The constructor extracts the future from the packaged task. +

+
+

+ get +

+ 		+

+ Returns the packaged task's future. +

+
+
+ + Requirements +
+

+ Header: asio/packaged_task.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/async_result.html b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/async_result.html new file mode 100644 index 0000000..e6c263e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/async_result.html @@ -0,0 +1,44 @@ + + + +async_result< std::packaged_task< Result(Args...)>, Signature >::async_result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The constructor + extracts the future from the packaged task. +

+
async_result(
+    completion_handler_type & h);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/completion_handler_type.html b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/completion_handler_type.html new file mode 100644 index 0000000..364af64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/completion_handler_type.html @@ -0,0 +1,53 @@ + + + +async_result< std::packaged_task< Result(Args...)>, Signature >::completion_handler_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The packaged + task is the concrete completion handler type. +

+
typedef std::packaged_task< Result(Args...)> completion_handler_type;
+
+
+ + Requirements +
+

+ Header: asio/packaged_task.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/get.html b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/get.html new file mode 100644 index 0000000..23cc8b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/get.html @@ -0,0 +1,43 @@ + + + +async_result< std::packaged_task< Result(Args...)>, Signature >::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns the packaged + task's future. +

+
return_type get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/return_type.html b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/return_type.html new file mode 100644 index 0000000..eae2a24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_result_lt__std__packaged_task_lt__Result_lp_Args_ellipsis__rp__gt__comma__Signature__gt_/return_type.html @@ -0,0 +1,53 @@ + + + +async_result< std::packaged_task< Result(Args...)>, Signature >::return_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The return type + of the initiating function is the future obtained from the packaged task. +

+
typedef std::future< Result > return_type;
+
+
+ + Requirements +
+

+ Header: asio/packaged_task.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write.html b/Packages/asio-1.36.0/doc/asio/reference/async_write.html new file mode 100644 index 0000000..0e0a3a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write.html @@ -0,0 +1,181 @@ + + + +async_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The async_write function + is a composed asynchronous operation that writes a certain amount of data + to a stream before completion. +

+

+ Start an asynchronous operation to write all of the supplied data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write a certain amount of data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename ConstBufferSequence,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write all of the supplied data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write a certain amount of data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write all of the supplied data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename Allocator,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write a certain amount of data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename Allocator,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write all of the supplied data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write a certain amount of data to a stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/write.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload1.html new file mode 100644 index 0000000..60c25af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload1.html @@ -0,0 +1,165 @@ + + + +async_write (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write all of the supplied data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
buffers
+

+ One or more buffers containing the data to be written. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::async_write(s, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload2.html new file mode 100644 index 0000000..f18ea35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload2.html @@ -0,0 +1,190 @@ + + + +async_write (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write a certain amount of data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename ConstBufferSequence,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
buffers
+

+ One or more buffers containing the data to be written. 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 completion handler is called. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest async_write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's async_write_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::async_write(s,
+   asio::buffer(data, size),
+   asio::transfer_at_least(32),
+   handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload3.html new file mode 100644 index 0000000..511b395 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload3.html @@ -0,0 +1,152 @@ + + + +async_write (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write all of the supplied data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. 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 completion handler is called. Successfully + written data is automatically consumed from the buffers. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload4.html new file mode 100644 index 0000000..d4283bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload4.html @@ -0,0 +1,174 @@ + + + +async_write (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write a certain amount of data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. 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 completion handler is called. Successfully + written data is automatically consumed from the buffers. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest async_write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's async_write_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload5.html new file mode 100644 index 0000000..f33a0e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload5.html @@ -0,0 +1,149 @@ + + + +async_write (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write all of the supplied data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename Allocator,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
b
+

+ A basic_streambuf + object from which data will be written. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload6.html new file mode 100644 index 0000000..ee0311e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload6.html @@ -0,0 +1,171 @@ + + + +async_write (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write a certain amount of data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename Allocator,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
b
+

+ A basic_streambuf + object from which data will be written. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest async_write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's async_write_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload7.html new file mode 100644 index 0000000..4587c95 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload7.html @@ -0,0 +1,151 @@ + + + +async_write (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write all of the supplied data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< !is_completion_condition< decay_t< WriteToken > >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. 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 completion handler is called. Successfully + written data is automatically consumed from the buffers. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload8.html new file mode 100644 index 0000000..f2cc20d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write/overload8.html @@ -0,0 +1,173 @@ + + + +async_write (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write a certain amount of data to a + stream. +

+
template<
+    typename AsyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<typename AsyncWriteStream::executor_type>>
+DEDUCED async_write(
+    AsyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncWriteStream::executor_type >(),
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a stream. It is an initiating function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + async_write_some function, and is known as a composed operation. + The program must ensure that the stream performs no other write operations + (such as async_write, the stream's async_write_some function, or any other + composed operations that perform writes) until this operation completes. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the AsyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. 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 completion handler is called. Successfully + written data is automatically consumed from the buffers. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest async_write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's async_write_some function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncWriteStream + type's async_write_some + operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write_at.html b/Packages/asio-1.36.0/doc/asio/reference/async_write_at.html new file mode 100644 index 0000000..1da87ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write_at.html @@ -0,0 +1,121 @@ + + + +async_write_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The async_write_at function + is a composed asynchronous operation that writes a certain amount of data + at the specified offset before completion. +

+

+ Start an asynchronous operation to write all of the supplied data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< !is_completion_condition< WriteToken >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write all of the supplied data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< !is_completion_condition< WriteToken >::value >  = 0);
+  » more...
+
+

+ Start an asynchronous operation to write a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/write_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload1.html new file mode 100644 index 0000000..914bd42 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload1.html @@ -0,0 +1,171 @@ + + + +async_write_at (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write all of the supplied data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< !is_completion_condition< WriteToken >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a random access device at a specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + async_write_some_at function, and is known as a composed operation. + The program must ensure that the device performs no overlapping + write operations (such as async_write_at, the device's async_write_some_at + function, or any other composed operations that perform writes) until this + operation completes. Operations are overlapping if the regions defined + by their offsets, and the numbers of bytes to write, intersect. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the AsyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more buffers containing the data to be written. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::async_write_at(d, 42, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessWriteDevice + type's async_write_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload2.html new file mode 100644 index 0000000..8ffa437 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload2.html @@ -0,0 +1,196 @@ + + + +async_write_at (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a random access device at a specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + async_write_some_at function, and is known as a composed operation. + The program must ensure that the device performs no overlapping + write operations (such as async_write_at, the device's async_write_some_at + function, or any other composed operations that perform writes) until this + operation completes. Operations are overlapping if the regions defined + by their offsets, and the numbers of bytes to write, intersect. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the AsyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more buffers containing the data to be written. 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 completion handler is called. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest async_write_some_at operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the device's async_write_some_at function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::async_write_at(d, 42,
+   asio::buffer(data, size),
+   asio::transfer_at_least(32),
+   handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessWriteDevice + type's async_write_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload3.html new file mode 100644 index 0000000..dab9743 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload3.html @@ -0,0 +1,156 @@ + + + +async_write_at (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write all of the supplied data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< !is_completion_condition< WriteToken >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a random access device at a specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + async_write_some_at function, and is known as a composed operation. + The program must ensure that the device performs no overlapping + write operations (such as async_write_at, the device's async_write_some_at + function, or any other composed operations that perform writes) until this + operation completes. Operations are overlapping if the regions defined + by their offsets, and the numbers of bytes to write, intersect. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the AsyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
b
+

+ A basic_streambuf + object from which data will be written. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessWriteDevice + type's async_write_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload4.html new file mode 100644 index 0000000..eafdfaa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/async_write_at/overload4.html @@ -0,0 +1,178 @@ + + + +async_write_at (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous operation to write a certain amount of data at the + specified offset. +

+
template<
+    typename AsyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename CompletionCondition,
+    typename WriteToken = default_completion_token_t<        typename AsyncRandomAccessWriteDevice::executor_type>>
+DEDUCED async_write_at(
+    AsyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    WriteToken && token = default_completion_token_t< typename AsyncRandomAccessWriteDevice::executor_type >(),
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to asynchronously write a certain number of bytes + of data to a random access device at a specified offset. It is an initiating + function for an asynchronous + operation, and always returns immediately. The asynchronous operation + will continue until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + async_write_some_at function, and is known as a composed operation. + The program must ensure that the device performs no overlapping + write operations (such as async_write_at, the device's async_write_some_at + function, or any other composed operations that perform writes) until this + operation completes. Operations are overlapping if the regions defined + by their offsets, and the numbers of bytes to write, intersect. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the AsyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
b
+

+ A basic_streambuf + object from which data will be written. Ownership of the streambuf + is retained by the caller, which must guarantee that it remains valid + until the completion handler is called. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest async_write_some_at operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the device's async_write_some_at function. +

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // Number of bytes written from the buffers. If an error
+  // occurred, this will be less than the sum of the buffer sizes.
+  std::size_t bytes_transferred
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the AsyncRandomAccessWriteDevice + type's async_write_some_at operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/asynchronous_operations.html b/Packages/asio-1.36.0/doc/asio/reference/asynchronous_operations.html new file mode 100644 index 0000000..2d0261d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/asynchronous_operations.html @@ -0,0 +1,602 @@ + + + +Requirements on asynchronous operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This section uses the names Alloc1, + Alloc2, alloc1, + alloc2, Args, + CompletionHandler, completion_handler, Executor1, + Executor2, ex1, ex2, + f, i, + N, Signatures, + token, initiation, + Initiation, Ti, + ti, work1, + and work2 as placeholders + for specifying the requirements below. +

+
+ + General + asynchronous operation concepts +
+

+ An initiating function is a function which may be called + to start an asynchronous operation. A completion handler + is a function object that will be invoked, at most once, with the result + of the asynchronous operation. +

+

+ The lifecycle of an asynchronous operation is comprised of the following + events and phases: +

+

+ — Event 1: The asynchronous operation is started by a call to the initiating + function. +

+

+ — Phase 1: The asynchronous operation is now outstanding. +

+

+ — Event 2: The externally observable side effects of the asynchronous operation, + if any, are fully established. The completion handler is submitted to an + executor. +

+

+ — Phase 2: The asynchronous operation is now completed. +

+

+ — Event 3: The completion handler is called with the result of the asynchronous + operation. +

+

+ In this library, all functions with the prefix async_ + are initiating functions. +

+
+ + Completion + tokens and handlers +
+

+ Initiating functions: +

+

+ — are function templates with template parameter CompletionToken; +

+

+ — accept, as the final parameter, a completion token object + token of type CompletionToken; +

+

+ — specify one or more completion signatures, referred + to below as a variadic pack of call signatures (C++Std [func.def]) Signatures, that determine the possible + argument sets to the completion handler. +

+

+ In this library, initiating functions specify a Completion signature + element that defines the call signatures Signatures. + The Completion signature elements in this library may + have named parameters, and the results of an asynchronous operation may be + specified in terms of these names. +

+

+ Completion token behaviour is determined through specialisation of the async_result trait. These specialisations + must have the form: +

+
template <class CompletionToken, class... Signatures>
+struct async_result
+{
+  template<
+      class Initiation,
+      class RawCompletionToken,
+      class... Args
+    >
+  static initiating-fn-return-type initiate(
+      Initiation&& initiation,
+      RawCompletionToken&& token,
+      Args&&... args
+    );
+};
+
+

+ An async_result specialisation’s + implementation of the initiate() static member function must: +

+
    +
  • + Transform the completion token into an object completion_handler + of type CompletionHandler. + The type CompletionHandler + must satisfy the requirements of Destructible + (C++Std [destructible]) and MoveConstructible + (C++Std [moveconstructible]), and be callable with the specified call + signatures. +
    • +
  • +

    + Cause the invocation of the function object initiation + as if by calling: +

    +
    std::forward<Initiation>(initiation)(
+    std::move(completion_handler),
+    std::forward<Args>(args)...);
+
    +
    • +
+

+ This invocation of initiation + may be immediate, or it may be deferred (e.g. to support lazy evaluation). + If initiation is deferred, + the initiation and args... + objects must be decay-copied and moved as required. +

+

+ The async_result trait must + be specialised for the decayed type of a CompletionToken. + A helper function template async_initiate + is provided to simplify correct invocation of async_result<>::initiate + for the appropriate specialisation: +

+
template<
+    class CompletionToken,
+    completion_signature... Signatures,
+    class Initiation,
+    class... Args
+  >
+DEDUCED async_initiate(
+    Initiation&& initiation,
+    CompletionToken& token,
+    Args&&... args
+  );
+
+

+ [Note: No other requirements are placed on the type + CompletionToken. —end + note] +

+
+ + Automatic + deduction of initiating function return type +
+

+ An initiating function returns async_initiate<CompletionToken, + Signatures...>(initiation, token, unspecified-args...), + where initiation is a function + object of unspecified type Initiation, + which is defined as: +

+
class Initiation
+{
+public:
+  using executor_type = Executor; // optional
+  executor_type get_executor() const noexcept; // optional
+
+  template <class CompletionHandler, unspecified-args...>
+    void operator()(CompletionHandler&& completion_handler, unspecified-args...) const;
+};
+
+

+ For the sake of exposition, this library sometimes annotates functions with + a return type DEDUCED. For every + function declaration that returns DEDUCED, + the meaning is equivalent to an automatically deduced return type, having + the type of the expression async_initiate<CompletionToken, Signatures...>(initiation, + token, unspecified-args...). +

+

+ [Example: Given an asynchronous operation with a single + Completion signature void(R1 r1, R2 r2), an initiating function meeting these requirements + may be implemented as follows: +

+
template<class CompletionToken>
+auto async_xyz(T1 t1, T2 t2, CompletionToken&& token)
+{
+  return async_initiate<CompletionToken, void(R1, R2)>(
+      [](auto completion_handler, T1 t1, T2 t2)
+      {
+        // initiate the operation and cause completion_handler to be invoked
+        // with the result
+      }, token, std::move(t1), std::move(t2));
+}
+
+

+ The concepts completion_token_for + and completion_handler_for + may also be used to improve compile-time diagnostics: +

+
template<completion_token_for<void(R1, R2)> CompletionToken>
+auto async_xyz(T1 t1, T2 t2, CompletionToken&& token)
+{
+  return async_initiate<CompletionToken, void(R1, R2)>(
+      [](completion_handler_for<void(R1, R2)> auto completion_handler, T1 t1, T2 t2)
+      {
+        // initiate the operation and cause completion_handler to be invoked
+        // with the result
+      }, token, std::move(t1), std::move(t2));
+}
+
+

+ Initiation functions may also be implemented using the async_result + trait directly: +

+
template<class CompletionToken>
+auto async_xyz(T1 t1, T2 t2, CompletionToken&& token)
+{
+  return async_result<decay_t<CompletionToken>, void(R1, R2)>::initiate(
+      [](auto completion_handler, T1 t1, T2 t2)
+      {
+        // initiate the operation and cause completion_handler to be invoked
+        // with the result
+      }, forward<CompletionToken>(token), std::move(t1), std::move(t2));
+}
+
+

+ Note the use of decay_t and + forward applied to the CompletionToken type. However, the first + form is preferred as it preserves compatibility with legacy completion token + requirements. +

+

+ —end example] +

+
+ + Lifetime + of initiating function arguments +
+

+ Unless otherwise specified, the lifetime of arguments to initiating functions + shall be treated as follows: +

+

+ — If the parameter has a pointer type or has a type of lvalue reference to + non-const, the implementation may assume the validity of the pointee or referent, + respectively, until the completion handler is invoked. [Note: + In other words, the program must guarantee the validity of the argument until + the completion handler is invoked. —end note] +

+

+ — Otherwise, the implementation must not assume the validity of the argument + after the initiating function completes. [Note: In other + words, the program is not required to guarantee the validity of the argument + after the initiating function completes. —end note] The + implementation may make copies of the argument, and all copies shall be destroyed + no later than immediately after invocation of the completion handler. +

+
+ + Non-blocking + requirements on initiating functions +
+

+ An initiating function shall not block (C++Std [defns.block]) the calling + thread pending completion of the outstanding operation. +

+

+ [Note: Initiating functions may still block the calling + thread for other reasons. For example, an initiating function may lock a + mutex in order to synchronize access to shared data. —end note] +

+
+ + Associated + executor +
+

+ Certain objects that participate in asynchronous operations have an associated + executor. These are obtained as specified in the sections below. +

+
+ + Associated + I/O executor +
+

+ An asynchronous operation has an associated executor satisfying the Executor + requirements. If not otherwise specified by the asynchronous operation, this + associated executor is an object of type system_executor. +

+

+ All asynchronous operations in this library have an associated I/O executor + object that is determined as follows: +

+

+ — If the initiating function is a member function, the associated executor + is that returned by the get_executor + member function on the same object. +

+

+ — If the initiating function is not a member function, the associated executor + is that returned by the get_executor + member function of the first argument to the initiating function. +

+

+ The operation's associated I/O executor may be exposed via the Initiation function object's executor_type type alias and get_executor() + member function. +

+

+ Let Executor1 be the type + of the associated executor. Let ex1 + be a value of type Executor1, + representing the associated executor object obtained as described above. +

+
+ + Associated + completion handler executor +
+

+ A completion handler object of type CompletionHandler + has an associated executor of type Executor2 + satisfying the Executor requirements. + The type Executor2 is associated_executor_t<CompletionHandler, + Executor1>. + Let ex2 be a value of type + Executor2 obtained by performing + get_associated_executor(completion_handler, + ex1). +

+
+ + Associated + immediate completion executor +
+

+ A completion handler object of type CompletionHandler + has an associated immediate executor of type Executor3 + satisfying the Executor requirements. + The type Executor3 is associated_immediate_executor_t<CompletionHandler, + Executor1>. + Let ex3 be a value of type + Executor3 obtained by performing + get_associated_immediate_executor(completion_handler, ex1). +

+
+ + Outstanding + work +
+

+ If the operation does not complete immediately (that is, the operation does + not complete within the thread of execution calling the initiating function, + before the initiating function returns) then, until the asynchronous operation + has completed, the asynchronous operation shall maintain: +

+

+ — an object work1 of type + executor_work_guard<Executor1>, + initialized as work1(ex1), and + where work1.owns_work() == true; and +

+

+ — an object work2 of type + executor_work_guard<Executor2>, + initialized as work2(ex2), and + where work2.owns_work() == true. +

+
+ + Allocation + of intermediate storage +
+

+ Asynchronous operations may allocate memory. [Note: + Such as a data structure to store copies of the completion_handler + object and the initiating function's arguments. —end note] +

+

+ Let Alloc1 be a type, satisfying + the ProtoAllocator + requirements, that represents the asynchronous operation's default allocation + strategy. [Note: Typically std::allocator<void>. + —end note] Let alloc1 + be a value of type Alloc1. +

+

+ A completion handler object of type CompletionHandler + has an associated allocator object alloc2 + of type Alloc2 satisfying + the ProtoAllocator + requirements. The type Alloc2 + is associated_allocator_t<CompletionHandler, Alloc1>. Let alloc2 + be a value of type Alloc2 + obtained by performing get_associated_allocator(completion_handler, alloc1). +

+

+ The asynchronous operations defined in this library: +

+

+ — If required, allocate memory using only the completion handler's associated + allocator. +

+

+ — Prior to completion handler execution, deallocate any memory allocated using + the completion handler's associated allocator. +

+

+ [Note: The implementation may perform operating system + or underlying API calls that perform memory allocations not using the associated + allocator. Invocations of the allocator functions may not introduce data + races (See C++Std [res.on.data.races]). —end note] +

+
+ + Execution + of completion handler on completion of asynchronous operation +
+

+ Let Args... + be the argument types of a completion signature in Signatures... and let N + be sizeof...(Args). + Let i be in the range [0,N). + Let Ti be the ith + type in Args... + and let ti be the ith + completion handler argument associated with Ti. +

+

+ Let f be a function object + that: +

+

+ — is callable as f(), + and when so called invokes completion_handler + as if by std::move(completion_handler)(forward<T0>(t0), + ..., forward<TN-1>(tN-1)); +

+

+ — has an associated executor such that get_associated_executor(f, + ex1) + returns an executor that is equal to ex2; + and +

+

+ — has an associated allocator such that get_associated_allocator(f, + alloc1) + returns an allocator that is equal to alloc2. +

+

+ [Note: These associated executor and allocator requirements + on f are typically implemented + by specialising the associator traits for f + so that they forward to the associator traits for completion_handler. + —end note] +

+

+ If an asynchonous operation completes immediately (that is, the operation + completes within the thread of execution calling the initiating function, + and before the initiating function returns), the completion handler shall + be submitted for execution as if by performing post(ex1, + std::move(f)). +

+

+ Otherwise, when the operation completes, the completion handler shall be + submitted for execution as if by performing dispatch(ex2, + std::move(f)). +

+
+ + Optimisation + of immediate completion +
+

+ If an asynchronous operation completes immediately then, as an optimisation, + the operation may either: +

+

+ — obtain the associated immediate completion executor ex3 + by performing get_associated_immediate_executor(completion_handler, ex1), + and then submit the completion handler for execution as if by performing + dispatch(ex3, std::move(f)); + or +

+

+ — submit the completion handler for execution by performing the expression + post(ex2, std::move(f)), + if that expression is well-formed. +

+

+ [Note: If completion_handler + does not customise the associated immediate executor, the behaviour of the + first optimisation is equivalent to post(ex1, + std::move(f)). —end note] +

+
+ + Completion + handlers and exceptions +
+

+ Completion handlers are permitted to throw exceptions. The effect of any + exception propagated from the execution of a completion handler is determined + by the executor which is executing the completion handler. +

+
+ + Default + completion tokens +
+

+ Every I/O executor type has an associated default completion token type. + This is specified via the default_completion_token + trait. This trait may be used in asynchronous operation declarations as follows: +

+
template <
+    typename IoObject,
+    typename CompletionToken =
+      typename default_completion_token<
+        typename IoObject::executor_type
+      >::type
+  >
+auto async_xyz(
+    IoObject& io_object,
+    CompletionToken&& token =
+      typename default_completion_token<
+        typename IoObject::executor_type
+      >::type{}
+  );
+
+

+ If not specialised, this trait type is void, + meaning no default completion token type is available for the given I/O executor. +

+

+ [Example: The default_completion_token + trait is specialised for the use_awaitable + completion token so that it may be used as shown in the following example: +

+
auto socket = use_awaitable.as_default_on(tcp::socket(my_context));
+// ...
+co_await socket.async_connect(my_endpoint); // Defaults to use_awaitable.
+
+

+ In this example, the type of the socket + object is transformed from tcp::socket + to have an I/O executor with the default completion token set to use_awaitable. +

+

+ Alternatively, the socket type may be computed directly: +

+
using tcp_socket = use_awaitable_t<>::as_default_on_t<tcp::socket>;
+tcp_socket socket(my_context);
+// ...
+co_await socket.async_connect(my_endpoint); // Defaults to use_awaitable.
+
+

+ —end example] +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/asynchronous_socket_operations.html b/Packages/asio-1.36.0/doc/asio/reference/asynchronous_socket_operations.html new file mode 100644 index 0000000..ff62616 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/asynchronous_socket_operations.html @@ -0,0 +1,79 @@ + + + +Requirements on asynchronous socket operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In this library, asynchronous socket operations are + those member functions having prefix async_. +

+

+ For an object s, a program + may initiate asynchronous socket operations such that there are multiple + simultaneously outstanding asynchronous operations. +

+

+ When there are multiple outstanding asynchronous read + operations on s: +

+

+ — having no argument flags + of type socket_base::message_flags, or +

+

+ — having an argument flags + of type socket_base::message_flags but where (flags & socket_base::message_out_of_band) + == 0 +

+

+ then the buffers are filled + in the order in which these operations were issued. The order of invocation + of the completion handlers for these operations is unspecified. +

+

+ When there are multiple outstanding asynchronous read + operations on s having + an argument flags of type + socket_base::message_flags where (flags & socket_base::message_out_of_band) + != 0 + then the buffers are filled + in the order in which these operations were issued. +

+

+ When there are multiple outstanding asynchronous write + operations on s, the + buffers are transmitted in + the order in which these operations were issued. The order of invocation + of the completion handlers for these operations is unspecified. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable.html new file mode 100644 index 0000000..64e2611 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable.html @@ -0,0 +1,179 @@ + + + +awaitable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The return type of a coroutine or asynchronous operation. +

+
template<
+    typename T,
+    typename Executor = any_io_executor>
+class awaitable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+

+ The executor type that will be used for the coroutine. +

+
+

+ value_type +

+ 		+

+ The type of the awaited value. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ awaitable + [constructor] +

+ 		+

+ Default constructor.
—
Move constructor. +

+
+

+ operator= +

+ 		+

+ Move assignment. +

+
+

+ valid +

+ 		+

+ Checks if the awaitable refers to a future result. +

+
+

+ ~awaitable + [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/_awaitable.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/_awaitable.html new file mode 100644 index 0000000..d67b24d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/_awaitable.html @@ -0,0 +1,41 @@ + + + +awaitable::~awaitable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~awaitable();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable.html new file mode 100644 index 0000000..0f1324d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable.html @@ -0,0 +1,49 @@ + + + +awaitable::awaitable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
constexpr awaitable();
+  » more...
+
+

+ Move constructor. +

+
awaitable(
+    awaitable && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable/overload1.html new file mode 100644 index 0000000..f55ab01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable/overload1.html @@ -0,0 +1,41 @@ + + + +awaitable::awaitable (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr awaitable();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable/overload2.html new file mode 100644 index 0000000..f50a66b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/awaitable/overload2.html @@ -0,0 +1,42 @@ + + + +awaitable::awaitable (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
awaitable(
+    awaitable && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/executor_type.html new file mode 100644 index 0000000..8374056 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/executor_type.html @@ -0,0 +1,52 @@ + + + +awaitable::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The executor + type that will be used for the coroutine. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/operator_eq_.html new file mode 100644 index 0000000..598eaff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/operator_eq_.html @@ -0,0 +1,42 @@ + + + +awaitable::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move assignment. +

+
awaitable & operator=(
+    awaitable && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/valid.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/valid.html new file mode 100644 index 0000000..620e73f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/valid.html @@ -0,0 +1,42 @@ + + + +awaitable::valid + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Checks if the awaitable refers + to a future result. +

+
bool valid() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/awaitable/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/awaitable/value_type.html new file mode 100644 index 0000000..ef0defd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/awaitable/value_type.html @@ -0,0 +1,52 @@ + + + +awaitable::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of the awaited + value. +

+
typedef T value_type;
+
+
+ + Requirements +
+

+ Header: asio/awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bad_executor.html b/Packages/asio-1.36.0/doc/asio/reference/bad_executor.html new file mode 100644 index 0000000..c9ed793 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bad_executor.html @@ -0,0 +1,103 @@ + + + +bad_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Exception thrown when trying to access an empty polymorphic executor. +

+
class bad_executor :
+  public exception
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bad_executor [constructor] +

+ 		+

+ Constructor. +

+
+

+ what +

+ 		+

+ Obtain message associated with exception. +

+
+
+ + Requirements +
+

+ Header: asio/executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bad_executor/bad_executor.html b/Packages/asio-1.36.0/doc/asio/reference/bad_executor/bad_executor.html new file mode 100644 index 0000000..7fa70a5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bad_executor/bad_executor.html @@ -0,0 +1,41 @@ + + + +bad_executor::bad_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
bad_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bad_executor/what.html b/Packages/asio-1.36.0/doc/asio/reference/bad_executor/what.html new file mode 100644 index 0000000..a81e698 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bad_executor/what.html @@ -0,0 +1,42 @@ + + + +bad_executor::what + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain message associated + with exception. +

+
virtual const char * what() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket.html new file mode 100644 index 0000000..f2c2485 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket.html @@ -0,0 +1,916 @@ + + + +basic_datagram_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides datagram-oriented socket functionality. +

+
template<
+    typename Protocol,
+    typename Executor>
+class basic_datagram_socket :
+  public basic_socket< Protocol, Executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close if + unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_datagram_socket [constructor] +

+ 		+

+ 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.
—
Move-construct a basic_datagram_socket + from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets the + non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_datagram_socket from another.
—
+ Move-assign a basic_datagram_socket from a socket of another protocol + type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive a datagram with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send a datagram to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, or + to have pending error conditions. +

+
+

+ ~basic_datagram_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_datagram_socket + class template provides asynchronous and blocking datagram-oriented socket + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single socket + object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/_basic_datagram_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/_basic_datagram_socket.html new file mode 100644 index 0000000..9a7ff7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/_basic_datagram_socket.html @@ -0,0 +1,46 @@ + + + +basic_datagram_socket::~basic_datagram_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the socket. +

+
~basic_datagram_socket();
+
+

+ This function destroys the socket, cancelling any outstanding asynchronous + operations associated with the socket as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign.html new file mode 100644 index 0000000..e41fc30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign.html @@ -0,0 +1,51 @@ + + + +basic_datagram_socket::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign/overload1.html new file mode 100644 index 0000000..09083e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign/overload1.html @@ -0,0 +1,46 @@ + + + +basic_datagram_socket::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign/overload2.html new file mode 100644 index 0000000..6c268b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/assign/overload2.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_connect.html new file mode 100644 index 0000000..65d7cac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_connect.html @@ -0,0 +1,142 @@ + + + +basic_datagram_socket::async_connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Start + an asynchronous connect. +

+
template<
+    typename ConnectToken = default_completion_token_t<executor_type>>
+DEDUCED async_connect(
+    const endpoint_type & peer_endpoint,
+    ConnectToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously connect a socket to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ The socket is automatically opened if it is not already open. If the connect + fails, and the socket was automatically opened, the socket is not returned + to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. Copies + will be made of the endpoint object as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void connect_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Connect succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.async_connect(endpoint, connect_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive.html new file mode 100644 index 0000000..b405098 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive.html @@ -0,0 +1,57 @@ + + + +basic_datagram_socket::async_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous receive on a connected socket. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive/overload1.html new file mode 100644 index 0000000..471ac79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive/overload1.html @@ -0,0 +1,140 @@ + + + +basic_datagram_socket::async_receive (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive on a connected socket. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the datagram + socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_receive operation can only be used with a connected socket. + Use the async_receive_from function to receive data on an unconnected + datagram socket. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive/overload2.html new file mode 100644 index 0000000..ff35dbb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive/overload2.html @@ -0,0 +1,131 @@ + + + +basic_datagram_socket::async_receive (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive on a connected socket. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the datagram + socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_receive operation can only be used with a connected socket. + Use the async_receive_from function to receive data on an unconnected + datagram socket. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from.html new file mode 100644 index 0000000..824d79f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from.html @@ -0,0 +1,59 @@ + + + +basic_datagram_socket::async_receive_from + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from/overload1.html new file mode 100644 index 0000000..0ddc357 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from/overload1.html @@ -0,0 +1,140 @@ + + + +basic_datagram_socket::async_receive_from (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive a datagram. It is an + initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the datagram. Ownership of the sender_endpoint object is retained + by the caller, which must guarantee that it is valid until the + completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive_from(
+   asio::buffer(data, size), sender_endpoint, handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from/overload2.html new file mode 100644 index 0000000..b135231 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_receive_from/overload2.html @@ -0,0 +1,130 @@ + + + +basic_datagram_socket::async_receive_from (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive a datagram. It is an + initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the datagram. Ownership of the sender_endpoint object is retained + by the caller, which must guarantee that it is valid until the + completion handler is called. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send.html new file mode 100644 index 0000000..848e932 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send.html @@ -0,0 +1,57 @@ + + + +basic_datagram_socket::async_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous send on a connected socket. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send/overload1.html new file mode 100644 index 0000000..b18bad7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send/overload1.html @@ -0,0 +1,138 @@ + + + +basic_datagram_socket::async_send (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send on a connected socket. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send data on the datagram socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_send operation can only be used with a connected socket. Use + the async_send_to function to send data on an unconnected datagram socket. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.async_send(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send/overload2.html new file mode 100644 index 0000000..fe66c01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send/overload2.html @@ -0,0 +1,129 @@ + + + +basic_datagram_socket::async_send (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send on a connected socket. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send data on the datagram socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. 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 completion handler is called. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_send operation can only be used with a connected socket. Use + the async_send_to function to send data on an unconnected datagram socket. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to.html new file mode 100644 index 0000000..319eba9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to.html @@ -0,0 +1,59 @@ + + + +basic_datagram_socket::async_send_to + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to/overload1.html new file mode 100644 index 0000000..e53b85d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to/overload1.html @@ -0,0 +1,140 @@ + + + +basic_datagram_socket::async_send_to (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send a datagram to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. 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 completion handler is + called. +

+
destination
+

+ The remote endpoint to which the data will be sent. Copies will + be made of the endpoint as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
asio::ip::udp::endpoint destination(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.async_send_to(
+    asio::buffer(data, size), destination, handler);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to/overload2.html new file mode 100644 index 0000000..3c6937d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_send_to/overload2.html @@ -0,0 +1,128 @@ + + + +basic_datagram_socket::async_send_to (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send a datagram to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. 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 completion handler is + called. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
destination
+

+ The remote endpoint to which the data will be sent. Copies will + be made of the endpoint as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_wait.html new file mode 100644 index 0000000..368b888 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/async_wait.html @@ -0,0 +1,137 @@ + + + +basic_datagram_socket::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Asynchronously + wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for a socket to enter + a ready to read, write or error condition state. It is an initiating function + for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+...
+socket.async_wait(asio::ip::tcp::socket::wait_read, wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark.html new file mode 100644 index 0000000..bbbebfd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::at_mark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+  » more...
+
+bool at_mark(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark/overload1.html new file mode 100644 index 0000000..9ecac7b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark/overload1.html @@ -0,0 +1,69 @@ + + + +basic_datagram_socket::at_mark (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark/overload2.html new file mode 100644 index 0000000..b8361fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/at_mark/overload2.html @@ -0,0 +1,70 @@ + + + +basic_datagram_socket::at_mark (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark(
+    asio::error_code & ec) const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available.html new file mode 100644 index 0000000..71e4628 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::available + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the number of bytes available for reading. +

+
std::size_t available() const;
+  » more...
+
+std::size_t available(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available/overload1.html new file mode 100644 index 0000000..e6d99a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available/overload1.html @@ -0,0 +1,70 @@ + + + +basic_datagram_socket::available (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available() const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available/overload2.html new file mode 100644 index 0000000..0f8aef1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/available/overload2.html @@ -0,0 +1,71 @@ + + + +basic_datagram_socket::available (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available(
+    asio::error_code & ec) const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket.html new file mode 100644 index 0000000..7b2744a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket.html @@ -0,0 +1,123 @@ + + + +basic_datagram_socket::basic_datagram_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_datagram_socket + without opening it. +

+
explicit basic_datagram_socket(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_datagram_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct and open a basic_datagram_socket. +

+
basic_datagram_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_datagram_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_datagram_socket, opening + it and binding it to the given local endpoint. +

+
basic_datagram_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_datagram_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct a basic_datagram_socket on an existing + native socket. +

+
basic_datagram_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_datagram_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_datagram_socket from another. +

+
basic_datagram_socket(
+    basic_datagram_socket && other);
+  » more...
+
+

+ Move-construct a basic_datagram_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_datagram_socket(
+    basic_datagram_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload1.html new file mode 100644 index 0000000..e0e131a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload1.html @@ -0,0 +1,61 @@ + + + +basic_datagram_socket::basic_datagram_socket (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_datagram_socket without + opening it. +

+
basic_datagram_socket(
+    const executor_type & ex);
+
+

+ This constructor creates a datagram socket without opening it. The open() + function must be called before data can be sent or received on the socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload10.html new file mode 100644 index 0000000..911cb60 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload10.html @@ -0,0 +1,73 @@ + + + +basic_datagram_socket::basic_datagram_socket (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_datagram_socket from a + socket of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_datagram_socket(
+    basic_datagram_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a datagram socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_datagram_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_datagram_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload2.html new file mode 100644 index 0000000..f3459d0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload2.html @@ -0,0 +1,65 @@ + + + +basic_datagram_socket::basic_datagram_socket (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_datagram_socket without + opening it. +

+
template<
+    typename ExecutionContext>
+basic_datagram_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a datagram socket without opening it. The open() + function must be called before data can be sent or received on the socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload3.html new file mode 100644 index 0000000..be6aeaf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload3.html @@ -0,0 +1,77 @@ + + + +basic_datagram_socket::basic_datagram_socket (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_datagram_socket. +

+
basic_datagram_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+
+

+ This constructor creates and opens a datagram socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload4.html new file mode 100644 index 0000000..ee65f11 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload4.html @@ -0,0 +1,81 @@ + + + +basic_datagram_socket::basic_datagram_socket (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_datagram_socket. +

+
template<
+    typename ExecutionContext>
+basic_datagram_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates and opens a datagram socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload5.html new file mode 100644 index 0000000..7af4293 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload5.html @@ -0,0 +1,81 @@ + + + +basic_datagram_socket::basic_datagram_socket (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_datagram_socket, opening + it and binding it to the given local endpoint. +

+
basic_datagram_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+
+

+ This constructor creates a datagram socket and automatically opens it + bound to the specified endpoint on the local machine. The protocol used + is the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the datagram socket will + be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload6.html new file mode 100644 index 0000000..871d4f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload6.html @@ -0,0 +1,85 @@ + + + +basic_datagram_socket::basic_datagram_socket (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_datagram_socket, opening + it and binding it to the given local endpoint. +

+
template<
+    typename ExecutionContext>
+basic_datagram_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a datagram socket and automatically opens it + bound to the specified endpoint on the local machine. The protocol used + is the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the datagram socket will + be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload7.html new file mode 100644 index 0000000..53c185b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload7.html @@ -0,0 +1,84 @@ + + + +basic_datagram_socket::basic_datagram_socket (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_datagram_socket on an + existing native socket. +

+
basic_datagram_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+

+ This constructor creates a datagram socket object to hold an existing + native socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload8.html new file mode 100644 index 0000000..2b041d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload8.html @@ -0,0 +1,88 @@ + + + +basic_datagram_socket::basic_datagram_socket (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_datagram_socket on an + existing native socket. +

+
template<
+    typename ExecutionContext>
+basic_datagram_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a datagram socket object to hold an existing + native socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload9.html new file mode 100644 index 0000000..0c93a23 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/basic_datagram_socket/overload9.html @@ -0,0 +1,68 @@ + + + +basic_datagram_socket::basic_datagram_socket (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_datagram_socket from another. +

+
basic_datagram_socket(
+    basic_datagram_socket && other);
+
+

+ This constructor moves a datagram socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_datagram_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_datagram_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind.html new file mode 100644 index 0000000..b11edaa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind.html @@ -0,0 +1,49 @@ + + + +basic_datagram_socket::bind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bind + the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+  » more...
+
+void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind/overload1.html new file mode 100644 index 0000000..bee79d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind/overload1.html @@ -0,0 +1,84 @@ + + + +basic_datagram_socket::bind (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind/overload2.html new file mode 100644 index 0000000..556c7f8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bind/overload2.html @@ -0,0 +1,81 @@ + + + +basic_datagram_socket::bind (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+asio::error_code ec;
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/broadcast.html new file mode 100644 index 0000000..9f45923 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/broadcast.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to permit sending of broadcast messages. +

+
typedef implementation_defined broadcast;
+
+

+ Implements the SOL_SOCKET/SO_BROADCAST socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bytes_readable.html new file mode 100644 index 0000000..5a5de27 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/bytes_readable.html @@ -0,0 +1,68 @@ + + + +basic_datagram_socket::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +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. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::bytes_readable command(true);
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel.html new file mode 100644 index 0000000..55ef8b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the socket. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel/overload1.html new file mode 100644 index 0000000..ddbc629 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel/overload1.html @@ -0,0 +1,105 @@ + + + +basic_datagram_socket::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel/overload2.html new file mode 100644 index 0000000..321b877 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/cancel/overload2.html @@ -0,0 +1,106 @@ + + + +basic_datagram_socket::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close.html new file mode 100644 index 0000000..c63a0bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the socket. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close/overload1.html new file mode 100644 index 0000000..8e62785 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close/overload1.html @@ -0,0 +1,71 @@ + + + +basic_datagram_socket::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close();
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close/overload2.html new file mode 100644 index 0000000..b87d7d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/close/overload2.html @@ -0,0 +1,85 @@ + + + +basic_datagram_socket::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect.html new file mode 100644 index 0000000..7ca75ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect.html @@ -0,0 +1,49 @@ + + + +basic_datagram_socket::connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Connect + the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+  » more...
+
+void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect/overload1.html new file mode 100644 index 0000000..de5044d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect/overload1.html @@ -0,0 +1,90 @@ + + + +basic_datagram_socket::connect (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.connect(endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect/overload2.html new file mode 100644 index 0000000..ecd93d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/connect/overload2.html @@ -0,0 +1,87 @@ + + + +basic_datagram_socket::connect (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+asio::error_code ec;
+socket.connect(endpoint, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/debug.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/debug.html new file mode 100644 index 0000000..6c35a7f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/debug.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::debug + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to enable socket-level debugging. +

+
typedef implementation_defined debug;
+
+

+ Implements the SOL_SOCKET/SO_DEBUG socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/do_not_route.html new file mode 100644 index 0000000..d046ab3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/do_not_route.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to prevent routing, use local interfaces only. +

+
typedef implementation_defined do_not_route;
+
+

+ Implements the SOL_SOCKET/SO_DONTROUTE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/enable_connection_aborted.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/enable_connection_aborted.html new file mode 100644 index 0000000..c557ba9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/enable_connection_aborted.html @@ -0,0 +1,81 @@ + + + +basic_datagram_socket::enable_connection_aborted + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to report aborted connections on accept. +

+
typedef implementation_defined enable_connection_aborted;
+
+

+ Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with asio::error::connection_aborted. + By default the option is false. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/endpoint_type.html new file mode 100644 index 0000000..fbe6b02 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_datagram_socket::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/executor_type.html new file mode 100644 index 0000000..ba27271 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_datagram_socket::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_executor.html new file mode 100644 index 0000000..49b714d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_executor.html @@ -0,0 +1,45 @@ + + + +basic_datagram_socket::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option.html new file mode 100644 index 0000000..de429a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option.html @@ -0,0 +1,53 @@ + + + +basic_datagram_socket::get_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+  » more...
+
+template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option/overload1.html new file mode 100644 index 0000000..31444eb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option/overload1.html @@ -0,0 +1,89 @@ + + + +basic_datagram_socket::get_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option/overload2.html new file mode 100644 index 0000000..2f1dd67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/get_option/overload2.html @@ -0,0 +1,86 @@ + + + +basic_datagram_socket::get_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+asio::error_code ec;
+socket.get_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control.html new file mode 100644 index 0000000..d18355e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control.html @@ -0,0 +1,53 @@ + + + +basic_datagram_socket::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control/overload1.html new file mode 100644 index 0000000..f113768 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control/overload1.html @@ -0,0 +1,89 @@ + + + +basic_datagram_socket::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control/overload2.html new file mode 100644 index 0000000..85b0c57 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/io_control/overload2.html @@ -0,0 +1,86 @@ + + + +basic_datagram_socket::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+asio::error_code ec;
+socket.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/is_open.html new file mode 100644 index 0000000..41915f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/is_open.html @@ -0,0 +1,45 @@ + + + +basic_datagram_socket::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Determine + whether the socket is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/keep_alive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/keep_alive.html new file mode 100644 index 0000000..8f44b28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/keep_alive.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::keep_alive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to send keep-alives. +

+
typedef implementation_defined keep_alive;
+
+

+ Implements the SOL_SOCKET/SO_KEEPALIVE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/linger.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/linger.html new file mode 100644 index 0000000..44d5828 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/linger.html @@ -0,0 +1,81 @@ + + + +basic_datagram_socket::linger + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to specify whether the socket lingers on close if unsent data is + present. +

+
typedef implementation_defined linger;
+
+

+ Implements the SOL_SOCKET/SO_LINGER socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option(true, 30);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option;
+socket.get_option(option);
+bool is_set = option.enabled();
+unsigned short timeout = option.timeout();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint.html new file mode 100644 index 0000000..15df0c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::local_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+  » more...
+
+endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint/overload1.html new file mode 100644 index 0000000..597a8a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_datagram_socket::local_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint/overload2.html new file mode 100644 index 0000000..2d9e9e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/local_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_datagram_socket::local_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. Returns a + default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer.html new file mode 100644 index 0000000..2399ed5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_datagram_socket::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer/overload1.html new file mode 100644 index 0000000..50424dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer/overload1.html @@ -0,0 +1,58 @@ + + + +basic_datagram_socket::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ 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 basic_socket + cannot contain any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer/overload2.html new file mode 100644 index 0000000..e495a57 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer/overload2.html @@ -0,0 +1,58 @@ + + + +basic_datagram_socket::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_socket cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer_type.html new file mode 100644 index 0000000..aa56718 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/lowest_layer_type.html @@ -0,0 +1,834 @@ + + + +basic_datagram_socket::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +A + basic_socket + is always the lowest layer. +

+
typedef basic_socket< Protocol, Executor > lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_socket [constructor] +

+ 		+

+ Construct a basic_socket without opening it.
—
Construct + and open a basic_socket.
—
Construct a basic_socket, + opening it and binding it to the given local endpoint.
+ —
Construct a basic_socket on an existing native socket. +
—
Move-construct a basic_socket from another.
+ —
Move-construct a basic_socket from a socket of another + protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket from another.
—
Move-assign + a basic_socket from a socket of another protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_socket [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/max_listen_connections.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/max_listen_connections.html new file mode 100644 index 0000000..c9fe014 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/max_listen_connections.html @@ -0,0 +1,45 @@ + + + +basic_datagram_socket::max_listen_connections + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +The + maximum length of the queue of pending incoming connections. +

+
static const int max_listen_connections = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_do_not_route.html new file mode 100644 index 0000000..783aa41 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_do_not_route.html @@ -0,0 +1,45 @@ + + + +basic_datagram_socket::message_do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specify + that the data should not be subject to routing. +

+
static const int message_do_not_route = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_end_of_record.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_end_of_record.html new file mode 100644 index 0000000..a70db17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_end_of_record.html @@ -0,0 +1,45 @@ + + + +basic_datagram_socket::message_end_of_record + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specifies + that the data marks the end of a record. +

+
static const int message_end_of_record = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_flags.html new file mode 100644 index 0000000..9f207e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_flags.html @@ -0,0 +1,55 @@ + + + +basic_datagram_socket::message_flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Bitmask + type for flags that can be passed to send and receive operations. +

+
typedef int message_flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_out_of_band.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_out_of_band.html new file mode 100644 index 0000000..511b62b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_out_of_band.html @@ -0,0 +1,45 @@ + + + +basic_datagram_socket::message_out_of_band + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Process + out-of-band data. +

+
static const int message_out_of_band = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_peek.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_peek.html new file mode 100644 index 0000000..c03b920 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/message_peek.html @@ -0,0 +1,45 @@ + + + +basic_datagram_socket::message_peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Peek + at incoming data without removing it from the input queue. +

+
static const int message_peek = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_handle.html new file mode 100644 index 0000000..d7aa89e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_handle.html @@ -0,0 +1,50 @@ + + + +basic_datagram_socket::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the native socket representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + socket. This is intended to allow access to native socket functionality + that is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_handle_type.html new file mode 100644 index 0000000..ee85507 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_datagram_socket::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a socket. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking.html new file mode 100644 index 0000000..17b3108 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_datagram_socket::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload1.html new file mode 100644 index 0000000..08dfa9c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload1.html @@ -0,0 +1,144 @@ + + + +basic_datagram_socket::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+
+

+ This function is used to retrieve the non-blocking mode of the underlying + native socket. This mode has no effect on the behaviour of the socket + object's synchronous operations. +

+
+ + Return + Value +
+

+ true if the underlying socket + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + Remarks +
+

+ The current non-blocking mode is cached by the socket object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native socket. +

+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload2.html new file mode 100644 index 0000000..179fe00 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload2.html @@ -0,0 +1,159 @@ + + + +basic_datagram_socket::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload3.html new file mode 100644 index 0000000..2d8e2b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/native_non_blocking/overload3.html @@ -0,0 +1,150 @@ + + + +basic_datagram_socket::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking.html new file mode 100644 index 0000000..0e6c45d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_datagram_socket::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the socket. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload1.html new file mode 100644 index 0000000..5c70989 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload1.html @@ -0,0 +1,64 @@ + + + +basic_datagram_socket::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the socket. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the socket's synchronous + operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload2.html new file mode 100644 index 0000000..800695e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload2.html @@ -0,0 +1,83 @@ + + + +basic_datagram_socket::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload3.html new file mode 100644 index 0000000..c7399d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/non_blocking/overload3.html @@ -0,0 +1,75 @@ + + + +basic_datagram_socket::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open.html new file mode 100644 index 0000000..649504b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open.html @@ -0,0 +1,49 @@ + + + +basic_datagram_socket::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open + the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+  » more...
+
+void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open/overload1.html new file mode 100644 index 0000000..b11f575 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open/overload1.html @@ -0,0 +1,81 @@ + + + +basic_datagram_socket::open (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open/overload2.html new file mode 100644 index 0000000..9d9ee43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/open/overload2.html @@ -0,0 +1,78 @@ + + + +basic_datagram_socket::open (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying which protocol is to be used. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::error_code ec;
+socket.open(asio::ip::tcp::v4(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_.html new file mode 100644 index 0000000..5bb8d8a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_.html @@ -0,0 +1,56 @@ + + + +basic_datagram_socket::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_datagram_socket + from another. +

+
basic_datagram_socket & operator=(
+    basic_datagram_socket && other);
+  » more...
+
+

+ Move-assign a basic_datagram_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_datagram_socket & > operator=(
+    basic_datagram_socket< Protocol1, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_/overload1.html new file mode 100644 index 0000000..4c6b651 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_datagram_socket::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_datagram_socket from another. +

+
basic_datagram_socket & operator=(
+    basic_datagram_socket && other);
+
+

+ This assignment operator moves a datagram socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_datagram_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_datagram_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_/overload2.html new file mode 100644 index 0000000..f554f81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +basic_datagram_socket::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_datagram_socket from a + socket of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_datagram_socket & > operator=(
+    basic_datagram_socket< Protocol1, Executor1 > && other);
+
+

+ This assignment operator moves a datagram socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_datagram_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_datagram_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/out_of_band_inline.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/out_of_band_inline.html new file mode 100644 index 0000000..87097b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/out_of_band_inline.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::out_of_band_inline + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for putting received out-of-band data inline. +

+
typedef implementation_defined out_of_band_inline;
+
+

+ Implements the SOL_SOCKET/SO_OOBINLINE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option;
+socket.get_option(option);
+bool value = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/protocol_type.html new file mode 100644 index 0000000..b20cf80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_datagram_socket::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive.html new file mode 100644 index 0000000..e703145 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive.html @@ -0,0 +1,61 @@ + + + +basic_datagram_socket::receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Receive + some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload1.html new file mode 100644 index 0000000..f25177a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload1.html @@ -0,0 +1,105 @@ + + + +basic_datagram_socket::receive (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to receive data on the datagram socket. The function + call will block until data has been received successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The receive operation can only be used with a connected socket. Use the + receive_from function to receive data on an unconnected datagram socket. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.receive(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload2.html new file mode 100644 index 0000000..094c8f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload2.html @@ -0,0 +1,96 @@ + + + +basic_datagram_socket::receive (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags);
+
+

+ This function is used to receive data on the datagram socket. The function + call will block until data has been received successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The receive operation can only be used with a connected socket. Use the + receive_from function to receive data on an unconnected datagram socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload3.html new file mode 100644 index 0000000..583de13 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive/overload3.html @@ -0,0 +1,88 @@ + + + +basic_datagram_socket::receive (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to receive data on the datagram socket. The function + call will block until data has been received successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Remarks +
+

+ The receive operation can only be used with a connected socket. Use the + receive_from function to receive data on an unconnected datagram socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_buffer_size.html new file mode 100644 index 0000000..36d410e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::receive_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive buffer size of a socket. +

+
typedef implementation_defined receive_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_RCVBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from.html new file mode 100644 index 0000000..1843f5a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from.html @@ -0,0 +1,64 @@ + + + +basic_datagram_socket::receive_from + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Receive + a datagram with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload1.html new file mode 100644 index 0000000..e270b6d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload1.html @@ -0,0 +1,104 @@ + + + +basic_datagram_socket::receive_from (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive a datagram with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint);
+
+

+ This function is used to receive a datagram. The function call will block + until data has been received successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the datagram. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
asio::ip::udp::endpoint sender_endpoint;
+socket.receive_from(
+    asio::buffer(data, size), sender_endpoint);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload2.html new file mode 100644 index 0000000..2272c4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload2.html @@ -0,0 +1,93 @@ + + + +basic_datagram_socket::receive_from (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive a datagram with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags);
+
+

+ This function is used to receive a datagram. The function call will block + until data has been received successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the datagram. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload3.html new file mode 100644 index 0000000..79eb756 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_from/overload3.html @@ -0,0 +1,85 @@ + + + +basic_datagram_socket::receive_from (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive a datagram with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to receive a datagram. The function call will block + until data has been received successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the datagram. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_low_watermark.html new file mode 100644 index 0000000..0cc0eaa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/receive_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::receive_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive low watermark. +

+
typedef implementation_defined receive_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_RCVLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release.html new file mode 100644 index 0000000..fe52668 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native socket. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release/overload1.html new file mode 100644 index 0000000..0cd2585 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release/overload1.html @@ -0,0 +1,72 @@ + + + +basic_datagram_socket::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release/overload2.html new file mode 100644 index 0000000..5452656 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/release/overload2.html @@ -0,0 +1,73 @@ + + + +basic_datagram_socket::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint.html new file mode 100644 index 0000000..d9817d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_datagram_socket::remote_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+  » more...
+
+endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint/overload1.html new file mode 100644 index 0000000..6f1d679 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_datagram_socket::remote_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint/overload2.html new file mode 100644 index 0000000..dbb39a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/remote_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_datagram_socket::remote_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. Returns + a default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/reuse_address.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/reuse_address.html new file mode 100644 index 0000000..41f21e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/reuse_address.html @@ -0,0 +1,80 @@ + + + +basic_datagram_socket::reuse_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from 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. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send.html new file mode 100644 index 0000000..4cf8b96 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send.html @@ -0,0 +1,61 @@ + + + +basic_datagram_socket::send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Send + some data on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload1.html new file mode 100644 index 0000000..126bbdc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload1.html @@ -0,0 +1,105 @@ + + + +basic_datagram_socket::send (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to send data on the datagram socket. The function + call will block until the data has been sent successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The send operation can only be used with a connected socket. Use the + send_to function to send data on an unconnected datagram socket. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.send(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload2.html new file mode 100644 index 0000000..01ed633 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload2.html @@ -0,0 +1,96 @@ + + + +basic_datagram_socket::send (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+
+

+ This function is used to send data on the datagram socket. The function + call will block until the data has been sent successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The send operation can only be used with a connected socket. Use the + send_to function to send data on an unconnected datagram socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload3.html new file mode 100644 index 0000000..000aa82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send/overload3.html @@ -0,0 +1,88 @@ + + + +basic_datagram_socket::send (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to send data on the datagram socket. The function + call will block until the data has been sent successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Remarks +
+

+ The send operation can only be used with a connected socket. Use the + send_to function to send data on an unconnected datagram socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_buffer_size.html new file mode 100644 index 0000000..bfe8685 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::send_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send buffer size of a socket. +

+
typedef implementation_defined send_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_SNDBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_low_watermark.html new file mode 100644 index 0000000..04a2f15 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_datagram_socket::send_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send low watermark. +

+
typedef implementation_defined send_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_SNDLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to.html new file mode 100644 index 0000000..e5f1ba0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to.html @@ -0,0 +1,64 @@ + + + +basic_datagram_socket::send_to + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Send + a datagram to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload1.html new file mode 100644 index 0000000..718a237 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload1.html @@ -0,0 +1,104 @@ + + + +basic_datagram_socket::send_to (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send a datagram to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination);
+
+

+ This function is used to send a datagram to the specified remote endpoint. + The function call will block until the data has been sent successfully + or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. +

+
destination
+

+ The remote endpoint to which the data will be sent. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
asio::ip::udp::endpoint destination(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.send_to(asio::buffer(data, size), destination);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload2.html new file mode 100644 index 0000000..cf9065f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload2.html @@ -0,0 +1,93 @@ + + + +basic_datagram_socket::send_to (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send a datagram to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags);
+
+

+ This function is used to send a datagram to the specified remote endpoint. + The function call will block until the data has been sent successfully + or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. +

+
destination
+

+ The remote endpoint to which the data will be sent. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload3.html new file mode 100644 index 0000000..85fee3f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/send_to/overload3.html @@ -0,0 +1,85 @@ + + + +basic_datagram_socket::send_to (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send a datagram to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to send a datagram to the specified remote endpoint. + The function call will block until the data has been sent successfully + or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. +

+
destination
+

+ The remote endpoint to which the data will be sent. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option.html new file mode 100644 index 0000000..618b1cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option.html @@ -0,0 +1,53 @@ + + + +basic_datagram_socket::set_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+  » more...
+
+template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option/overload1.html new file mode 100644 index 0000000..b8f54ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option/overload1.html @@ -0,0 +1,88 @@ + + + +basic_datagram_socket::set_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+socket.set_option(option);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option/overload2.html new file mode 100644 index 0000000..584b8cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/set_option/overload2.html @@ -0,0 +1,85 @@ + + + +basic_datagram_socket::set_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+asio::error_code ec;
+socket.set_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown.html new file mode 100644 index 0000000..798ad64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown.html @@ -0,0 +1,49 @@ + + + +basic_datagram_socket::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+  » more...
+
+void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown/overload1.html new file mode 100644 index 0000000..ba18edf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown/overload1.html @@ -0,0 +1,86 @@ + + + +basic_datagram_socket::shutdown (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.shutdown(asio::ip::tcp::socket::shutdown_send);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown/overload2.html new file mode 100644 index 0000000..080fe67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown/overload2.html @@ -0,0 +1,83 @@ + + + +basic_datagram_socket::shutdown (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.shutdown(asio::ip::tcp::socket::shutdown_send, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown_type.html new file mode 100644 index 0000000..73fc7b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/shutdown_type.html @@ -0,0 +1,71 @@ + + + +basic_datagram_socket::shutdown_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Different + ways a socket may be shutdown. +

+
enum shutdown_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
shutdown_receive
+

+ Shutdown the receive side of the socket. +

+
shutdown_send
+

+ Shutdown the send side of the socket. +

+
shutdown_both
+

+ Shutdown both send and receive on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait.html new file mode 100644 index 0000000..fadcdcc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait.html @@ -0,0 +1,50 @@ + + + +basic_datagram_socket::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait + for the socket to become ready to read, ready to write, or to have pending + error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait/overload1.html new file mode 100644 index 0000000..9c37d02 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait/overload1.html @@ -0,0 +1,74 @@ + + + +basic_datagram_socket::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.wait(asio::ip::tcp::socket::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait/overload2.html new file mode 100644 index 0000000..0363a21 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait/overload2.html @@ -0,0 +1,80 @@ + + + +basic_datagram_socket::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.wait(asio::ip::tcp::socket::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait_type.html new file mode 100644 index 0000000..669698c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket/wait_type.html @@ -0,0 +1,74 @@ + + + +basic_datagram_socket::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a socket to become ready to read. +

+
wait_write
+

+ Wait for a socket to become ready to write. +

+
wait_error
+

+ Wait for a socket to have error conditions pending. +

+
+
+

+ For use with basic_socket::wait() and basic_socket::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket__rebind_executor.html new file mode 100644 index 0000000..b7ea0df --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_datagram_socket::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the socket type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The socket type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket__rebind_executor/other.html new file mode 100644 index 0000000..5cb810a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_datagram_socket__rebind_executor/other.html @@ -0,0 +1,913 @@ + + + +basic_datagram_socket::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + socket type when rebound to the specified executor. +

+
typedef basic_datagram_socket< Protocol, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_datagram_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_datagram_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_datagram_socket from another.
—
+ Move-assign a basic_datagram_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive a datagram with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send a datagram to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_datagram_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_datagram_socket class template + provides asynchronous and blocking datagram-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_datagram_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer.html new file mode 100644 index 0000000..dfd6ff8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer.html @@ -0,0 +1,396 @@ + + + +basic_deadline_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ (Deprecated: Use basic_waitable_timer.) Provides + waitable timer functionality. +

+
template<
+    typename Time,
+    typename TimeTraits = asio::time_traits<Time>,
+    typename Executor = any_io_executor>
+class basic_deadline_timer
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ duration_type +

+ 		+

+ The duration type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_type +

+ 		+

+ The time type. +

+
+

+ traits_type +

+ 		+

+ The time traits type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_deadline_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a particular + expiry time relative to now.
—
Move-construct a basic_deadline_timer + from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_at +

+ 		+

+ Get the timer's expiry time as an absolute time.
—
+ Set the timer's expiry time as an absolute time. +

+
+

+ expires_from_now +

+ 		+

+ Get the timer's expiry time relative to now.
—
Set + the timer's expiry time relative to now. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_deadline_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_deadline_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ The basic_deadline_timer + class template provides the ability to perform a blocking or asynchronous + wait for a timer to expire. +

+

+ 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 deadline_timer typedef. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait: +

+
// Construct a timer without setting an expiry time.
+asio::deadline_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_from_now(boost::posix_time::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait: +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::deadline_timer timer(my_context,
+    boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + Changing + an active deadline_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: +

+
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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+
+ + Requirements +
+

+ Header: asio/basic_deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/_basic_deadline_timer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/_basic_deadline_timer.html new file mode 100644 index 0000000..b2ff57d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/_basic_deadline_timer.html @@ -0,0 +1,46 @@ + + + +basic_deadline_timer::~basic_deadline_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the timer. +

+
~basic_deadline_timer();
+
+

+ This function destroys the timer, cancelling any outstanding asynchronous + wait operations associated with the timer as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/async_wait.html new file mode 100644 index 0000000..53e42b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/async_wait.html @@ -0,0 +1,122 @@ + + + +basic_deadline_timer::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous wait on the timer. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function may be used to initiate an asynchronous wait against the + timer. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ For each call to async_wait(), the completion handler will be called + exactly once. The completion handler will be called when: +

+
    +
  • + The timer has expired. +
    • +
  • + The timer was cancelled, in which case the handler is passed the error + code asio::error::operation_aborted. +
    • +
+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the timer expires. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer.html new file mode 100644 index 0000000..c09de88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer.html @@ -0,0 +1,89 @@ + + + +basic_deadline_timer::basic_deadline_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
explicit basic_deadline_timer(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_deadline_timer(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Constructor to set a particular expiry time as an absolute time. +

+
basic_deadline_timer(
+    const executor_type & ex,
+    const time_type & expiry_time);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_deadline_timer(
+    ExecutionContext & context,
+    const time_type & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Constructor to set a particular expiry time relative to now. +

+
basic_deadline_timer(
+    const executor_type & ex,
+    const duration_type & expiry_time);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_deadline_timer(
+    ExecutionContext & context,
+    const duration_type & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_deadline_timer from another. +

+
basic_deadline_timer(
+    basic_deadline_timer && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload1.html new file mode 100644 index 0000000..0e0d9b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload1.html @@ -0,0 +1,63 @@ + + + +basic_deadline_timer::basic_deadline_timer (1 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
basic_deadline_timer(
+    const executor_type & ex);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the timer will use, by default, to dispatch + handlers for any asynchronous operations performed on the timer. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload2.html new file mode 100644 index 0000000..eda29b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload2.html @@ -0,0 +1,67 @@ + + + +basic_deadline_timer::basic_deadline_timer (2 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename ExecutionContext>
+basic_deadline_timer(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the timer + will use, by default, to dispatch handlers for any asynchronous + operations performed on the timer. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload3.html new file mode 100644 index 0000000..8825058 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload3.html @@ -0,0 +1,65 @@ + + + +basic_deadline_timer::basic_deadline_timer (3 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time as an absolute time. +

+
basic_deadline_timer(
+    const executor_type & ex,
+    const time_type & expiry_time);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the timer will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload4.html new file mode 100644 index 0000000..909fe36 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload4.html @@ -0,0 +1,69 @@ + + + +basic_deadline_timer::basic_deadline_timer (4 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time as an absolute time. +

+
template<
+    typename ExecutionContext>
+basic_deadline_timer(
+    ExecutionContext & context,
+    const time_type & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the timer + will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload5.html new file mode 100644 index 0000000..c433496 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload5.html @@ -0,0 +1,64 @@ + + + +basic_deadline_timer::basic_deadline_timer (5 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time relative to now. +

+
basic_deadline_timer(
+    const executor_type & ex,
+    const duration_type & expiry_time);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the timer will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload6.html new file mode 100644 index 0000000..dabd0cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload6.html @@ -0,0 +1,68 @@ + + + +basic_deadline_timer::basic_deadline_timer (6 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time relative to now. +

+
template<
+    typename ExecutionContext>
+basic_deadline_timer(
+    ExecutionContext & context,
+    const duration_type & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the timer + will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload7.html new file mode 100644 index 0000000..43055e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/basic_deadline_timer/overload7.html @@ -0,0 +1,68 @@ + + + +basic_deadline_timer::basic_deadline_timer (7 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_deadline_timer from another. +

+
basic_deadline_timer(
+    basic_deadline_timer && other);
+
+

+ This constructor moves a timer from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_deadline_timer object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_deadline_timer(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel.html new file mode 100644 index 0000000..1854d2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel.html @@ -0,0 +1,47 @@ + + + +basic_deadline_timer::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + any asynchronous operations that are waiting on the timer. +

+
std::size_t cancel();
+  » more...
+
+std::size_t cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel/overload1.html new file mode 100644 index 0000000..30b5b38 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel/overload1.html @@ -0,0 +1,91 @@ + + + +basic_deadline_timer::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
std::size_t cancel();
+
+

+ 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 asio::error::operation_aborted + error code. +

+

+ Cancelling the timer does not change the expiry time. +

+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel/overload2.html new file mode 100644 index 0000000..9b3102f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel/overload2.html @@ -0,0 +1,92 @@ + + + +basic_deadline_timer::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
std::size_t cancel(
+    asio::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 asio::error::operation_aborted + error code. +

+

+ Cancelling the timer does not change the expiry time. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + Remarks +
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one.html new file mode 100644 index 0000000..d806c38 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one.html @@ -0,0 +1,47 @@ + + + +basic_deadline_timer::cancel_one + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancels + one asynchronous operation that is waiting on the timer. +

+
std::size_t cancel_one();
+  » more...
+
+std::size_t cancel_one(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one/overload1.html new file mode 100644 index 0000000..22653d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one/overload1.html @@ -0,0 +1,91 @@ + + + +basic_deadline_timer::cancel_one (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
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 asio::error::operation_aborted error code. +

+

+ Cancelling the timer does not change the expiry time. +

+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. That is, either + 0 or 1. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +
    • +
+

+ These handlers can no longer be cancelled, and therefore are passed an + error code that indicates the successful completion of the wait operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one/overload2.html new file mode 100644 index 0000000..3dbff06 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/cancel_one/overload2.html @@ -0,0 +1,92 @@ + + + +basic_deadline_timer::cancel_one (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
std::size_t cancel_one(
+    asio::error_code & ec);
+
+

+ 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 asio::error::operation_aborted error code. +

+

+ Cancelling the timer does not change the expiry time. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. That is, either + 0 or 1. +

+
+ + 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. +
    • +
+

+ These handlers can no longer be cancelled, and therefore are passed an + error code that indicates the successful completion of the wait operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/duration_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/duration_type.html new file mode 100644 index 0000000..db244db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/duration_type.html @@ -0,0 +1,52 @@ + + + +basic_deadline_timer::duration_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + duration type. +

+
typedef traits_type::duration_type duration_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/executor_type.html new file mode 100644 index 0000000..608308c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_deadline_timer::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at.html new file mode 100644 index 0000000..1d27ceb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at.html @@ -0,0 +1,55 @@ + + + +basic_deadline_timer::expires_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the timer's expiry time as an absolute time. +

+
time_type expires_at() const;
+  » more...
+
+

+ Set the timer's expiry time as an absolute time. +

+
std::size_t expires_at(
+    const time_type & expiry_time);
+  » more...
+
+std::size_t expires_at(
+    const time_type & expiry_time,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload1.html new file mode 100644 index 0000000..8016b14 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload1.html @@ -0,0 +1,45 @@ + + + +basic_deadline_timer::expires_at (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the timer's expiry time as an absolute time. +

+
time_type expires_at() const;
+
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload2.html new file mode 100644 index 0000000..d55894d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload2.html @@ -0,0 +1,101 @@ + + + +basic_deadline_timer::expires_at (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the timer's expiry time as an absolute time. +

+
std::size_t expires_at(
+    const time_type & expiry_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 asio::error::operation_aborted error code. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload3.html new file mode 100644 index 0000000..389843c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_at/overload3.html @@ -0,0 +1,93 @@ + + + +basic_deadline_timer::expires_at (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the timer's expiry time as an absolute time. +

+
std::size_t expires_at(
+    const time_type & expiry_time,
+    asio::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 asio::error::operation_aborted error code. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now.html new file mode 100644 index 0000000..323d760 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now.html @@ -0,0 +1,55 @@ + + + +basic_deadline_timer::expires_from_now + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the timer's expiry time relative to now. +

+
duration_type expires_from_now() const;
+  » more...
+
+

+ Set the timer's expiry time relative to now. +

+
std::size_t expires_from_now(
+    const duration_type & expiry_time);
+  » more...
+
+std::size_t expires_from_now(
+    const duration_type & expiry_time,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload1.html new file mode 100644 index 0000000..316b3b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload1.html @@ -0,0 +1,45 @@ + + + +basic_deadline_timer::expires_from_now (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the timer's expiry time relative to now. +

+
duration_type expires_from_now() const;
+
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload2.html new file mode 100644 index 0000000..445bd58 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload2.html @@ -0,0 +1,101 @@ + + + +basic_deadline_timer::expires_from_now (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the timer's expiry time relative to now. +

+
std::size_t expires_from_now(
+    const duration_type & expiry_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 asio::error::operation_aborted error code. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload3.html new file mode 100644 index 0000000..06a92cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/expires_from_now/overload3.html @@ -0,0 +1,93 @@ + + + +basic_deadline_timer::expires_from_now (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the timer's expiry time relative to now. +

+
std::size_t expires_from_now(
+    const duration_type & expiry_time,
+    asio::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 asio::error::operation_aborted error code. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/get_executor.html new file mode 100644 index 0000000..2bd1991 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_deadline_timer::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/operator_eq_.html new file mode 100644 index 0000000..792b100 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/operator_eq_.html @@ -0,0 +1,71 @@ + + + +basic_deadline_timer::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_deadline_timer + from another. +

+
basic_deadline_timer & operator=(
+    basic_deadline_timer && other);
+
+

+ This assignment operator moves a timer from one object to another. Cancels + any outstanding asynchronous operations associated with the target object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_deadline_timer object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if constructed + using the basic_deadline_timer(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/time_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/time_type.html new file mode 100644 index 0000000..009a861 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/time_type.html @@ -0,0 +1,52 @@ + + + +basic_deadline_timer::time_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + time type. +

+
typedef traits_type::time_type time_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/traits_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/traits_type.html new file mode 100644 index 0000000..c26cd2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/traits_type.html @@ -0,0 +1,52 @@ + + + +basic_deadline_timer::traits_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + time traits type. +

+
typedef TimeTraits traits_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait.html new file mode 100644 index 0000000..134ce70 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait.html @@ -0,0 +1,47 @@ + + + +basic_deadline_timer::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + a blocking wait on the timer. +

+
void wait();
+  » more...
+
+void wait(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait/overload1.html new file mode 100644 index 0000000..2943a89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait/overload1.html @@ -0,0 +1,58 @@ + + + +basic_deadline_timer::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform a blocking wait on the timer. +

+
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. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait/overload2.html new file mode 100644 index 0000000..c5f039a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer/wait/overload2.html @@ -0,0 +1,59 @@ + + + +basic_deadline_timer::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform a blocking wait on the timer. +

+
void wait(
+    asio::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. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer__rebind_executor.html new file mode 100644 index 0000000..9539b93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_deadline_timer::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the timer type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The timer type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer__rebind_executor/other.html new file mode 100644 index 0000000..0b58a22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_deadline_timer__rebind_executor/other.html @@ -0,0 +1,392 @@ + + + +basic_deadline_timer::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + timer type when rebound to the specified executor. +

+
typedef basic_deadline_timer< Time, TimeTraits, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ duration_type +

+ 		+

+ The duration type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_type +

+ 		+

+ The time type. +

+
+

+ traits_type +

+ 		+

+ The time traits type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_deadline_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a + particular expiry time relative to now.
—
Move-construct + a basic_deadline_timer from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_at +

+ 		+

+ Get the timer's expiry time as an absolute time.
—
+ Set the timer's expiry time as an absolute time. +

+
+

+ expires_from_now +

+ 		+

+ Get the timer's expiry time relative to now.
—
Set + the timer's expiry time relative to now. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_deadline_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_deadline_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ The basic_deadline_timer + class template provides the ability to perform a blocking or asynchronous + wait for a timer to expire. +

+

+ 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 deadline_timer typedef. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait: +

+
// Construct a timer without setting an expiry time.
+asio::deadline_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_from_now(boost::posix_time::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait: +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::deadline_timer timer(my_context,
+    boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + Changing + an active deadline_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: +

+
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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+
+ + Requirements +
+

+ Header: asio/basic_deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file.html new file mode 100644 index 0000000..afe0ff7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file.html @@ -0,0 +1,517 @@ + + + +basic_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides file functionality. +

+
template<
+    typename Executor>
+class basic_file :
+  public file_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ basic_file [constructor] +

+ 		+

+ Construct a basic_file without opening it.
—
Construct + and open a basic_file.
—
Construct a basic_file on + an existing native file handle.
—
Construct a basic_file + on an existing native file.
—
Move-construct a basic_file + from another.
—
Move-construct a basic_file from a + file of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_file from another.
—
Move-assign + a basic_file from a file of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_file [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append + [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create + [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive + [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only + [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate + [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_file + class template provides functionality that is common to both stream-oriented + and random-access files. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/_basic_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/_basic_file.html new file mode 100644 index 0000000..d383761 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/_basic_file.html @@ -0,0 +1,46 @@ + + + +basic_file::~basic_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected destructor + to prevent deletion through this type. +

+
~basic_file();
+
+

+ This function destroys the file, cancelling any outstanding asynchronous + operations associated with the file as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/append.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/append.html new file mode 100644 index 0000000..48c51a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/append.html @@ -0,0 +1,45 @@ + + + +basic_file::append + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open the file in append + mode. +

+
static const flags append = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign.html new file mode 100644 index 0000000..3f62a7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign.html @@ -0,0 +1,49 @@ + + + +basic_file::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign an existing native + file to the file. +

+
void assign(
+    const native_handle_type & native_file);
+  » more...
+
+void assign(
+    const native_handle_type & native_file,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign/overload1.html new file mode 100644 index 0000000..83e7db4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign/overload1.html @@ -0,0 +1,42 @@ + + + +basic_file::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign/overload2.html new file mode 100644 index 0000000..4115a5c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/assign/overload2.html @@ -0,0 +1,43 @@ + + + +basic_file::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file.html new file mode 100644 index 0000000..1672154 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file.html @@ -0,0 +1,123 @@ + + + +basic_file::basic_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct a basic_file + without opening it. +

+
explicit basic_file(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_file(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct and open a basic_file. +

+
explicit basic_file(
+    const executor_type & ex,
+    const char * path,
+    file_base::flags open_flags);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_file(
+    ExecutionContext & context,
+    const char * path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+explicit basic_file(
+    const executor_type & ex,
+    const std::string & path,
+    file_base::flags open_flags);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_file(
+    ExecutionContext & context,
+    const std::string & path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_file + on an existing native file handle. +

+
basic_file(
+    const executor_type & ex,
+    const native_handle_type & native_file);
+  » more...
+
+

+ Construct a basic_file + on an existing native file. +

+
template<
+    typename ExecutionContext>
+basic_file(
+    ExecutionContext & context,
+    const native_handle_type & native_file,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Move-construct a basic_file from another. +

+
basic_file(
+    basic_file && other);
+  » more...
+
+

+ Move-construct a basic_file from a file of another + executor type. +

+
template<
+    typename Executor1>
+basic_file(
+    basic_file< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload1.html new file mode 100644 index 0000000..29707e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload1.html @@ -0,0 +1,60 @@ + + + +basic_file::basic_file (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_file + without opening it. +

+
basic_file(
+    const executor_type & ex);
+
+

+ This constructor initialises a file without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload10.html new file mode 100644 index 0000000..4006a79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload10.html @@ -0,0 +1,72 @@ + + + +basic_file::basic_file (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_file from a file of another + executor type. +

+
template<
+    typename Executor1>
+basic_file(
+    basic_file< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_file object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload2.html new file mode 100644 index 0000000..f461002 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload2.html @@ -0,0 +1,64 @@ + + + +basic_file::basic_file (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_file + without opening it. +

+
template<
+    typename ExecutionContext>
+basic_file(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a file without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload3.html new file mode 100644 index 0000000..c42ac6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload3.html @@ -0,0 +1,104 @@ + + + +basic_file::basic_file (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_file. +

+
basic_file(
+    const executor_type & ex,
+    const char * path,
+    file_base::flags open_flags);
+
+

+ This constructor initialises a file and opens it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload4.html new file mode 100644 index 0000000..b920106 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload4.html @@ -0,0 +1,108 @@ + + + +basic_file::basic_file (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_file. +

+
template<
+    typename ExecutionContext>
+basic_file(
+    ExecutionContext & context,
+    const char * path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a file and opens it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload5.html new file mode 100644 index 0000000..def073f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload5.html @@ -0,0 +1,104 @@ + + + +basic_file::basic_file (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_file. +

+
basic_file(
+    const executor_type & ex,
+    const std::string & path,
+    file_base::flags open_flags);
+
+

+ This constructor initialises a file and opens it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload6.html new file mode 100644 index 0000000..fe45483 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload6.html @@ -0,0 +1,108 @@ + + + +basic_file::basic_file (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_file. +

+
template<
+    typename ExecutionContext>
+basic_file(
+    ExecutionContext & context,
+    const std::string & path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a file and opens it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload7.html new file mode 100644 index 0000000..4debd76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload7.html @@ -0,0 +1,79 @@ + + + +basic_file::basic_file (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_file + on an existing native file handle. +

+
basic_file(
+    const executor_type & ex,
+    const native_handle_type & native_file);
+
+

+ This constructor initialises a file object to hold an existing native + file. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
native_file
+

+ A native file handle. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload8.html new file mode 100644 index 0000000..ebe66ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload8.html @@ -0,0 +1,83 @@ + + + +basic_file::basic_file (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_file + on an existing native file. +

+
template<
+    typename ExecutionContext>
+basic_file(
+    ExecutionContext & context,
+    const native_handle_type & native_file,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a file object to hold an existing native + file. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
native_file
+

+ A native file. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload9.html new file mode 100644 index 0000000..680161b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/basic_file/overload9.html @@ -0,0 +1,68 @@ + + + +basic_file::basic_file (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_file from another. +

+
basic_file(
+    basic_file && other);
+
+

+ This constructor moves a file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_file object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel.html new file mode 100644 index 0000000..607acf6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel.html @@ -0,0 +1,47 @@ + + + +basic_file::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel all asynchronous + operations associated with the file. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel/overload1.html new file mode 100644 index 0000000..637271a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel/overload1.html @@ -0,0 +1,92 @@ + + + +basic_file::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the file. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using the close() function to simultaneously cancel the + outstanding operations and close the file. +

+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel/overload2.html new file mode 100644 index 0000000..427824c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/cancel/overload2.html @@ -0,0 +1,93 @@ + + + +basic_file::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the file. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using the close() function to simultaneously cancel the + outstanding operations and close the file. +

+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/close.html new file mode 100644 index 0000000..f3a4c6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/close.html @@ -0,0 +1,46 @@ + + + +basic_file::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the file. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/close/overload1.html new file mode 100644 index 0000000..9141d69 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/close/overload1.html @@ -0,0 +1,60 @@ + + + +basic_file::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the file. +

+
void close();
+
+

+ This function is used to close the file. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/close/overload2.html new file mode 100644 index 0000000..10fd34e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/close/overload2.html @@ -0,0 +1,74 @@ + + + +basic_file::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the file. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the file. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::stream_file file(my_context);
+...
+asio::error_code ec;
+file.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/create.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/create.html new file mode 100644 index 0000000..7d462a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/create.html @@ -0,0 +1,45 @@ + + + +basic_file::create + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Create the file if it does + not exist. +

+
static const flags create = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/exclusive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/exclusive.html new file mode 100644 index 0000000..b4ff9ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/exclusive.html @@ -0,0 +1,45 @@ + + + +basic_file::exclusive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Ensure a new file + is created. Must be combined with create. +

+
static const flags exclusive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/executor_type.html new file mode 100644 index 0000000..ed163e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_file::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/flags.html new file mode 100644 index 0000000..fe0f4b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/flags.html @@ -0,0 +1,54 @@ + + + +basic_file::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +A bitmask type (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/get_executor.html new file mode 100644 index 0000000..7650ebc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_file::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the executor + associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/is_open.html new file mode 100644 index 0000000..9e3da31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/is_open.html @@ -0,0 +1,42 @@ + + + +basic_file::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether the + file is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/native_handle.html new file mode 100644 index 0000000..1ce441f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/native_handle.html @@ -0,0 +1,47 @@ + + + +basic_file::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the native + file representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + file. This is intended to allow access to native file functionality that + is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/native_handle_type.html new file mode 100644 index 0000000..a0403a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_file::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a file. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open.html new file mode 100644 index 0000000..de984c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open.html @@ -0,0 +1,62 @@ + + + +basic_file::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the file using the specified + path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags);
+  » more...
+
+void open(
+    const char * path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+  » more...
+
+void open(
+    const std::string & path,
+    file_base::flags open_flags);
+  » more...
+
+void open(
+    const std::string & path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload1.html new file mode 100644 index 0000000..7cee949 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload1.html @@ -0,0 +1,118 @@ + + + +basic_file::open (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the file using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+file.open("/path/to/my/file", asio::stream_file::read_only);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload2.html new file mode 100644 index 0000000..b4dc47f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload2.html @@ -0,0 +1,124 @@ + + + +basic_file::open (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the file using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::stream_file file(my_context);
+asio::error_code ec;
+file.open("/path/to/my/file", asio::stream_file::read_only, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload3.html new file mode 100644 index 0000000..1e60662 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload3.html @@ -0,0 +1,118 @@ + + + +basic_file::open (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the file using the specified path. +

+
void open(
+    const std::string & path,
+    file_base::flags open_flags);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+file.open("/path/to/my/file", asio::stream_file::read_only);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload4.html new file mode 100644 index 0000000..cb18606 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/open/overload4.html @@ -0,0 +1,115 @@ + + + +basic_file::open (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the file using the specified path. +

+
void open(
+    const std::string & path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+asio::error_code ec;
+file.open("/path/to/my/file", asio::stream_file::read_only, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_.html new file mode 100644 index 0000000..c2b1d46 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_.html @@ -0,0 +1,55 @@ + + + +basic_file::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign a + basic_file + from another. +

+
basic_file & operator=(
+    basic_file && other);
+  » more...
+
+

+ Move-assign a basic_file + from a file of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_file & > operator=(
+    basic_file< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_/overload1.html new file mode 100644 index 0000000..2db35af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_file::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_file from another. +

+
basic_file & operator=(
+    basic_file && other);
+
+

+ This assignment operator moves a file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_file object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_/overload2.html new file mode 100644 index 0000000..3d1cd22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +basic_file::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_file from a file of another + executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_file & > operator=(
+    basic_file< Executor1 > && other);
+
+

+ This assignment operator moves a file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_file object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/read_only.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/read_only.html new file mode 100644 index 0000000..26d4199 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/read_only.html @@ -0,0 +1,45 @@ + + + +basic_file::read_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open the file for + reading. +

+
static const flags read_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/read_write.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/read_write.html new file mode 100644 index 0000000..e89a615 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/read_write.html @@ -0,0 +1,45 @@ + + + +basic_file::read_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open the file for + reading and writing. +

+
static const flags read_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/release.html new file mode 100644 index 0000000..7643d0a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/release.html @@ -0,0 +1,47 @@ + + + +basic_file::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release ownership of + the underlying native file. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/release/overload1.html new file mode 100644 index 0000000..0e23ce7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/release/overload1.html @@ -0,0 +1,69 @@ + + + +basic_file::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native file. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. Ownership + of the native file is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/release/overload2.html new file mode 100644 index 0000000..3442a97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/release/overload2.html @@ -0,0 +1,70 @@ + + + +basic_file::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native file. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. Ownership + of the native file is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize.html new file mode 100644 index 0000000..8618abe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize.html @@ -0,0 +1,48 @@ + + + +basic_file::resize + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Alter the size of the file. +

+
void resize(
+    uint64_t n);
+  » more...
+
+void resize(
+    uint64_t n,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize/overload1.html new file mode 100644 index 0000000..6d89adf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize/overload1.html @@ -0,0 +1,74 @@ + + + +basic_file::resize (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Alter the size of the file. +

+
void resize(
+    uint64_t n);
+
+

+ This function resizes the file to the specified size, in bytes. If the + current file size exceeds n + then any extra data is discarded. If the current size is less than n then the file is extended and filled + with zeroes. +

+
+ + Parameters +
+
+

+
+
n
+

+ The new size for the file. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize/overload2.html new file mode 100644 index 0000000..79079d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/resize/overload2.html @@ -0,0 +1,66 @@ + + + +basic_file::resize (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Alter the size of the file. +

+
void resize(
+    uint64_t n,
+    asio::error_code & ec);
+
+

+ This function resizes the file to the specified size, in bytes. If the + current file size exceeds n + then any extra data is discarded. If the current size is less than n then the file is extended and filled + with zeroes. +

+
+ + Parameters +
+
+

+
+
n
+

+ The new size for the file. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/seek_basis.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/seek_basis.html new file mode 100644 index 0000000..c9bdab3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/seek_basis.html @@ -0,0 +1,71 @@ + + + +basic_file::seek_basis + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Basis for seeking + in a file. +

+
enum seek_basis
+
+

+ + + +

+
+ + Values +
+
+

+
+
seek_set
+

+ Seek to an absolute position. +

+
seek_cur
+

+ Seek to an offset relative to the current file position. +

+
seek_end
+

+ Seek to an offset relative to the end of the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/size.html new file mode 100644 index 0000000..1761849 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/size.html @@ -0,0 +1,46 @@ + + + +basic_file::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the size of the file. +

+
uint64_t size() const;
+  » more...
+
+uint64_t size(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/size/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/size/overload1.html new file mode 100644 index 0000000..35d3055 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/size/overload1.html @@ -0,0 +1,57 @@ + + + +basic_file::size (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the size of the file. +

+
uint64_t size() const;
+
+

+ This function determines the size of the file, in bytes. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/size/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/size/overload2.html new file mode 100644 index 0000000..908e98c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/size/overload2.html @@ -0,0 +1,58 @@ + + + +basic_file::size (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the size of the file. +

+
uint64_t size(
+    asio::error_code & ec) const;
+
+

+ This function determines the size of the file, in bytes. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all.html new file mode 100644 index 0000000..796fb09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all.html @@ -0,0 +1,47 @@ + + + +basic_file::sync_all + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Synchronise the file + to disk. +

+
void sync_all();
+  » more...
+
+void sync_all(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all/overload1.html new file mode 100644 index 0000000..6fdac50 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all/overload1.html @@ -0,0 +1,58 @@ + + + +basic_file::sync_all (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Synchronise the file to disk. +

+
void sync_all();
+
+

+ This function synchronises the file data and metadata to disk. Note that + the semantics of this synchronisation vary between operation systems. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all/overload2.html new file mode 100644 index 0000000..057b09a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all/overload2.html @@ -0,0 +1,59 @@ + + + +basic_file::sync_all (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Synchronise the file to disk. +

+
void sync_all(
+    asio::error_code & ec);
+
+

+ This function synchronises the file data and metadata to disk. Note that + the semantics of this synchronisation vary between operation systems. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all_on_write.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all_on_write.html new file mode 100644 index 0000000..b6d2f64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_all_on_write.html @@ -0,0 +1,46 @@ + + + +basic_file::sync_all_on_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file so that write operations automatically synchronise the file data + and metadata to disk. +

+
static const flags sync_all_on_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data.html new file mode 100644 index 0000000..54d9891 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data.html @@ -0,0 +1,47 @@ + + + +basic_file::sync_data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Synchronise the file + data to disk. +

+
void sync_data();
+  » more...
+
+void sync_data(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data/overload1.html new file mode 100644 index 0000000..5bd7d7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data/overload1.html @@ -0,0 +1,58 @@ + + + +basic_file::sync_data (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Synchronise the file data to disk. +

+
void sync_data();
+
+

+ This function synchronises the file data to disk. Note that the semantics + of this synchronisation vary between operation systems. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data/overload2.html new file mode 100644 index 0000000..97ae78b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/sync_data/overload2.html @@ -0,0 +1,59 @@ + + + +basic_file::sync_data (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Synchronise the file data to disk. +

+
void sync_data(
+    asio::error_code & ec);
+
+

+ This function synchronises the file data to disk. Note that the semantics + of this synchronisation vary between operation systems. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/truncate.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/truncate.html new file mode 100644 index 0000000..4938743 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/truncate.html @@ -0,0 +1,45 @@ + + + +basic_file::truncate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open the file with + any existing contents truncated. +

+
static const flags truncate = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file/write_only.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file/write_only.html new file mode 100644 index 0000000..022736e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file/write_only.html @@ -0,0 +1,45 @@ + + + +basic_file::write_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open the file for + writing. +

+
static const flags write_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file__rebind_executor.html new file mode 100644 index 0000000..823df27 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_file::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the file type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The file type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_file__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_file__rebind_executor/other.html new file mode 100644 index 0000000..6fd038c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_file__rebind_executor/other.html @@ -0,0 +1,510 @@ + + + +basic_file::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + file type when rebound to the specified executor. +

+
typedef basic_file< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ basic_file [constructor] +

+ 		+

+ Construct a basic_file without opening it.
—
Construct + and open a basic_file.
—
Construct a basic_file on + an existing native file handle.
—
Construct a basic_file + on an existing native file.
—
Move-construct a basic_file + from another.
—
Move-construct a basic_file from + a file of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_file from another.
—
Move-assign + a basic_file from a file of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_file [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append + [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create + [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_file + class template provides functionality that is common to both stream-oriented + and random-access files. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object.html new file mode 100644 index 0000000..1eb5ab5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object.html @@ -0,0 +1,270 @@ + + + +basic_io_object + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ (Deprecated) Base class for all I/O objects. +

+
template<
+    typename IoObjectService>
+class basic_io_object
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ implementation_type +

+ 		+

+ The underlying implementation type of I/O object. +

+
+

+ service_type +

+ 		+

+ The type of the service that will be used to provide I/O operations. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_io_context +

+ 		+

+ Get the io_context associated with the object. +

+
+

+ get_io_service +

+ 		+

+ Get the io_context associated with the object. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_io_object [constructor] +

+ 		+

+ Construct a basic_io_object.
—
Move-construct a basic_io_object. +
—
Perform a converting move-construction of a basic_io_object. +

+
+

+ get_implementation +

+ 		+

+ Get the underlying implementation of the I/O object. +

+
+

+ get_service +

+ 		+

+ Get the service associated with the I/O object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_io_object. +

+
+

+ ~basic_io_object [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Remarks +
+

+ All I/O objects are non-copyable. However, when using C++0x, certain I/O + objects do support move construction and move assignment. +

+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/_basic_io_object.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/_basic_io_object.html new file mode 100644 index 0000000..58321b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/_basic_io_object.html @@ -0,0 +1,47 @@ + + + +basic_io_object::~basic_io_object + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~basic_io_object();
+
+

+ Performs: +

+
get_service().destroy(get_implementation());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object.html new file mode 100644 index 0000000..e2b4db3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object.html @@ -0,0 +1,61 @@ + + + +basic_io_object::basic_io_object + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_io_object. +

+
explicit basic_io_object(
+    asio::io_context & io_context);
+  » more...
+
+

+ Move-construct a basic_io_object. +

+
basic_io_object(
+    basic_io_object && other);
+  » more...
+
+

+ Perform a converting move-construction of a basic_io_object. +

+
template<
+    typename IoObjectService1>
+basic_io_object(
+    IoObjectService1 & other_service,
+    typename IoObjectService1::implementation_type & other_implementation);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload1.html new file mode 100644 index 0000000..124e15c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload1.html @@ -0,0 +1,47 @@ + + + +basic_io_object::basic_io_object (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_io_object. +

+
basic_io_object(
+    asio::io_context & io_context);
+
+

+ Performs: +

+
get_service().construct(get_implementation());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload2.html new file mode 100644 index 0000000..80730c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload2.html @@ -0,0 +1,55 @@ + + + +basic_io_object::basic_io_object (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_io_object. +

+
basic_io_object(
+    basic_io_object && other);
+
+

+ Performs: +

+
get_service().move_construct(
+   get_implementation(), other.get_implementation());
+
+
+ + Remarks +
+

+ Available only for services that support movability, +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload3.html new file mode 100644 index 0000000..e461dd1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/basic_io_object/overload3.html @@ -0,0 +1,45 @@ + + + +basic_io_object::basic_io_object (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform a converting move-construction of a basic_io_object. +

+
template<
+    typename IoObjectService1>
+basic_io_object(
+    IoObjectService1 & other_service,
+    typename IoObjectService1::implementation_type & other_implementation);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/executor_type.html new file mode 100644 index 0000000..39489da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_io_object::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef asio::io_context::executor_type executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_executor.html new file mode 100644 index 0000000..a5754fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_io_object::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation.html new file mode 100644 index 0000000..3366bab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation.html @@ -0,0 +1,46 @@ + + + +basic_io_object::get_implementation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the underlying implementation of the I/O object. +

+
implementation_type & get_implementation();
+  » more...
+
+const implementation_type & get_implementation() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation/overload1.html new file mode 100644 index 0000000..5de9dd3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation/overload1.html @@ -0,0 +1,41 @@ + + + +basic_io_object::get_implementation (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying implementation of the I/O object. +

+
implementation_type & get_implementation();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation/overload2.html new file mode 100644 index 0000000..947735d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_implementation/overload2.html @@ -0,0 +1,41 @@ + + + +basic_io_object::get_implementation (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying implementation of the I/O object. +

+
const implementation_type & get_implementation() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_io_context.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_io_context.html new file mode 100644 index 0000000..861105b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_io_context.html @@ -0,0 +1,57 @@ + + + +basic_io_object::get_io_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the io_context + associated with the object. +

+
asio::io_context & get_io_context();
+
+

+ This function may be used to obtain the io_context object that the I/O + object uses to dispatch handlers for asynchronous operations. +

+
+ + Return + Value +
+

+ A reference to the io_context object that the I/O + object will use to dispatch handlers. Ownership is not transferred to the + caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_io_service.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_io_service.html new file mode 100644 index 0000000..3de23c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_io_service.html @@ -0,0 +1,57 @@ + + + +basic_io_object::get_io_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the io_context + associated with the object. +

+
asio::io_context & get_io_service();
+
+

+ This function may be used to obtain the io_context object that the I/O + object uses to dispatch handlers for asynchronous operations. +

+
+ + Return + Value +
+

+ A reference to the io_context object that the I/O + object will use to dispatch handlers. Ownership is not transferred to the + caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service.html new file mode 100644 index 0000000..8755f95 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service.html @@ -0,0 +1,46 @@ + + + +basic_io_object::get_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the service associated with the I/O object. +

+
service_type & get_service();
+  » more...
+
+const service_type & get_service() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service/overload1.html new file mode 100644 index 0000000..d2c3196 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service/overload1.html @@ -0,0 +1,41 @@ + + + +basic_io_object::get_service (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the service associated with the I/O object. +

+
service_type & get_service();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service/overload2.html new file mode 100644 index 0000000..2d0687b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/get_service/overload2.html @@ -0,0 +1,41 @@ + + + +basic_io_object::get_service (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the service associated with the I/O object. +

+
const service_type & get_service() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/implementation_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/implementation_type.html new file mode 100644 index 0000000..613d7cc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/implementation_type.html @@ -0,0 +1,52 @@ + + + +basic_io_object::implementation_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + underlying implementation type of I/O object. +

+
typedef service_type::implementation_type implementation_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/operator_eq_.html new file mode 100644 index 0000000..3ff7ed5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/operator_eq_.html @@ -0,0 +1,56 @@ + + + +basic_io_object::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_io_object. +

+
basic_io_object & operator=(
+    basic_io_object && other);
+
+

+ Performs: +

+
get_service().move_assign(get_implementation(),
+   other.get_service(), other.get_implementation());
+
+
+ + Remarks +
+

+ Available only for services that support movability, +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/service_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/service_type.html new file mode 100644 index 0000000..708afd5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object/service_type.html @@ -0,0 +1,52 @@ + + + +basic_io_object::service_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the service that will be used to provide I/O operations. +

+
typedef IoObjectService service_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_.html new file mode 100644 index 0000000..1d0df10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_.html @@ -0,0 +1,226 @@ + + + +basic_io_object< IoObjectService, true > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename IoObjectService>
+class basic_io_object< IoObjectService, true >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+
+

+ implementation_type +

+ 		+
+

+ service_type +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get_executor +

+ 		+
+

+ get_io_context +

+ 		+
+

+ get_io_service +

+ 		+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_io_object +

+ 		+
+

+ get_implementation +

+ 		+
+

+ get_service +

+ 		+
+

+ operator= +

+ 		+
+

+ ~basic_io_object [destructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/_basic_io_object.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/_basic_io_object.html new file mode 100644 index 0000000..49fce84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/_basic_io_object.html @@ -0,0 +1,41 @@ + + + +basic_io_object< IoObjectService, true >::~basic_io_object + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
~basic_io_object();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object.html new file mode 100644 index 0000000..8eeb3c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object.html @@ -0,0 +1,54 @@ + + + +basic_io_object< IoObjectService, true >::basic_io_object + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
explicit basic_io_object(
+    asio::io_context & io_context);
+  » more...
+
+basic_io_object(
+    basic_io_object && other);
+  » more...
+
+template<
+    typename IoObjectService1>
+basic_io_object(
+    IoObjectService1 & other_service,
+    typename IoObjectService1::implementation_type & other_implementation);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload1.html new file mode 100644 index 0000000..70239c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload1.html @@ -0,0 +1,39 @@ + + + +basic_io_object< IoObjectService, true >::basic_io_object (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
basic_io_object(
+    asio::io_context & io_context);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload2.html new file mode 100644 index 0000000..be4bb7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload2.html @@ -0,0 +1,39 @@ + + + +basic_io_object< IoObjectService, true >::basic_io_object (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
basic_io_object(
+    basic_io_object && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload3.html new file mode 100644 index 0000000..90a9a0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/basic_io_object/overload3.html @@ -0,0 +1,42 @@ + + + +basic_io_object< IoObjectService, true >::basic_io_object (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename IoObjectService1>
+basic_io_object(
+    IoObjectService1 & other_service,
+    typename IoObjectService1::implementation_type & other_implementation);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/executor_type.html new file mode 100644 index 0000000..6f42d67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/executor_type.html @@ -0,0 +1,51 @@ + + + +basic_io_object< IoObjectService, true >::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef asio::io_context::executor_type executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_executor.html new file mode 100644 index 0000000..729928a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_executor.html @@ -0,0 +1,41 @@ + + + +basic_io_object< IoObjectService, true >::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation.html new file mode 100644 index 0000000..ef89188 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation.html @@ -0,0 +1,45 @@ + + + +basic_io_object< IoObjectService, true >::get_implementation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
implementation_type & get_implementation();
+  » more...
+
+const implementation_type & get_implementation() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation/overload1.html new file mode 100644 index 0000000..0e8662d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation/overload1.html @@ -0,0 +1,38 @@ + + + +basic_io_object< IoObjectService, true >::get_implementation (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
implementation_type & get_implementation();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation/overload2.html new file mode 100644 index 0000000..bc9324a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_implementation/overload2.html @@ -0,0 +1,38 @@ + + + +basic_io_object< IoObjectService, true >::get_implementation (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
const implementation_type & get_implementation() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_io_context.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_io_context.html new file mode 100644 index 0000000..a48e9de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_io_context.html @@ -0,0 +1,41 @@ + + + +basic_io_object< IoObjectService, true >::get_io_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
asio::io_context & get_io_context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_io_service.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_io_service.html new file mode 100644 index 0000000..f79c9a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_io_service.html @@ -0,0 +1,41 @@ + + + +basic_io_object< IoObjectService, true >::get_io_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
asio::io_context & get_io_service();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service.html new file mode 100644 index 0000000..bce34d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service.html @@ -0,0 +1,45 @@ + + + +basic_io_object< IoObjectService, true >::get_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
service_type & get_service();
+  » more...
+
+const service_type & get_service() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service/overload1.html new file mode 100644 index 0000000..e7b655d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service/overload1.html @@ -0,0 +1,38 @@ + + + +basic_io_object< IoObjectService, true >::get_service (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
service_type & get_service();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service/overload2.html new file mode 100644 index 0000000..f4d9aef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/get_service/overload2.html @@ -0,0 +1,38 @@ + + + +basic_io_object< IoObjectService, true >::get_service (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
const service_type & get_service() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/implementation_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/implementation_type.html new file mode 100644 index 0000000..2376a9c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/implementation_type.html @@ -0,0 +1,51 @@ + + + +basic_io_object< IoObjectService, true >::implementation_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef service_type::implementation_type implementation_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/operator_eq_.html new file mode 100644 index 0000000..d80a2b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/operator_eq_.html @@ -0,0 +1,42 @@ + + + +basic_io_object< IoObjectService, true >::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
basic_io_object & operator=(
+    basic_io_object && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/service_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/service_type.html new file mode 100644 index 0000000..e3575ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_io_object_lt__IoObjectService_comma__true__gt_/service_type.html @@ -0,0 +1,51 @@ + + + +basic_io_object< IoObjectService, true >::service_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef IoObjectService service_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_io_object.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file.html new file mode 100644 index 0000000..cb070af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file.html @@ -0,0 +1,545 @@ + + + +basic_random_access_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides random-access file functionality. +

+
template<
+    typename Executor>
+class basic_random_access_file :
+  public basic_file< Executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ async_read_some_at +

+ 		+

+ Start an asynchronous read at the specified offset. +

+
+

+ async_write_some_at +

+ 		+

+ Start an asynchronous write at the specified offset. +

+
+

+ basic_random_access_file [constructor] +

+ 		+

+ Construct a basic_random_access_file without opening it.
+ —
Construct and open a basic_random_access_file.
—
+ Construct a basic_random_access_file on an existing native file. +
—
Move-construct a basic_random_access_file from another. +
—
Move-construct a basic_random_access_file from a + file of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_random_access_file from another.
—
+ Move-assign a basic_random_access_file from a file of another executor + type. +

+
+

+ read_some_at +

+ 		+

+ Read some data from the handle at the specified offset. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+

+ write_some_at +

+ 		+

+ Write some data to the handle at the specified offset. +

+
+

+ ~basic_random_access_file [destructor] +

+ 		+

+ Destroys the file. +

+
+
+ + Data Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_random_access_file class template + provides asynchronous and blocking random-access file functionality. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous read_some_at + and write_some_at operations + are thread safe with respect to each other, if the underlying operating system + calls are also thread safe. This means that it is permitted to perform concurrent + calls to these synchronous operations on a single file object. Other synchronous + operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_random_access_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/_basic_random_access_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/_basic_random_access_file.html new file mode 100644 index 0000000..b431556 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/_basic_random_access_file.html @@ -0,0 +1,46 @@ + + + +basic_random_access_file::~basic_random_access_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the file. +

+
~basic_random_access_file();
+
+

+ This function destroys the file, cancelling any outstanding asynchronous + operations associated with the file as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/append.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/append.html new file mode 100644 index 0000000..e037f52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/append.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::append + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file in append mode. +

+
static const flags append = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign.html new file mode 100644 index 0000000..d50ce3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign.html @@ -0,0 +1,49 @@ + + + +basic_random_access_file::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file);
+  » more...
+
+void assign(
+    const native_handle_type & native_file,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign/overload1.html new file mode 100644 index 0000000..2f89e90 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign/overload1.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Assign an existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign/overload2.html new file mode 100644 index 0000000..bc9b748 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/assign/overload2.html @@ -0,0 +1,46 @@ + + + +basic_random_access_file::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Assign an existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/async_read_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/async_read_some_at.html new file mode 100644 index 0000000..a9e565e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/async_read_some_at.html @@ -0,0 +1,148 @@ + + + +basic_random_access_file::async_read_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read at the specified offset. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the random-access + handle. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be read. +

+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read_at + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
handle.async_read_some_at(42, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/async_write_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/async_write_some_at.html new file mode 100644 index 0000000..f1298fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/async_write_some_at.html @@ -0,0 +1,148 @@ + + + +basic_random_access_file::async_write_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write at the specified offset. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the random-access + handle. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more data buffers to be written to the handle. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not write all of the data to the file. Consider + using the async_write_at + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
handle.async_write_some_at(42, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file.html new file mode 100644 index 0000000..0cca3d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file.html @@ -0,0 +1,121 @@ + + + +basic_random_access_file::basic_random_access_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_random_access_file without + opening it. +

+
explicit basic_random_access_file(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_random_access_file(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct and open a basic_random_access_file. +

+
basic_random_access_file(
+    const executor_type & ex,
+    const char * path,
+    file_base::flags open_flags);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_random_access_file(
+    ExecutionContext & context,
+    const char * path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+basic_random_access_file(
+    const executor_type & ex,
+    const std::string & path,
+    file_base::flags open_flags);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_random_access_file(
+    ExecutionContext & context,
+    const std::string & path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_random_access_file on an + existing native file. +

+
basic_random_access_file(
+    const executor_type & ex,
+    const native_handle_type & native_file);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_random_access_file(
+    ExecutionContext & context,
+    const native_handle_type & native_file,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Move-construct a basic_random_access_file from + another. +

+
basic_random_access_file(
+    basic_random_access_file && other);
+  » more...
+
+

+ Move-construct a basic_random_access_file from + a file of another executor type. +

+
template<
+    typename Executor1>
+basic_random_access_file(
+    basic_random_access_file< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload1.html new file mode 100644 index 0000000..990e267 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload1.html @@ -0,0 +1,61 @@ + + + +basic_random_access_file::basic_random_access_file (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_random_access_file without + opening it. +

+
basic_random_access_file(
+    const executor_type & ex);
+
+

+ This constructor initialises a file without opening it. The file needs + to be opened before data can be read from or or written to it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload10.html new file mode 100644 index 0000000..8a758b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload10.html @@ -0,0 +1,72 @@ + + + +basic_random_access_file::basic_random_access_file (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_random_access_file from + a file of another executor type. +

+
template<
+    typename Executor1>
+basic_random_access_file(
+    basic_random_access_file< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a random-access file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_random_access_file + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload2.html new file mode 100644 index 0000000..ca9b262 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload2.html @@ -0,0 +1,65 @@ + + + +basic_random_access_file::basic_random_access_file (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_random_access_file without + opening it. +

+
template<
+    typename ExecutionContext>
+basic_random_access_file(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a file without opening it. The file needs + to be opened before data can be read from or or written to it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload3.html new file mode 100644 index 0000000..c4406cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload3.html @@ -0,0 +1,82 @@ + + + +basic_random_access_file::basic_random_access_file (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_random_access_file. +

+
basic_random_access_file(
+    const executor_type & ex,
+    const char * path,
+    file_base::flags open_flags);
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload4.html new file mode 100644 index 0000000..8871e2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload4.html @@ -0,0 +1,86 @@ + + + +basic_random_access_file::basic_random_access_file (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_random_access_file. +

+
template<
+    typename ExecutionContext>
+basic_random_access_file(
+    ExecutionContext & context,
+    const char * path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload5.html new file mode 100644 index 0000000..1131ef5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload5.html @@ -0,0 +1,82 @@ + + + +basic_random_access_file::basic_random_access_file (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_random_access_file. +

+
basic_random_access_file(
+    const executor_type & ex,
+    const std::string & path,
+    file_base::flags open_flags);
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload6.html new file mode 100644 index 0000000..28e310d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload6.html @@ -0,0 +1,86 @@ + + + +basic_random_access_file::basic_random_access_file (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_random_access_file. +

+
template<
+    typename ExecutionContext>
+basic_random_access_file(
+    ExecutionContext & context,
+    const std::string & path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload7.html new file mode 100644 index 0000000..97e9450 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload7.html @@ -0,0 +1,79 @@ + + + +basic_random_access_file::basic_random_access_file (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_random_access_file on + an existing native file. +

+
basic_random_access_file(
+    const executor_type & ex,
+    const native_handle_type & native_file);
+
+

+ This constructor initialises a random-access file object to hold an existing + native file. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
native_file
+

+ The new underlying file implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload8.html new file mode 100644 index 0000000..f8955f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload8.html @@ -0,0 +1,83 @@ + + + +basic_random_access_file::basic_random_access_file (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_random_access_file on + an existing native file. +

+
template<
+    typename ExecutionContext>
+basic_random_access_file(
+    ExecutionContext & context,
+    const native_handle_type & native_file,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a random-access file object to hold an existing + native file. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
native_file
+

+ The new underlying file implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload9.html new file mode 100644 index 0000000..e9160c3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/basic_random_access_file/overload9.html @@ -0,0 +1,69 @@ + + + +basic_random_access_file::basic_random_access_file (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_random_access_file from + another. +

+
basic_random_access_file(
+    basic_random_access_file && other);
+
+

+ This constructor moves a random-access file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_random_access_file + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel.html new file mode 100644 index 0000000..755bee4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel.html @@ -0,0 +1,47 @@ + + + +basic_random_access_file::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the file. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel/overload1.html new file mode 100644 index 0000000..9a3f13d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel/overload1.html @@ -0,0 +1,95 @@ + + + +basic_random_access_file::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Cancel all asynchronous operations associated with the file. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using the close() function to simultaneously cancel the + outstanding operations and close the file. +

+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel/overload2.html new file mode 100644 index 0000000..ec53305 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/cancel/overload2.html @@ -0,0 +1,96 @@ + + + +basic_random_access_file::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Cancel all asynchronous operations associated with the file. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using the close() function to simultaneously cancel the + outstanding operations and close the file. +

+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close.html new file mode 100644 index 0000000..39b85a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close.html @@ -0,0 +1,47 @@ + + + +basic_random_access_file::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the file. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close/overload1.html new file mode 100644 index 0000000..7e9ba3c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close/overload1.html @@ -0,0 +1,63 @@ + + + +basic_random_access_file::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Close the file. +

+
void close();
+
+

+ This function is used to close the file. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close/overload2.html new file mode 100644 index 0000000..fc9b6dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/close/overload2.html @@ -0,0 +1,77 @@ + + + +basic_random_access_file::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Close the file. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the file. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::stream_file file(my_context);
+...
+asio::error_code ec;
+file.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/create.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/create.html new file mode 100644 index 0000000..27f752b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/create.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::create + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Create + the file if it does not exist. +

+
static const flags create = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/exclusive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/exclusive.html new file mode 100644 index 0000000..9e3b99a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/exclusive.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::exclusive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Ensure + a new file is created. Must be combined with create. +

+
static const flags exclusive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/executor_type.html new file mode 100644 index 0000000..ef8cb1c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_random_access_file::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_random_access_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/flags.html new file mode 100644 index 0000000..f88c7a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/flags.html @@ -0,0 +1,55 @@ + + + +basic_random_access_file::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +A + bitmask type (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_random_access_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/get_executor.html new file mode 100644 index 0000000..f3e47b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/get_executor.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/is_open.html new file mode 100644 index 0000000..a71b649 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/is_open.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ +Determine + whether the file is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/native_handle.html new file mode 100644 index 0000000..afa75ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/native_handle.html @@ -0,0 +1,50 @@ + + + +basic_random_access_file::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ +Get + the native file representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + file. This is intended to allow access to native file functionality that + is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/native_handle_type.html new file mode 100644 index 0000000..6477114 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_random_access_file::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a file. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_random_access_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open.html new file mode 100644 index 0000000..ae7c871 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open.html @@ -0,0 +1,62 @@ + + + +basic_random_access_file::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open + the file using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags);
+  » more...
+
+void open(
+    const char * path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+  » more...
+
+void open(
+    const std::string & path,
+    file_base::flags open_flags);
+  » more...
+
+void open(
+    const std::string & path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload1.html new file mode 100644 index 0000000..02d5a32 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload1.html @@ -0,0 +1,121 @@ + + + +basic_random_access_file::open (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+file.open("/path/to/my/file", asio::stream_file::read_only);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload2.html new file mode 100644 index 0000000..28425b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload2.html @@ -0,0 +1,127 @@ + + + +basic_random_access_file::open (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::stream_file file(my_context);
+asio::error_code ec;
+file.open("/path/to/my/file", asio::stream_file::read_only, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload3.html new file mode 100644 index 0000000..4ae9801 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload3.html @@ -0,0 +1,121 @@ + + + +basic_random_access_file::open (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const std::string & path,
+    file_base::flags open_flags);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+file.open("/path/to/my/file", asio::stream_file::read_only);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload4.html new file mode 100644 index 0000000..4be24d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/open/overload4.html @@ -0,0 +1,118 @@ + + + +basic_random_access_file::open (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const std::string & path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+asio::error_code ec;
+file.open("/path/to/my/file", asio::stream_file::read_only, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_.html new file mode 100644 index 0000000..39d8cf4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_.html @@ -0,0 +1,55 @@ + + + +basic_random_access_file::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_random_access_file from + another. +

+
basic_random_access_file & operator=(
+    basic_random_access_file && other);
+  » more...
+
+

+ Move-assign a basic_random_access_file from + a file of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_random_access_file & > operator=(
+    basic_random_access_file< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_/overload1.html new file mode 100644 index 0000000..63b7ada --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_/overload1.html @@ -0,0 +1,70 @@ + + + +basic_random_access_file::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_random_access_file from + another. +

+
basic_random_access_file & operator=(
+    basic_random_access_file && other);
+
+

+ This assignment operator moves a random-access file from one object to + another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_random_access_file + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_/overload2.html new file mode 100644 index 0000000..4aaf6b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +basic_random_access_file::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_random_access_file from + a file of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_random_access_file & > operator=(
+    basic_random_access_file< Executor1 > && other);
+
+

+ This assignment operator moves a random-access file from one object to + another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_random_access_file + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_only.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_only.html new file mode 100644 index 0000000..83a06d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_only.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::read_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file for reading. +

+
static const flags read_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at.html new file mode 100644 index 0000000..fde32b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at.html @@ -0,0 +1,55 @@ + + + +basic_random_access_file::read_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the handle at the specified offset. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at/overload1.html new file mode 100644 index 0000000..b88b9b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at/overload1.html @@ -0,0 +1,113 @@ + + + +basic_random_access_file::read_some_at (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the handle at the specified offset. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to read data from the random-access handle. The + function call will block until one or more bytes of data has been read + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be read. +

+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the end of the file was reached. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read_at function if you need + to ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
handle.read_some_at(42, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at/overload2.html new file mode 100644 index 0000000..bd68558 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_some_at/overload2.html @@ -0,0 +1,90 @@ + + + +basic_random_access_file::read_some_at (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the handle at the specified offset. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to read data from the random-access handle. The + function call will block until one or more bytes of data has been read + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be read. +

+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read_at function if you need + to ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_write.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_write.html new file mode 100644 index 0000000..0c29b1e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/read_write.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::read_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file for reading and writing. +

+
static const flags read_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release.html new file mode 100644 index 0000000..eace392 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release.html @@ -0,0 +1,47 @@ + + + +basic_random_access_file::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native file. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release/overload1.html new file mode 100644 index 0000000..0b454cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release/overload1.html @@ -0,0 +1,72 @@ + + + +basic_random_access_file::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Release ownership of the underlying native file. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. Ownership + of the native file is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release/overload2.html new file mode 100644 index 0000000..563354c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/release/overload2.html @@ -0,0 +1,73 @@ + + + +basic_random_access_file::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Release ownership of the underlying native file. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. Ownership + of the native file is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize.html new file mode 100644 index 0000000..444b83e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize.html @@ -0,0 +1,49 @@ + + + +basic_random_access_file::resize + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Alter + the size of the file. +

+
void resize(
+    uint64_t n);
+  » more...
+
+void resize(
+    uint64_t n,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize/overload1.html new file mode 100644 index 0000000..5988a14 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize/overload1.html @@ -0,0 +1,77 @@ + + + +basic_random_access_file::resize (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Alter the size of the file. +

+
void resize(
+    uint64_t n);
+
+

+ This function resizes the file to the specified size, in bytes. If the + current file size exceeds n + then any extra data is discarded. If the current size is less than n then the file is extended and filled + with zeroes. +

+
+ + Parameters +
+
+

+
+
n
+

+ The new size for the file. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize/overload2.html new file mode 100644 index 0000000..8561973 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/resize/overload2.html @@ -0,0 +1,69 @@ + + + +basic_random_access_file::resize (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Alter the size of the file. +

+
void resize(
+    uint64_t n,
+    asio::error_code & ec);
+
+

+ This function resizes the file to the specified size, in bytes. If the + current file size exceeds n + then any extra data is discarded. If the current size is less than n then the file is extended and filled + with zeroes. +

+
+ + Parameters +
+
+

+
+
n
+

+ The new size for the file. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/seek_basis.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/seek_basis.html new file mode 100644 index 0000000..d6eab8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/seek_basis.html @@ -0,0 +1,71 @@ + + + +basic_random_access_file::seek_basis + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Basis + for seeking in a file. +

+
enum seek_basis
+
+

+ + + +

+
+ + Values +
+
+

+
+
seek_set
+

+ Seek to an absolute position. +

+
seek_cur
+

+ Seek to an offset relative to the current file position. +

+
seek_end
+

+ Seek to an offset relative to the end of the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size.html new file mode 100644 index 0000000..9d7d718 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size.html @@ -0,0 +1,47 @@ + + + +basic_random_access_file::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the size of the file. +

+
uint64_t size() const;
+  » more...
+
+uint64_t size(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size/overload1.html new file mode 100644 index 0000000..5e8373c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size/overload1.html @@ -0,0 +1,60 @@ + + + +basic_random_access_file::size (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Get the size of the file. +

+
uint64_t size() const;
+
+

+ This function determines the size of the file, in bytes. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size/overload2.html new file mode 100644 index 0000000..b6150d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/size/overload2.html @@ -0,0 +1,61 @@ + + + +basic_random_access_file::size (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Get the size of the file. +

+
uint64_t size(
+    asio::error_code & ec) const;
+
+

+ This function determines the size of the file, in bytes. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all.html new file mode 100644 index 0000000..35451cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all.html @@ -0,0 +1,47 @@ + + + +basic_random_access_file::sync_all + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Synchronise + the file to disk. +

+
void sync_all();
+  » more...
+
+void sync_all(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all/overload1.html new file mode 100644 index 0000000..6a815ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all/overload1.html @@ -0,0 +1,61 @@ + + + +basic_random_access_file::sync_all (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file to disk. +

+
void sync_all();
+
+

+ This function synchronises the file data and metadata to disk. Note that + the semantics of this synchronisation vary between operation systems. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all/overload2.html new file mode 100644 index 0000000..a0f76a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all/overload2.html @@ -0,0 +1,62 @@ + + + +basic_random_access_file::sync_all (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file to disk. +

+
void sync_all(
+    asio::error_code & ec);
+
+

+ This function synchronises the file data and metadata to disk. Note that + the semantics of this synchronisation vary between operation systems. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all_on_write.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all_on_write.html new file mode 100644 index 0000000..7de3f1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_all_on_write.html @@ -0,0 +1,46 @@ + + + +basic_random_access_file::sync_all_on_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file so that write operations automatically synchronise the file data + and metadata to disk. +

+
static const flags sync_all_on_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data.html new file mode 100644 index 0000000..e7ffdc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data.html @@ -0,0 +1,47 @@ + + + +basic_random_access_file::sync_data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Synchronise + the file data to disk. +

+
void sync_data();
+  » more...
+
+void sync_data(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data/overload1.html new file mode 100644 index 0000000..e24b5ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data/overload1.html @@ -0,0 +1,61 @@ + + + +basic_random_access_file::sync_data (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file data to disk. +

+
void sync_data();
+
+

+ This function synchronises the file data to disk. Note that the semantics + of this synchronisation vary between operation systems. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data/overload2.html new file mode 100644 index 0000000..d233fed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/sync_data/overload2.html @@ -0,0 +1,62 @@ + + + +basic_random_access_file::sync_data (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file data to disk. +

+
void sync_data(
+    asio::error_code & ec);
+
+

+ This function synchronises the file data to disk. Note that the semantics + of this synchronisation vary between operation systems. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/truncate.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/truncate.html new file mode 100644 index 0000000..0c905de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/truncate.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::truncate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file with any existing contents truncated. +

+
static const flags truncate = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_only.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_only.html new file mode 100644 index 0000000..96062d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_only.html @@ -0,0 +1,45 @@ + + + +basic_random_access_file::write_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file for writing. +

+
static const flags write_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at.html new file mode 100644 index 0000000..0e4799d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at.html @@ -0,0 +1,55 @@ + + + +basic_random_access_file::write_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the handle at the specified offset. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at/overload1.html new file mode 100644 index 0000000..c8f89eb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at/overload1.html @@ -0,0 +1,113 @@ + + + +basic_random_access_file::write_some_at (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the handle at the specified offset. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write data to the random-access handle. The + function call will block until one or more bytes of the data has been + written successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more data buffers to be written to the handle. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the end of the file was reached. +

+
+
+
+ + Remarks +
+

+ The write_some_at operation may not write all of the data. Consider using + the write_at + function if you need to ensure that all data is written before the blocking + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
handle.write_some_at(42, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at/overload2.html new file mode 100644 index 0000000..8991ffb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file/write_some_at/overload2.html @@ -0,0 +1,90 @@ + + + +basic_random_access_file::write_some_at (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the handle at the specified offset. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write data to the random-access handle. The + function call will block until one or more bytes of the data has been + written successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more data buffers to be written to the handle. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not write all of the data to the file. Consider + using the write_at + function if you need to ensure that all data is written before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file__rebind_executor.html new file mode 100644 index 0000000..fa3ab62 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_random_access_file::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the file type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The file type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_random_access_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file__rebind_executor/other.html new file mode 100644 index 0000000..3aec42c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_random_access_file__rebind_executor/other.html @@ -0,0 +1,543 @@ + + + +basic_random_access_file::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + file type when rebound to the specified executor. +

+
typedef basic_random_access_file< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ async_read_some_at +

+ 		+

+ Start an asynchronous read at the specified offset. +

+
+

+ async_write_some_at +

+ 		+

+ Start an asynchronous write at the specified offset. +

+
+

+ basic_random_access_file [constructor] +

+ 		+

+ Construct a basic_random_access_file without opening it.
+ —
Construct and open a basic_random_access_file.
+ —
Construct a basic_random_access_file on an existing native + file.
—
Move-construct a basic_random_access_file + from another.
—
Move-construct a basic_random_access_file + from a file of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_random_access_file from another.
— +
Move-assign a basic_random_access_file from a file of + another executor type. +

+
+

+ read_some_at +

+ 		+

+ Read some data from the handle at the specified offset. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+

+ write_some_at +

+ 		+

+ Write some data to the handle at the specified offset. +

+
+

+ ~basic_random_access_file [destructor] +

+ 		+

+ Destroys the file. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_random_access_file class + template provides asynchronous and blocking random-access file functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous read_some_at + and write_some_at operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single file object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_random_access_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket.html new file mode 100644 index 0000000..f4be864 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket.html @@ -0,0 +1,915 @@ + + + +basic_raw_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides raw-oriented socket functionality. +

+
template<
+    typename Protocol,
+    typename Executor>
+class basic_raw_socket :
+  public basic_socket< Protocol, Executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close if + unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_raw_socket [constructor] +

+ 		+

+ Construct a basic_raw_socket without opening it.
—
+ Construct and open a basic_raw_socket.
—
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.
—
Move-construct a basic_raw_socket from + a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets the + non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_raw_socket from another.
—
Move-assign + a basic_raw_socket from a socket of another protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive raw data with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send raw data to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, or + to have pending error conditions. +

+
+

+ ~basic_raw_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_raw_socket + class template provides asynchronous and blocking raw-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single socket + object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/_basic_raw_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/_basic_raw_socket.html new file mode 100644 index 0000000..4582b15 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/_basic_raw_socket.html @@ -0,0 +1,46 @@ + + + +basic_raw_socket::~basic_raw_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the socket. +

+
~basic_raw_socket();
+
+

+ This function destroys the socket, cancelling any outstanding asynchronous + operations associated with the socket as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign.html new file mode 100644 index 0000000..1c528ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign.html @@ -0,0 +1,51 @@ + + + +basic_raw_socket::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign an existing + native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign/overload1.html new file mode 100644 index 0000000..8764399 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign/overload1.html @@ -0,0 +1,46 @@ + + + +basic_raw_socket::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign/overload2.html new file mode 100644 index 0000000..16bdf6a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/assign/overload2.html @@ -0,0 +1,47 @@ + + + +basic_raw_socket::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_connect.html new file mode 100644 index 0000000..2ad6cb6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_connect.html @@ -0,0 +1,142 @@ + + + +basic_raw_socket::async_connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Start + an asynchronous connect. +

+
template<
+    typename ConnectToken = default_completion_token_t<executor_type>>
+DEDUCED async_connect(
+    const endpoint_type & peer_endpoint,
+    ConnectToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously connect a socket to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ The socket is automatically opened if it is not already open. If the connect + fails, and the socket was automatically opened, the socket is not returned + to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. Copies + will be made of the endpoint object as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void connect_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Connect succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.async_connect(endpoint, connect_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive.html new file mode 100644 index 0000000..8f5a3db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive.html @@ -0,0 +1,57 @@ + + + +basic_raw_socket::async_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous receive on a connected socket. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive/overload1.html new file mode 100644 index 0000000..d0bbac5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive/overload1.html @@ -0,0 +1,140 @@ + + + +basic_raw_socket::async_receive (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive on a connected socket. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the raw socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_receive operation can only be used with a connected socket. + Use the async_receive_from function to receive data on an unconnected + raw socket. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive/overload2.html new file mode 100644 index 0000000..2b9db28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive/overload2.html @@ -0,0 +1,131 @@ + + + +basic_raw_socket::async_receive (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive on a connected socket. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the raw socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_receive operation can only be used with a connected socket. + Use the async_receive_from function to receive data on an unconnected + raw socket. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from.html new file mode 100644 index 0000000..d5386aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from.html @@ -0,0 +1,59 @@ + + + +basic_raw_socket::async_receive_from + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from/overload1.html new file mode 100644 index 0000000..2d892e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from/overload1.html @@ -0,0 +1,140 @@ + + + +basic_raw_socket::async_receive_from (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive raw data. It is an initiating + function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the data. Ownership of the sender_endpoint object is retained + by the caller, which must guarantee that it is valid until the + completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive_from(
+   asio::buffer(data, size), 0, sender_endpoint, handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from/overload2.html new file mode 100644 index 0000000..565cddc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_receive_from/overload2.html @@ -0,0 +1,130 @@ + + + +basic_raw_socket::async_receive_from (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive raw data. It is an initiating + function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the data. Ownership of the sender_endpoint object is retained + by the caller, which must guarantee that it is valid until the + completion handler is called. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send.html new file mode 100644 index 0000000..da95322 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send.html @@ -0,0 +1,57 @@ + + + +basic_raw_socket::async_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous send on a connected socket. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send/overload1.html new file mode 100644 index 0000000..5eb9768 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send/overload1.html @@ -0,0 +1,138 @@ + + + +basic_raw_socket::async_send (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send on a connected socket. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send data on the raw socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_send operation can only be used with a connected socket. Use + the async_send_to function to send data on an unconnected raw socket. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.async_send(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send/overload2.html new file mode 100644 index 0000000..2f982f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send/overload2.html @@ -0,0 +1,129 @@ + + + +basic_raw_socket::async_send (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send on a connected socket. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send data on the raw socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. 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 completion handler is called. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_send operation can only be used with a connected socket. Use + the async_send_to function to send data on an unconnected raw socket. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to.html new file mode 100644 index 0000000..405c423 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to.html @@ -0,0 +1,59 @@ + + + +basic_raw_socket::async_send_to + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to/overload1.html new file mode 100644 index 0000000..f575bcb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to/overload1.html @@ -0,0 +1,140 @@ + + + +basic_raw_socket::async_send_to (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send raw data to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. 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 completion handler is + called. +

+
destination
+

+ The remote endpoint to which the data will be sent. Copies will + be made of the endpoint as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
asio::ip::udp::endpoint destination(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.async_send_to(
+    asio::buffer(data, size), destination, handler);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to/overload2.html new file mode 100644 index 0000000..19d511a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_send_to/overload2.html @@ -0,0 +1,128 @@ + + + +basic_raw_socket::async_send_to (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send raw data to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. 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 completion handler is + called. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
destination
+

+ The remote endpoint to which the data will be sent. Copies will + be made of the endpoint as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_wait.html new file mode 100644 index 0000000..c147fbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/async_wait.html @@ -0,0 +1,137 @@ + + + +basic_raw_socket::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Asynchronously + wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for a socket to enter + a ready to read, write or error condition state. It is an initiating function + for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+...
+socket.async_wait(asio::ip::tcp::socket::wait_read, wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark.html new file mode 100644 index 0000000..6b92e4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark.html @@ -0,0 +1,47 @@ + + + +basic_raw_socket::at_mark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+  » more...
+
+bool at_mark(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark/overload1.html new file mode 100644 index 0000000..2e4afc4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark/overload1.html @@ -0,0 +1,69 @@ + + + +basic_raw_socket::at_mark (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark/overload2.html new file mode 100644 index 0000000..efeab61 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/at_mark/overload2.html @@ -0,0 +1,70 @@ + + + +basic_raw_socket::at_mark (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark(
+    asio::error_code & ec) const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available.html new file mode 100644 index 0000000..80de537 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available.html @@ -0,0 +1,47 @@ + + + +basic_raw_socket::available + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the number of bytes available for reading. +

+
std::size_t available() const;
+  » more...
+
+std::size_t available(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available/overload1.html new file mode 100644 index 0000000..4383d31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available/overload1.html @@ -0,0 +1,70 @@ + + + +basic_raw_socket::available (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available() const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available/overload2.html new file mode 100644 index 0000000..096a8cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/available/overload2.html @@ -0,0 +1,71 @@ + + + +basic_raw_socket::available (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available(
+    asio::error_code & ec) const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket.html new file mode 100644 index 0000000..0af2dc6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket.html @@ -0,0 +1,123 @@ + + + +basic_raw_socket::basic_raw_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_raw_socket + without opening it. +

+
explicit basic_raw_socket(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_raw_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct and open a basic_raw_socket. +

+
basic_raw_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_raw_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_raw_socket, opening it and + binding it to the given local endpoint. +

+
basic_raw_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_raw_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct a basic_raw_socket on an existing + native socket. +

+
basic_raw_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_raw_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_raw_socket from another. +

+
basic_raw_socket(
+    basic_raw_socket && other);
+  » more...
+
+

+ Move-construct a basic_raw_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_raw_socket(
+    basic_raw_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload1.html new file mode 100644 index 0000000..61677b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload1.html @@ -0,0 +1,61 @@ + + + +basic_raw_socket::basic_raw_socket (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_raw_socket without opening + it. +

+
basic_raw_socket(
+    const executor_type & ex);
+
+

+ This constructor creates a raw socket without opening it. The open() + function must be called before data can be sent or received on the socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload10.html new file mode 100644 index 0000000..b49638c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload10.html @@ -0,0 +1,73 @@ + + + +basic_raw_socket::basic_raw_socket (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_raw_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_raw_socket(
+    basic_raw_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a raw socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_raw_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_raw_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload2.html new file mode 100644 index 0000000..b0f4eb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload2.html @@ -0,0 +1,65 @@ + + + +basic_raw_socket::basic_raw_socket (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_raw_socket without opening + it. +

+
template<
+    typename ExecutionContext>
+basic_raw_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a raw socket without opening it. The open() + function must be called before data can be sent or received on the socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload3.html new file mode 100644 index 0000000..fd193da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload3.html @@ -0,0 +1,77 @@ + + + +basic_raw_socket::basic_raw_socket (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_raw_socket. +

+
basic_raw_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+
+

+ This constructor creates and opens a raw socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload4.html new file mode 100644 index 0000000..8cbe7d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload4.html @@ -0,0 +1,81 @@ + + + +basic_raw_socket::basic_raw_socket (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_raw_socket. +

+
template<
+    typename ExecutionContext>
+basic_raw_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates and opens a raw socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload5.html new file mode 100644 index 0000000..6f11516 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload5.html @@ -0,0 +1,81 @@ + + + +basic_raw_socket::basic_raw_socket (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_raw_socket, opening it + and binding it to the given local endpoint. +

+
basic_raw_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+
+

+ This constructor creates a raw socket and automatically opens it bound + to the specified endpoint on the local machine. The protocol used is + the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the raw socket will be + bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload6.html new file mode 100644 index 0000000..490c5de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload6.html @@ -0,0 +1,85 @@ + + + +basic_raw_socket::basic_raw_socket (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_raw_socket, opening it + and binding it to the given local endpoint. +

+
template<
+    typename ExecutionContext>
+basic_raw_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a raw socket and automatically opens it bound + to the specified endpoint on the local machine. The protocol used is + the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the raw socket will be + bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload7.html new file mode 100644 index 0000000..a5fdcb7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload7.html @@ -0,0 +1,84 @@ + + + +basic_raw_socket::basic_raw_socket (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_raw_socket on an existing + native socket. +

+
basic_raw_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+

+ This constructor creates a raw socket object to hold an existing native + socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload8.html new file mode 100644 index 0000000..b3e42bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload8.html @@ -0,0 +1,88 @@ + + + +basic_raw_socket::basic_raw_socket (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_raw_socket on an existing + native socket. +

+
template<
+    typename ExecutionContext>
+basic_raw_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a raw socket object to hold an existing native + socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload9.html new file mode 100644 index 0000000..c4f01ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/basic_raw_socket/overload9.html @@ -0,0 +1,68 @@ + + + +basic_raw_socket::basic_raw_socket (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_raw_socket from another. +

+
basic_raw_socket(
+    basic_raw_socket && other);
+
+

+ This constructor moves a raw socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_raw_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_raw_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind.html new file mode 100644 index 0000000..e43ba4e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind.html @@ -0,0 +1,49 @@ + + + +basic_raw_socket::bind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bind the socket + to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+  » more...
+
+void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind/overload1.html new file mode 100644 index 0000000..49074bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind/overload1.html @@ -0,0 +1,84 @@ + + + +basic_raw_socket::bind (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind/overload2.html new file mode 100644 index 0000000..e97e41b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bind/overload2.html @@ -0,0 +1,81 @@ + + + +basic_raw_socket::bind (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+asio::error_code ec;
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/broadcast.html new file mode 100644 index 0000000..ddb7a3f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/broadcast.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to permit sending of broadcast messages. +

+
typedef implementation_defined broadcast;
+
+

+ Implements the SOL_SOCKET/SO_BROADCAST socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bytes_readable.html new file mode 100644 index 0000000..64acef8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/bytes_readable.html @@ -0,0 +1,68 @@ + + + +basic_raw_socket::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +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. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::bytes_readable command(true);
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel.html new file mode 100644 index 0000000..55efe22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel.html @@ -0,0 +1,47 @@ + + + +basic_raw_socket::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel all + asynchronous operations associated with the socket. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel/overload1.html new file mode 100644 index 0000000..873c566 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel/overload1.html @@ -0,0 +1,105 @@ + + + +basic_raw_socket::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel/overload2.html new file mode 100644 index 0000000..8820bc2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/cancel/overload2.html @@ -0,0 +1,106 @@ + + + +basic_raw_socket::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close.html new file mode 100644 index 0000000..8b6c6a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close.html @@ -0,0 +1,46 @@ + + + +basic_raw_socket::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the socket. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close/overload1.html new file mode 100644 index 0000000..ab5ff91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close/overload1.html @@ -0,0 +1,71 @@ + + + +basic_raw_socket::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close();
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close/overload2.html new file mode 100644 index 0000000..ebb66af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/close/overload2.html @@ -0,0 +1,85 @@ + + + +basic_raw_socket::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect.html new file mode 100644 index 0000000..0e54a61 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect.html @@ -0,0 +1,49 @@ + + + +basic_raw_socket::connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Connect the + socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+  » more...
+
+void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect/overload1.html new file mode 100644 index 0000000..25236d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect/overload1.html @@ -0,0 +1,90 @@ + + + +basic_raw_socket::connect (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.connect(endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect/overload2.html new file mode 100644 index 0000000..accde64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/connect/overload2.html @@ -0,0 +1,87 @@ + + + +basic_raw_socket::connect (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+asio::error_code ec;
+socket.connect(endpoint, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/debug.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/debug.html new file mode 100644 index 0000000..f81811f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/debug.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::debug + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket option + to enable socket-level debugging. +

+
typedef implementation_defined debug;
+
+

+ Implements the SOL_SOCKET/SO_DEBUG socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/do_not_route.html new file mode 100644 index 0000000..a059b8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/do_not_route.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to prevent routing, use local interfaces only. +

+
typedef implementation_defined do_not_route;
+
+

+ Implements the SOL_SOCKET/SO_DONTROUTE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/enable_connection_aborted.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/enable_connection_aborted.html new file mode 100644 index 0000000..ca44ece --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/enable_connection_aborted.html @@ -0,0 +1,81 @@ + + + +basic_raw_socket::enable_connection_aborted + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to report aborted connections on accept. +

+
typedef implementation_defined enable_connection_aborted;
+
+

+ Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with asio::error::connection_aborted. + By default the option is false. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/endpoint_type.html new file mode 100644 index 0000000..4a3d616 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_raw_socket::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/executor_type.html new file mode 100644 index 0000000..b8a7af0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_raw_socket::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_executor.html new file mode 100644 index 0000000..d69824e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_executor.html @@ -0,0 +1,45 @@ + + + +basic_raw_socket::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option.html new file mode 100644 index 0000000..abd4ea0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option.html @@ -0,0 +1,53 @@ + + + +basic_raw_socket::get_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+  » more...
+
+template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option/overload1.html new file mode 100644 index 0000000..c2b7842 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option/overload1.html @@ -0,0 +1,89 @@ + + + +basic_raw_socket::get_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option/overload2.html new file mode 100644 index 0000000..38933be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/get_option/overload2.html @@ -0,0 +1,86 @@ + + + +basic_raw_socket::get_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+asio::error_code ec;
+socket.get_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control.html new file mode 100644 index 0000000..9429a58 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control.html @@ -0,0 +1,53 @@ + + + +basic_raw_socket::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control/overload1.html new file mode 100644 index 0000000..02e2c8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control/overload1.html @@ -0,0 +1,89 @@ + + + +basic_raw_socket::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control/overload2.html new file mode 100644 index 0000000..55c350e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/io_control/overload2.html @@ -0,0 +1,86 @@ + + + +basic_raw_socket::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+asio::error_code ec;
+socket.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/is_open.html new file mode 100644 index 0000000..8167e3c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/is_open.html @@ -0,0 +1,45 @@ + + + +basic_raw_socket::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Determine + whether the socket is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/keep_alive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/keep_alive.html new file mode 100644 index 0000000..2dd7966 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/keep_alive.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::keep_alive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to send keep-alives. +

+
typedef implementation_defined keep_alive;
+
+

+ Implements the SOL_SOCKET/SO_KEEPALIVE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/linger.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/linger.html new file mode 100644 index 0000000..33bfd62 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/linger.html @@ -0,0 +1,80 @@ + + + +basic_raw_socket::linger + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket option + to specify whether the socket lingers on close if unsent data is present. +

+
typedef implementation_defined linger;
+
+

+ Implements the SOL_SOCKET/SO_LINGER socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option(true, 30);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option;
+socket.get_option(option);
+bool is_set = option.enabled();
+unsigned short timeout = option.timeout();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint.html new file mode 100644 index 0000000..8e17592 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_raw_socket::local_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+  » more...
+
+endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint/overload1.html new file mode 100644 index 0000000..a0015d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_raw_socket::local_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint/overload2.html new file mode 100644 index 0000000..e18d556 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/local_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_raw_socket::local_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. Returns a + default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer.html new file mode 100644 index 0000000..82ca65d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_raw_socket::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer/overload1.html new file mode 100644 index 0000000..aa2ee8f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer/overload1.html @@ -0,0 +1,58 @@ + + + +basic_raw_socket::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ 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 basic_socket + cannot contain any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer/overload2.html new file mode 100644 index 0000000..32450c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer/overload2.html @@ -0,0 +1,58 @@ + + + +basic_raw_socket::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_socket cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer_type.html new file mode 100644 index 0000000..c6c235d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/lowest_layer_type.html @@ -0,0 +1,834 @@ + + + +basic_raw_socket::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +A + basic_socket + is always the lowest layer. +

+
typedef basic_socket< Protocol, Executor > lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_socket [constructor] +

+ 		+

+ Construct a basic_socket without opening it.
—
Construct + and open a basic_socket.
—
Construct a basic_socket, + opening it and binding it to the given local endpoint.
+ —
Construct a basic_socket on an existing native socket. +
—
Move-construct a basic_socket from another.
+ —
Move-construct a basic_socket from a socket of another + protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket from another.
—
Move-assign + a basic_socket from a socket of another protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_socket [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/max_listen_connections.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/max_listen_connections.html new file mode 100644 index 0000000..a2eef88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/max_listen_connections.html @@ -0,0 +1,45 @@ + + + +basic_raw_socket::max_listen_connections + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +The + maximum length of the queue of pending incoming connections. +

+
static const int max_listen_connections = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_do_not_route.html new file mode 100644 index 0000000..4eb45b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_do_not_route.html @@ -0,0 +1,45 @@ + + + +basic_raw_socket::message_do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specify + that the data should not be subject to routing. +

+
static const int message_do_not_route = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_end_of_record.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_end_of_record.html new file mode 100644 index 0000000..ec10ab3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_end_of_record.html @@ -0,0 +1,45 @@ + + + +basic_raw_socket::message_end_of_record + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specifies + that the data marks the end of a record. +

+
static const int message_end_of_record = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_flags.html new file mode 100644 index 0000000..7e4ad84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_flags.html @@ -0,0 +1,55 @@ + + + +basic_raw_socket::message_flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Bitmask + type for flags that can be passed to send and receive operations. +

+
typedef int message_flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_out_of_band.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_out_of_band.html new file mode 100644 index 0000000..0081a77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_out_of_band.html @@ -0,0 +1,45 @@ + + + +basic_raw_socket::message_out_of_band + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Process + out-of-band data. +

+
static const int message_out_of_band = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_peek.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_peek.html new file mode 100644 index 0000000..8ad6b3e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/message_peek.html @@ -0,0 +1,45 @@ + + + +basic_raw_socket::message_peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Peek + at incoming data without removing it from the input queue. +

+
static const int message_peek = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_handle.html new file mode 100644 index 0000000..5b87777 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_handle.html @@ -0,0 +1,50 @@ + + + +basic_raw_socket::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the native socket representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + socket. This is intended to allow access to native socket functionality + that is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_handle_type.html new file mode 100644 index 0000000..94d67b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_raw_socket::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a socket. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking.html new file mode 100644 index 0000000..fe65350 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_raw_socket::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload1.html new file mode 100644 index 0000000..117ac9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload1.html @@ -0,0 +1,144 @@ + + + +basic_raw_socket::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+
+

+ This function is used to retrieve the non-blocking mode of the underlying + native socket. This mode has no effect on the behaviour of the socket + object's synchronous operations. +

+
+ + Return + Value +
+

+ true if the underlying socket + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + Remarks +
+

+ The current non-blocking mode is cached by the socket object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native socket. +

+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload2.html new file mode 100644 index 0000000..89b9f14 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload2.html @@ -0,0 +1,159 @@ + + + +basic_raw_socket::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload3.html new file mode 100644 index 0000000..aceeaf4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/native_non_blocking/overload3.html @@ -0,0 +1,150 @@ + + + +basic_raw_socket::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking.html new file mode 100644 index 0000000..f2bb5bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_raw_socket::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the socket. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload1.html new file mode 100644 index 0000000..664820d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload1.html @@ -0,0 +1,64 @@ + + + +basic_raw_socket::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the socket. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the socket's synchronous + operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload2.html new file mode 100644 index 0000000..127db88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload2.html @@ -0,0 +1,83 @@ + + + +basic_raw_socket::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload3.html new file mode 100644 index 0000000..bf222c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/non_blocking/overload3.html @@ -0,0 +1,75 @@ + + + +basic_raw_socket::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open.html new file mode 100644 index 0000000..20a69d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open.html @@ -0,0 +1,49 @@ + + + +basic_raw_socket::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the socket + using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+  » more...
+
+void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open/overload1.html new file mode 100644 index 0000000..1dfe71b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open/overload1.html @@ -0,0 +1,81 @@ + + + +basic_raw_socket::open (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open/overload2.html new file mode 100644 index 0000000..e18e76d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/open/overload2.html @@ -0,0 +1,78 @@ + + + +basic_raw_socket::open (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying which protocol is to be used. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::error_code ec;
+socket.open(asio::ip::tcp::v4(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_.html new file mode 100644 index 0000000..7551663 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_.html @@ -0,0 +1,56 @@ + + + +basic_raw_socket::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_raw_socket + from another. +

+
basic_raw_socket & operator=(
+    basic_raw_socket && other);
+  » more...
+
+

+ Move-assign a basic_raw_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_raw_socket & > operator=(
+    basic_raw_socket< Protocol1, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_/overload1.html new file mode 100644 index 0000000..760cbfd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_raw_socket::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_raw_socket from another. +

+
basic_raw_socket & operator=(
+    basic_raw_socket && other);
+
+

+ This assignment operator moves a raw socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_raw_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_raw_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_/overload2.html new file mode 100644 index 0000000..64fccc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +basic_raw_socket::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_raw_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_raw_socket & > operator=(
+    basic_raw_socket< Protocol1, Executor1 > && other);
+
+

+ This assignment operator moves a raw socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_raw_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_raw_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/out_of_band_inline.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/out_of_band_inline.html new file mode 100644 index 0000000..d0b492c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/out_of_band_inline.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::out_of_band_inline + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for putting received out-of-band data inline. +

+
typedef implementation_defined out_of_band_inline;
+
+

+ Implements the SOL_SOCKET/SO_OOBINLINE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option;
+socket.get_option(option);
+bool value = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/protocol_type.html new file mode 100644 index 0000000..49a67d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_raw_socket::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive.html new file mode 100644 index 0000000..194c4eb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive.html @@ -0,0 +1,61 @@ + + + +basic_raw_socket::receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Receive some + data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload1.html new file mode 100644 index 0000000..5efb4a5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload1.html @@ -0,0 +1,105 @@ + + + +basic_raw_socket::receive (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to receive data on the raw socket. The function + call will block until data has been received successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The receive operation can only be used with a connected socket. Use the + receive_from function to receive data on an unconnected raw socket. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.receive(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload2.html new file mode 100644 index 0000000..8e5b560 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload2.html @@ -0,0 +1,96 @@ + + + +basic_raw_socket::receive (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags);
+
+

+ This function is used to receive data on the raw socket. The function + call will block until data has been received successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The receive operation can only be used with a connected socket. Use the + receive_from function to receive data on an unconnected raw socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload3.html new file mode 100644 index 0000000..c2ea850 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive/overload3.html @@ -0,0 +1,88 @@ + + + +basic_raw_socket::receive (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to receive data on the raw socket. The function + call will block until data has been received successfully or an error + occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Remarks +
+

+ The receive operation can only be used with a connected socket. Use the + receive_from function to receive data on an unconnected raw socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_buffer_size.html new file mode 100644 index 0000000..bface2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::receive_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive buffer size of a socket. +

+
typedef implementation_defined receive_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_RCVBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from.html new file mode 100644 index 0000000..53230a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from.html @@ -0,0 +1,64 @@ + + + +basic_raw_socket::receive_from + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Receive + raw data with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload1.html new file mode 100644 index 0000000..8f6a41d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload1.html @@ -0,0 +1,104 @@ + + + +basic_raw_socket::receive_from (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive raw data with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint);
+
+

+ This function is used to receive raw data. The function call will block + until data has been received successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the data. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
asio::ip::udp::endpoint sender_endpoint;
+socket.receive_from(
+    asio::buffer(data, size), sender_endpoint);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload2.html new file mode 100644 index 0000000..115b7f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload2.html @@ -0,0 +1,93 @@ + + + +basic_raw_socket::receive_from (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive raw data with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags);
+
+

+ This function is used to receive raw data. The function call will block + until data has been received successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the data. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload3.html new file mode 100644 index 0000000..2e78788 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_from/overload3.html @@ -0,0 +1,85 @@ + + + +basic_raw_socket::receive_from (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive raw data with the endpoint of the sender. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive_from(
+    const MutableBufferSequence & buffers,
+    endpoint_type & sender_endpoint,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to receive raw data. The function call will block + until data has been received successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
sender_endpoint
+

+ An endpoint object that receives the endpoint of the remote sender + of the data. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_low_watermark.html new file mode 100644 index 0000000..75d77cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/receive_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::receive_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive low watermark. +

+
typedef implementation_defined receive_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_RCVLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release.html new file mode 100644 index 0000000..a1cc638 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release.html @@ -0,0 +1,47 @@ + + + +basic_raw_socket::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release ownership + of the underlying native socket. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release/overload1.html new file mode 100644 index 0000000..d1eb2d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release/overload1.html @@ -0,0 +1,72 @@ + + + +basic_raw_socket::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release/overload2.html new file mode 100644 index 0000000..cf92e92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/release/overload2.html @@ -0,0 +1,73 @@ + + + +basic_raw_socket::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint.html new file mode 100644 index 0000000..06984c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_raw_socket::remote_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+  » more...
+
+endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint/overload1.html new file mode 100644 index 0000000..0e10bbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_raw_socket::remote_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint/overload2.html new file mode 100644 index 0000000..f9de82d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/remote_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_raw_socket::remote_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. Returns + a default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/reuse_address.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/reuse_address.html new file mode 100644 index 0000000..a1ffb77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/reuse_address.html @@ -0,0 +1,80 @@ + + + +basic_raw_socket::reuse_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from 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. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send.html new file mode 100644 index 0000000..e1f09dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send.html @@ -0,0 +1,61 @@ + + + +basic_raw_socket::send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Send some data + on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload1.html new file mode 100644 index 0000000..129395b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload1.html @@ -0,0 +1,104 @@ + + + +basic_raw_socket::send (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to send data on the raw socket. The function call + will block until the data has been sent successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The send operation can only be used with a connected socket. Use the + send_to function to send data on an unconnected raw socket. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.send(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload2.html new file mode 100644 index 0000000..0a25926 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload2.html @@ -0,0 +1,95 @@ + + + +basic_raw_socket::send (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+
+

+ This function is used to send data on the raw socket. The function call + will block until the data has been sent successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The send operation can only be used with a connected socket. Use the + send_to function to send data on an unconnected raw socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload3.html new file mode 100644 index 0000000..0847fb1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send/overload3.html @@ -0,0 +1,87 @@ + + + +basic_raw_socket::send (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on a connected socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to send data on the raw socket. The function call + will block until the data has been sent successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Remarks +
+

+ The send operation can only be used with a connected socket. Use the + send_to function to send data on an unconnected raw socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_buffer_size.html new file mode 100644 index 0000000..ae53b3c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::send_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send buffer size of a socket. +

+
typedef implementation_defined send_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_SNDBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_low_watermark.html new file mode 100644 index 0000000..2c5fb93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_raw_socket::send_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send low watermark. +

+
typedef implementation_defined send_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_SNDLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to.html new file mode 100644 index 0000000..b2ce0ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to.html @@ -0,0 +1,64 @@ + + + +basic_raw_socket::send_to + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Send raw + data to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload1.html new file mode 100644 index 0000000..57ac6d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload1.html @@ -0,0 +1,104 @@ + + + +basic_raw_socket::send_to (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send raw data to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination);
+
+

+ This function is used to send raw data to the specified remote endpoint. + The function call will block until the data has been sent successfully + or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. +

+
destination
+

+ The remote endpoint to which the data will be sent. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
asio::ip::udp::endpoint destination(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.send_to(asio::buffer(data, size), destination);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload2.html new file mode 100644 index 0000000..c774511 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload2.html @@ -0,0 +1,93 @@ + + + +basic_raw_socket::send_to (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send raw data to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags);
+
+

+ This function is used to send raw data to the specified remote endpoint. + The function call will block until the data has been sent successfully + or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. +

+
destination
+

+ The remote endpoint to which the data will be sent. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload3.html new file mode 100644 index 0000000..5705509 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/send_to/overload3.html @@ -0,0 +1,85 @@ + + + +basic_raw_socket::send_to (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send raw data to the specified endpoint. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send_to(
+    const ConstBufferSequence & buffers,
+    const endpoint_type & destination,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to send raw data to the specified remote endpoint. + The function call will block until the data has been sent successfully + or an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent to the remote endpoint. +

+
destination
+

+ The remote endpoint to which the data will be sent. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option.html new file mode 100644 index 0000000..30e087b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option.html @@ -0,0 +1,53 @@ + + + +basic_raw_socket::set_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+  » more...
+
+template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option/overload1.html new file mode 100644 index 0000000..0d4370f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option/overload1.html @@ -0,0 +1,88 @@ + + + +basic_raw_socket::set_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+socket.set_option(option);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option/overload2.html new file mode 100644 index 0000000..f4c2cc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/set_option/overload2.html @@ -0,0 +1,85 @@ + + + +basic_raw_socket::set_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+asio::error_code ec;
+socket.set_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown.html new file mode 100644 index 0000000..8ba14a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown.html @@ -0,0 +1,49 @@ + + + +basic_raw_socket::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+  » more...
+
+void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown/overload1.html new file mode 100644 index 0000000..864233c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown/overload1.html @@ -0,0 +1,86 @@ + + + +basic_raw_socket::shutdown (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.shutdown(asio::ip::tcp::socket::shutdown_send);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown/overload2.html new file mode 100644 index 0000000..1be601b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown/overload2.html @@ -0,0 +1,83 @@ + + + +basic_raw_socket::shutdown (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.shutdown(asio::ip::tcp::socket::shutdown_send, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown_type.html new file mode 100644 index 0000000..f0875f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/shutdown_type.html @@ -0,0 +1,71 @@ + + + +basic_raw_socket::shutdown_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Different + ways a socket may be shutdown. +

+
enum shutdown_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
shutdown_receive
+

+ Shutdown the receive side of the socket. +

+
shutdown_send
+

+ Shutdown the send side of the socket. +

+
shutdown_both
+

+ Shutdown both send and receive on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait.html new file mode 100644 index 0000000..0fed8ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait.html @@ -0,0 +1,49 @@ + + + +basic_raw_socket::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait for the socket + to become ready to read, ready to write, or to have pending error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait/overload1.html new file mode 100644 index 0000000..aa7ece6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait/overload1.html @@ -0,0 +1,74 @@ + + + +basic_raw_socket::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.wait(asio::ip::tcp::socket::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait/overload2.html new file mode 100644 index 0000000..1117219 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait/overload2.html @@ -0,0 +1,80 @@ + + + +basic_raw_socket::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.wait(asio::ip::tcp::socket::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait_type.html new file mode 100644 index 0000000..72e5a2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket/wait_type.html @@ -0,0 +1,74 @@ + + + +basic_raw_socket::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a socket to become ready to read. +

+
wait_write
+

+ Wait for a socket to become ready to write. +

+
wait_error
+

+ Wait for a socket to have error conditions pending. +

+
+
+

+ For use with basic_socket::wait() and basic_socket::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket__rebind_executor.html new file mode 100644 index 0000000..732b874 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_raw_socket::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the socket type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The socket type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket__rebind_executor/other.html new file mode 100644 index 0000000..775ea77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_raw_socket__rebind_executor/other.html @@ -0,0 +1,912 @@ + + + +basic_raw_socket::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + socket type when rebound to the specified executor. +

+
typedef basic_raw_socket< Protocol, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_raw_socket [constructor] +

+ 		+

+ Construct a basic_raw_socket without opening it.
—
+ Construct and open a basic_raw_socket.
—
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.
—
Move-construct a basic_raw_socket + from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_raw_socket from another.
—
Move-assign + a basic_raw_socket from a socket of another protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive raw data with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send raw data to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_raw_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_raw_socket + class template provides asynchronous and blocking raw-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_raw_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe.html new file mode 100644 index 0000000..2728474 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe.html @@ -0,0 +1,329 @@ + + + +basic_readable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides pipe functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_readable_pipe
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_readable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ basic_readable_pipe [constructor] +

+ 		+

+ Construct a basic_readable_pipe without opening it.
—
+ Construct a basic_readable_pipe on an existing native pipe.
+ —
Move-construct a basic_readable_pipe from another.
+ —
Move-construct a basic_readable_pipe from a pipe of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_readable_pipe from another.
—
Move-assign + a basic_readable_pipe from a pipe of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the pipe. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ ~basic_readable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_readable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_readable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/_basic_readable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/_basic_readable_pipe.html new file mode 100644 index 0000000..1faef4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/_basic_readable_pipe.html @@ -0,0 +1,46 @@ + + + +basic_readable_pipe::~basic_readable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the pipe. +

+
~basic_readable_pipe();
+
+

+ This function destroys the pipe, cancelling any outstanding asynchronous + wait operations associated with the pipe as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign.html new file mode 100644 index 0000000..3b75ec6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign.html @@ -0,0 +1,49 @@ + + + +basic_readable_pipe::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native pipe to the pipe. +

+
void assign(
+    const native_handle_type & native_pipe);
+  » more...
+
+void assign(
+    const native_handle_type & native_pipe,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign/overload1.html new file mode 100644 index 0000000..77ee779 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign/overload1.html @@ -0,0 +1,42 @@ + + + +basic_readable_pipe::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native pipe to the pipe. +

+
void assign(
+    const native_handle_type & native_pipe);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign/overload2.html new file mode 100644 index 0000000..68c5de3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/assign/overload2.html @@ -0,0 +1,43 @@ + + + +basic_readable_pipe::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native pipe to the pipe. +

+
void assign(
+    const native_handle_type & native_pipe,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/async_read_some.html new file mode 100644 index 0000000..1c12e1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/async_read_some.html @@ -0,0 +1,124 @@ + + + +basic_readable_pipe::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the pipe. It is + an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
basic_readable_pipe.async_read_some(
+    asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe.html new file mode 100644 index 0000000..3455fd4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe.html @@ -0,0 +1,87 @@ + + + +basic_readable_pipe::basic_readable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_readable_pipe + without opening it. +

+
explicit basic_readable_pipe(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_readable_pipe(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_readable_pipe on an existing + native pipe. +

+
basic_readable_pipe(
+    const executor_type & ex,
+    const native_handle_type & native_pipe);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_readable_pipe(
+    ExecutionContext & context,
+    const native_handle_type & native_pipe,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_readable_pipe from another. +

+
basic_readable_pipe(
+    basic_readable_pipe && other);
+  » more...
+
+

+ Move-construct a basic_readable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+basic_readable_pipe(
+    basic_readable_pipe< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload1.html new file mode 100644 index 0000000..0ab28f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload1.html @@ -0,0 +1,60 @@ + + + +basic_readable_pipe::basic_readable_pipe (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_readable_pipe without + opening it. +

+
basic_readable_pipe(
+    const executor_type & ex);
+
+

+ This constructor creates a pipe without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the pipe will use, by default, to dispatch + handlers for any asynchronous operations performed on the pipe. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload2.html new file mode 100644 index 0000000..45aaf35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload2.html @@ -0,0 +1,64 @@ + + + +basic_readable_pipe::basic_readable_pipe (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_readable_pipe without + opening it. +

+
template<
+    typename ExecutionContext>
+basic_readable_pipe(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a pipe without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the pipe + will use, by default, to dispatch handlers for any asynchronous + operations performed on the pipe. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload3.html new file mode 100644 index 0000000..3dd2eb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload3.html @@ -0,0 +1,78 @@ + + + +basic_readable_pipe::basic_readable_pipe (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_readable_pipe on an existing + native pipe. +

+
basic_readable_pipe(
+    const executor_type & ex,
+    const native_handle_type & native_pipe);
+
+

+ This constructor creates a pipe object to hold an existing native pipe. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the pipe will use, by default, to dispatch + handlers for any asynchronous operations performed on the pipe. +

+
native_pipe
+

+ A native pipe. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload4.html new file mode 100644 index 0000000..c0780d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload4.html @@ -0,0 +1,82 @@ + + + +basic_readable_pipe::basic_readable_pipe (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_readable_pipe on an existing + native pipe. +

+
template<
+    typename ExecutionContext>
+basic_readable_pipe(
+    ExecutionContext & context,
+    const native_handle_type & native_pipe,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a pipe object to hold an existing native pipe. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the pipe + will use, by default, to dispatch handlers for any asynchronous + operations performed on the pipe. +

+
native_pipe
+

+ A native pipe. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload5.html new file mode 100644 index 0000000..f848144 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload5.html @@ -0,0 +1,68 @@ + + + +basic_readable_pipe::basic_readable_pipe (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_readable_pipe from another. +

+
basic_readable_pipe(
+    basic_readable_pipe && other);
+
+

+ This constructor moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_readable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_readable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload6.html new file mode 100644 index 0000000..e2a827e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/basic_readable_pipe/overload6.html @@ -0,0 +1,72 @@ + + + +basic_readable_pipe::basic_readable_pipe (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_readable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+basic_readable_pipe(
+    basic_readable_pipe< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_readable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_readable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel.html new file mode 100644 index 0000000..a159e08 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel.html @@ -0,0 +1,47 @@ + + + +basic_readable_pipe::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the pipe. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel/overload1.html new file mode 100644 index 0000000..a7d812b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel/overload1.html @@ -0,0 +1,59 @@ + + + +basic_readable_pipe::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the pipe. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel/overload2.html new file mode 100644 index 0000000..c28ce2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/cancel/overload2.html @@ -0,0 +1,60 @@ + + + +basic_readable_pipe::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the pipe. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close.html new file mode 100644 index 0000000..48df6fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close.html @@ -0,0 +1,47 @@ + + + +basic_readable_pipe::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the + pipe. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close/overload1.html new file mode 100644 index 0000000..a2de0fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close/overload1.html @@ -0,0 +1,58 @@ + + + +basic_readable_pipe::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the pipe. +

+
void close();
+
+

+ This function is used to close the pipe. Any asynchronous read operations + will be cancelled immediately, and will complete with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close/overload2.html new file mode 100644 index 0000000..21d6b92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/close/overload2.html @@ -0,0 +1,59 @@ + + + +basic_readable_pipe::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the pipe. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the pipe. Any asynchronous read operations + will be cancelled immediately, and will complete with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/executor_type.html new file mode 100644 index 0000000..e6c16e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_readable_pipe::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_readable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/get_executor.html new file mode 100644 index 0000000..79908ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_readable_pipe::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/is_open.html new file mode 100644 index 0000000..5519021 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/is_open.html @@ -0,0 +1,42 @@ + + + +basic_readable_pipe::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the pipe is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer.html new file mode 100644 index 0000000..ed631db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_readable_pipe::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer/overload1.html new file mode 100644 index 0000000..5689929 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer/overload1.html @@ -0,0 +1,55 @@ + + + +basic_readable_pipe::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 basic_readable_pipe cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer/overload2.html new file mode 100644 index 0000000..31e9634 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer/overload2.html @@ -0,0 +1,55 @@ + + + +basic_readable_pipe::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_readable_pipe cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer_type.html new file mode 100644 index 0000000..dcafff9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/lowest_layer_type.html @@ -0,0 +1,328 @@ + + + +basic_readable_pipe::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + basic_readable_pipe + is always the lowest layer. +

+
typedef basic_readable_pipe lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_readable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ basic_readable_pipe [constructor] +

+ 		+

+ Construct a basic_readable_pipe without opening it.
—
+ Construct a basic_readable_pipe on an existing native pipe. +
—
Move-construct a basic_readable_pipe from another. +
—
Move-construct a basic_readable_pipe from a pipe + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_readable_pipe from another.
—
+ Move-assign a basic_readable_pipe from a pipe of another executor + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the pipe. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ ~basic_readable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_readable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_readable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/native_handle.html new file mode 100644 index 0000000..bd422bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/native_handle.html @@ -0,0 +1,47 @@ + + + +basic_readable_pipe::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the native pipe representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + pipe. This is intended to allow access to native pipe functionality that + is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/native_handle_type.html new file mode 100644 index 0000000..12d83d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_readable_pipe::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a pipe. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_readable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_.html new file mode 100644 index 0000000..2b64c3f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_.html @@ -0,0 +1,55 @@ + + + +basic_readable_pipe::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_readable_pipe + from another. +

+
basic_readable_pipe & operator=(
+    basic_readable_pipe && other);
+  » more...
+
+

+ Move-assign a basic_readable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_readable_pipe & > operator=(
+    basic_readable_pipe< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_/overload1.html new file mode 100644 index 0000000..24a19a5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_readable_pipe::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_readable_pipe from another. +

+
basic_readable_pipe & operator=(
+    basic_readable_pipe && other);
+
+

+ This assignment operator moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_readable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_readable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_/overload2.html new file mode 100644 index 0000000..dd03ebb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +basic_readable_pipe::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_readable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_readable_pipe & > operator=(
+    basic_readable_pipe< Executor1 > && other);
+
+

+ This assignment operator moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_readable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_readable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some.html new file mode 100644 index 0000000..07cc61a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some.html @@ -0,0 +1,53 @@ + + + +basic_readable_pipe::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the pipe. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some/overload1.html new file mode 100644 index 0000000..7bc49b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some/overload1.html @@ -0,0 +1,108 @@ + + + +basic_readable_pipe::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the pipe. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to read data from the pipe. The function call will + block until one or more bytes of data has been read successfully, or + until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
basic_readable_pipe.read_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some/overload2.html new file mode 100644 index 0000000..a5e6f56 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/read_some/overload2.html @@ -0,0 +1,85 @@ + + + +basic_readable_pipe::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the pipe. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to read data from the pipe. The function call will + block until one or more bytes of data has been read successfully, or + until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release.html new file mode 100644 index 0000000..8a51c35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release.html @@ -0,0 +1,47 @@ + + + +basic_readable_pipe::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native pipe. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release/overload1.html new file mode 100644 index 0000000..04f6d9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release/overload1.html @@ -0,0 +1,69 @@ + + + +basic_readable_pipe::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native pipe. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous read operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. Ownership + of the native pipe is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release/overload2.html new file mode 100644 index 0000000..9329a42 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe/release/overload2.html @@ -0,0 +1,70 @@ + + + +basic_readable_pipe::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native pipe. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. Ownership + of the native pipe is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe__rebind_executor.html new file mode 100644 index 0000000..23a49ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_readable_pipe::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the pipe type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The pipe type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_readable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe__rebind_executor/other.html new file mode 100644 index 0000000..218d627 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_readable_pipe__rebind_executor/other.html @@ -0,0 +1,327 @@ + + + +basic_readable_pipe::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + pipe type when rebound to the specified executor. +

+
typedef basic_readable_pipe< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_readable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ basic_readable_pipe [constructor] +

+ 		+

+ Construct a basic_readable_pipe without opening it.
—
+ Construct a basic_readable_pipe on an existing native pipe. +
—
Move-construct a basic_readable_pipe from another. +
—
Move-construct a basic_readable_pipe from a pipe + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_readable_pipe from another.
—
+ Move-assign a basic_readable_pipe from a pipe of another executor + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the pipe. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ ~basic_readable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_readable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_readable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket.html new file mode 100644 index 0000000..23b4a0a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket.html @@ -0,0 +1,868 @@ + + + +basic_seq_packet_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides sequenced packet socket functionality. +

+
template<
+    typename Protocol,
+    typename Executor>
+class basic_seq_packet_socket :
+  public basic_socket< Protocol, Executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close if + unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_seq_packet_socket [constructor] +

+ 		+

+ Construct a basic_seq_packet_socket without opening it.
+ —
Construct and open a basic_seq_packet_socket.
—
+ Construct a basic_seq_packet_socket, opening it and binding it + to the given local endpoint.
—
Construct a basic_seq_packet_socket + on an existing native socket.
—
Move-construct a basic_seq_packet_socket + from another.
—
Move-construct a basic_seq_packet_socket + from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets the + non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_seq_packet_socket from another.
—
+ Move-assign a basic_seq_packet_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, or + to have pending error conditions. +

+
+

+ ~basic_seq_packet_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_seq_packet_socket class template + provides asynchronous and blocking sequenced packet socket functionality. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations are + thread safe with respect to each other, if the underlying operating system + calls are also thread safe. This means that it is permitted to perform concurrent + calls to these synchronous operations on a single socket object. Other synchronous + operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/_basic_seq_packet_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/_basic_seq_packet_socket.html new file mode 100644 index 0000000..21484de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/_basic_seq_packet_socket.html @@ -0,0 +1,46 @@ + + + +basic_seq_packet_socket::~basic_seq_packet_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the socket. +

+
~basic_seq_packet_socket();
+
+

+ This function destroys the socket, cancelling any outstanding asynchronous + operations associated with the socket as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign.html new file mode 100644 index 0000000..f138ff5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign.html @@ -0,0 +1,51 @@ + + + +basic_seq_packet_socket::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign/overload1.html new file mode 100644 index 0000000..63b74fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign/overload1.html @@ -0,0 +1,46 @@ + + + +basic_seq_packet_socket::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign/overload2.html new file mode 100644 index 0000000..fb22ad7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/assign/overload2.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_connect.html new file mode 100644 index 0000000..f2a1b19 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_connect.html @@ -0,0 +1,142 @@ + + + +basic_seq_packet_socket::async_connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Start + an asynchronous connect. +

+
template<
+    typename ConnectToken = default_completion_token_t<executor_type>>
+DEDUCED async_connect(
+    const endpoint_type & peer_endpoint,
+    ConnectToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously connect a socket to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ The socket is automatically opened if it is not already open. If the connect + fails, and the socket was automatically opened, the socket is not returned + to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. Copies + will be made of the endpoint object as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void connect_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Connect succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.async_connect(endpoint, connect_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive.html new file mode 100644 index 0000000..15805e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive.html @@ -0,0 +1,59 @@ + + + +basic_seq_packet_socket::async_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags & out_flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags in_flags,
+    socket_base::message_flags & out_flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive/overload1.html new file mode 100644 index 0000000..8734bad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive/overload1.html @@ -0,0 +1,140 @@ + + + +basic_seq_packet_socket::async_receive (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags & out_flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the sequenced + packet socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
out_flags
+

+ Once the asynchronous operation completes, contains flags associated + with the received data. For example, if the socket_base::message_end_of_record + bit is set then the received data marks the end of a record. The + caller must guarantee that the referenced variable remains valid + until the completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive(asio::buffer(data, size), out_flags, handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive/overload2.html new file mode 100644 index 0000000..bd9d8e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_receive/overload2.html @@ -0,0 +1,147 @@ + + + +basic_seq_packet_socket::async_receive (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags in_flags,
+    socket_base::message_flags & out_flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the sequenced + data socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
in_flags
+

+ Flags specifying how the receive call is to be made. +

+
out_flags
+

+ Once the asynchronous operation completes, contains flags associated + with the received data. For example, if the socket_base::message_end_of_record + bit is set then the received data marks the end of a record. The + caller must guarantee that the referenced variable remains valid + until the completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive(
+    asio::buffer(data, size),
+    0, out_flags, handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_send.html new file mode 100644 index 0000000..0d4d792 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_send.html @@ -0,0 +1,138 @@ + + + +basic_seq_packet_socket::async_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send data on the sequenced packet + socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. 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 completion handler is called. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the send completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.async_send(asio::buffer(data, size), 0, handler);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_wait.html new file mode 100644 index 0000000..958d8cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/async_wait.html @@ -0,0 +1,137 @@ + + + +basic_seq_packet_socket::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Asynchronously + wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for a socket to enter + a ready to read, write or error condition state. It is an initiating function + for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+...
+socket.async_wait(asio::ip::tcp::socket::wait_read, wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark.html new file mode 100644 index 0000000..6148e5c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::at_mark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+  » more...
+
+bool at_mark(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark/overload1.html new file mode 100644 index 0000000..4228ebb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark/overload1.html @@ -0,0 +1,69 @@ + + + +basic_seq_packet_socket::at_mark (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark/overload2.html new file mode 100644 index 0000000..938f946 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/at_mark/overload2.html @@ -0,0 +1,70 @@ + + + +basic_seq_packet_socket::at_mark (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark(
+    asio::error_code & ec) const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available.html new file mode 100644 index 0000000..dce74ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::available + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the number of bytes available for reading. +

+
std::size_t available() const;
+  » more...
+
+std::size_t available(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available/overload1.html new file mode 100644 index 0000000..e5e6af4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available/overload1.html @@ -0,0 +1,70 @@ + + + +basic_seq_packet_socket::available (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available() const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available/overload2.html new file mode 100644 index 0000000..cd11448 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/available/overload2.html @@ -0,0 +1,71 @@ + + + +basic_seq_packet_socket::available (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available(
+    asio::error_code & ec) const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket.html new file mode 100644 index 0000000..d2fb2e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket.html @@ -0,0 +1,123 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_seq_packet_socket without + opening it. +

+
explicit basic_seq_packet_socket(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_seq_packet_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct and open a basic_seq_packet_socket. +

+
basic_seq_packet_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_seq_packet_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_seq_packet_socket, opening + it and binding it to the given local endpoint. +

+
basic_seq_packet_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_seq_packet_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct a basic_seq_packet_socket on an + existing native socket. +

+
basic_seq_packet_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_seq_packet_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_seq_packet_socket from another. +

+
basic_seq_packet_socket(
+    basic_seq_packet_socket && other);
+  » more...
+
+

+ Move-construct a basic_seq_packet_socket from a + socket of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_seq_packet_socket(
+    basic_seq_packet_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload1.html new file mode 100644 index 0000000..19775bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload1.html @@ -0,0 +1,62 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_seq_packet_socket without + opening it. +

+
basic_seq_packet_socket(
+    const executor_type & ex);
+
+

+ This constructor creates a sequenced packet socket without opening it. + The socket needs to be opened and then connected or accepted before data + can be sent or received on it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload10.html new file mode 100644 index 0000000..324a5a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload10.html @@ -0,0 +1,73 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_seq_packet_socket from + a socket of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_seq_packet_socket(
+    basic_seq_packet_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a sequenced packet socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_seq_packet_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_seq_packet_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload2.html new file mode 100644 index 0000000..9bfa35a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload2.html @@ -0,0 +1,66 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_seq_packet_socket without + opening it. +

+
template<
+    typename ExecutionContext>
+basic_seq_packet_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a sequenced packet socket without opening it. + The socket needs to be opened and then connected or accepted before data + can be sent or received on it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload3.html new file mode 100644 index 0000000..6e3d9d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload3.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_seq_packet_socket. +

+
basic_seq_packet_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+
+

+ This constructor creates and opens a sequenced_packet socket. The socket + needs to be connected or accepted before data can be sent or received + on it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload4.html new file mode 100644 index 0000000..12f67ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload4.html @@ -0,0 +1,83 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_seq_packet_socket. +

+
template<
+    typename ExecutionContext>
+basic_seq_packet_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates and opens a sequenced_packet socket. The socket + needs to be connected or accepted before data can be sent or received + on it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload5.html new file mode 100644 index 0000000..77952ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload5.html @@ -0,0 +1,81 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_seq_packet_socket, opening + it and binding it to the given local endpoint. +

+
basic_seq_packet_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+
+

+ This constructor creates a sequenced packet socket and automatically + opens it bound to the specified endpoint on the local machine. The protocol + used is the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the sequenced packet + socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload6.html new file mode 100644 index 0000000..5f68444 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload6.html @@ -0,0 +1,85 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_seq_packet_socket, opening + it and binding it to the given local endpoint. +

+
template<
+    typename ExecutionContext>
+basic_seq_packet_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a sequenced packet socket and automatically + opens it bound to the specified endpoint on the local machine. The protocol + used is the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the sequenced packet + socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload7.html new file mode 100644 index 0000000..703fc66 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload7.html @@ -0,0 +1,84 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_seq_packet_socket on an + existing native socket. +

+
basic_seq_packet_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+

+ This constructor creates a sequenced packet socket object to hold an + existing native socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload8.html new file mode 100644 index 0000000..1a5a4ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload8.html @@ -0,0 +1,88 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_seq_packet_socket on an + existing native socket. +

+
template<
+    typename ExecutionContext>
+basic_seq_packet_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a sequenced packet socket object to hold an + existing native socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload9.html new file mode 100644 index 0000000..067e8ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/basic_seq_packet_socket/overload9.html @@ -0,0 +1,69 @@ + + + +basic_seq_packet_socket::basic_seq_packet_socket (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_seq_packet_socket from + another. +

+
basic_seq_packet_socket(
+    basic_seq_packet_socket && other);
+
+

+ This constructor moves a sequenced packet socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_seq_packet_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_seq_packet_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind.html new file mode 100644 index 0000000..d233838 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind.html @@ -0,0 +1,49 @@ + + + +basic_seq_packet_socket::bind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bind + the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+  » more...
+
+void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind/overload1.html new file mode 100644 index 0000000..16fef9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind/overload1.html @@ -0,0 +1,84 @@ + + + +basic_seq_packet_socket::bind (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind/overload2.html new file mode 100644 index 0000000..d5d4f72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bind/overload2.html @@ -0,0 +1,81 @@ + + + +basic_seq_packet_socket::bind (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+asio::error_code ec;
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/broadcast.html new file mode 100644 index 0000000..69e77e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/broadcast.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to permit sending of broadcast messages. +

+
typedef implementation_defined broadcast;
+
+

+ Implements the SOL_SOCKET/SO_BROADCAST socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bytes_readable.html new file mode 100644 index 0000000..fc7e6ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/bytes_readable.html @@ -0,0 +1,68 @@ + + + +basic_seq_packet_socket::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +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. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::bytes_readable command(true);
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel.html new file mode 100644 index 0000000..949223a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the socket. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel/overload1.html new file mode 100644 index 0000000..77e3126 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel/overload1.html @@ -0,0 +1,105 @@ + + + +basic_seq_packet_socket::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel/overload2.html new file mode 100644 index 0000000..437ee71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/cancel/overload2.html @@ -0,0 +1,106 @@ + + + +basic_seq_packet_socket::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close.html new file mode 100644 index 0000000..0ef867d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the socket. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close/overload1.html new file mode 100644 index 0000000..dc3b6c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close/overload1.html @@ -0,0 +1,71 @@ + + + +basic_seq_packet_socket::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close();
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close/overload2.html new file mode 100644 index 0000000..d046dc4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/close/overload2.html @@ -0,0 +1,85 @@ + + + +basic_seq_packet_socket::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect.html new file mode 100644 index 0000000..58aca3e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect.html @@ -0,0 +1,49 @@ + + + +basic_seq_packet_socket::connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Connect + the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+  » more...
+
+void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect/overload1.html new file mode 100644 index 0000000..e60db93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect/overload1.html @@ -0,0 +1,90 @@ + + + +basic_seq_packet_socket::connect (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.connect(endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect/overload2.html new file mode 100644 index 0000000..f824392 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/connect/overload2.html @@ -0,0 +1,87 @@ + + + +basic_seq_packet_socket::connect (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+asio::error_code ec;
+socket.connect(endpoint, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/debug.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/debug.html new file mode 100644 index 0000000..d747bc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/debug.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::debug + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to enable socket-level debugging. +

+
typedef implementation_defined debug;
+
+

+ Implements the SOL_SOCKET/SO_DEBUG socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/do_not_route.html new file mode 100644 index 0000000..0d388f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/do_not_route.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to prevent routing, use local interfaces only. +

+
typedef implementation_defined do_not_route;
+
+

+ Implements the SOL_SOCKET/SO_DONTROUTE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/enable_connection_aborted.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/enable_connection_aborted.html new file mode 100644 index 0000000..46d17ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/enable_connection_aborted.html @@ -0,0 +1,81 @@ + + + +basic_seq_packet_socket::enable_connection_aborted + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to report aborted connections on accept. +

+
typedef implementation_defined enable_connection_aborted;
+
+

+ Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with asio::error::connection_aborted. + By default the option is false. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/endpoint_type.html new file mode 100644 index 0000000..25be806 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_seq_packet_socket::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/executor_type.html new file mode 100644 index 0000000..f321f29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_seq_packet_socket::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_executor.html new file mode 100644 index 0000000..edd98ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_executor.html @@ -0,0 +1,45 @@ + + + +basic_seq_packet_socket::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option.html new file mode 100644 index 0000000..bf69792 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option.html @@ -0,0 +1,53 @@ + + + +basic_seq_packet_socket::get_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+  » more...
+
+template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option/overload1.html new file mode 100644 index 0000000..75b6dd2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option/overload1.html @@ -0,0 +1,89 @@ + + + +basic_seq_packet_socket::get_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option/overload2.html new file mode 100644 index 0000000..d52836b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/get_option/overload2.html @@ -0,0 +1,86 @@ + + + +basic_seq_packet_socket::get_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+asio::error_code ec;
+socket.get_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control.html new file mode 100644 index 0000000..5bc2f8a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control.html @@ -0,0 +1,53 @@ + + + +basic_seq_packet_socket::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control/overload1.html new file mode 100644 index 0000000..924cdb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control/overload1.html @@ -0,0 +1,89 @@ + + + +basic_seq_packet_socket::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control/overload2.html new file mode 100644 index 0000000..0057f34 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/io_control/overload2.html @@ -0,0 +1,86 @@ + + + +basic_seq_packet_socket::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+asio::error_code ec;
+socket.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/is_open.html new file mode 100644 index 0000000..1fb18d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/is_open.html @@ -0,0 +1,45 @@ + + + +basic_seq_packet_socket::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Determine + whether the socket is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/keep_alive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/keep_alive.html new file mode 100644 index 0000000..5192aaa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/keep_alive.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::keep_alive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to send keep-alives. +

+
typedef implementation_defined keep_alive;
+
+

+ Implements the SOL_SOCKET/SO_KEEPALIVE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/linger.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/linger.html new file mode 100644 index 0000000..10f5604 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/linger.html @@ -0,0 +1,81 @@ + + + +basic_seq_packet_socket::linger + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to specify whether the socket lingers on close if unsent data is + present. +

+
typedef implementation_defined linger;
+
+

+ Implements the SOL_SOCKET/SO_LINGER socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option(true, 30);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option;
+socket.get_option(option);
+bool is_set = option.enabled();
+unsigned short timeout = option.timeout();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint.html new file mode 100644 index 0000000..e810537 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::local_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+  » more...
+
+endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint/overload1.html new file mode 100644 index 0000000..2abc7f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_seq_packet_socket::local_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint/overload2.html new file mode 100644 index 0000000..f78d4f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/local_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_seq_packet_socket::local_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. Returns a + default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer.html new file mode 100644 index 0000000..5c0b622 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_seq_packet_socket::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer/overload1.html new file mode 100644 index 0000000..3bf4bc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer/overload1.html @@ -0,0 +1,58 @@ + + + +basic_seq_packet_socket::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ 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 basic_socket + cannot contain any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer/overload2.html new file mode 100644 index 0000000..b9202ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer/overload2.html @@ -0,0 +1,58 @@ + + + +basic_seq_packet_socket::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_socket cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer_type.html new file mode 100644 index 0000000..7eb0d12 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/lowest_layer_type.html @@ -0,0 +1,834 @@ + + + +basic_seq_packet_socket::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +A + basic_socket + is always the lowest layer. +

+
typedef basic_socket< Protocol, Executor > lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_socket [constructor] +

+ 		+

+ Construct a basic_socket without opening it.
—
Construct + and open a basic_socket.
—
Construct a basic_socket, + opening it and binding it to the given local endpoint.
+ —
Construct a basic_socket on an existing native socket. +
—
Move-construct a basic_socket from another.
+ —
Move-construct a basic_socket from a socket of another + protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket from another.
—
Move-assign + a basic_socket from a socket of another protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_socket [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/max_listen_connections.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/max_listen_connections.html new file mode 100644 index 0000000..4de9214 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/max_listen_connections.html @@ -0,0 +1,45 @@ + + + +basic_seq_packet_socket::max_listen_connections + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +The + maximum length of the queue of pending incoming connections. +

+
static const int max_listen_connections = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_do_not_route.html new file mode 100644 index 0000000..61a144d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_do_not_route.html @@ -0,0 +1,45 @@ + + + +basic_seq_packet_socket::message_do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specify + that the data should not be subject to routing. +

+
static const int message_do_not_route = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_end_of_record.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_end_of_record.html new file mode 100644 index 0000000..4b5bf79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_end_of_record.html @@ -0,0 +1,45 @@ + + + +basic_seq_packet_socket::message_end_of_record + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specifies + that the data marks the end of a record. +

+
static const int message_end_of_record = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_flags.html new file mode 100644 index 0000000..77883b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_flags.html @@ -0,0 +1,55 @@ + + + +basic_seq_packet_socket::message_flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Bitmask + type for flags that can be passed to send and receive operations. +

+
typedef int message_flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_out_of_band.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_out_of_band.html new file mode 100644 index 0000000..01449f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_out_of_band.html @@ -0,0 +1,45 @@ + + + +basic_seq_packet_socket::message_out_of_band + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Process + out-of-band data. +

+
static const int message_out_of_band = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_peek.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_peek.html new file mode 100644 index 0000000..cc9e08a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/message_peek.html @@ -0,0 +1,45 @@ + + + +basic_seq_packet_socket::message_peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Peek + at incoming data without removing it from the input queue. +

+
static const int message_peek = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_handle.html new file mode 100644 index 0000000..e0ca770 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_handle.html @@ -0,0 +1,50 @@ + + + +basic_seq_packet_socket::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the native socket representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + socket. This is intended to allow access to native socket functionality + that is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_handle_type.html new file mode 100644 index 0000000..41fb98a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_seq_packet_socket::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a socket. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking.html new file mode 100644 index 0000000..8c4f5d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_seq_packet_socket::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload1.html new file mode 100644 index 0000000..89a3ff9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload1.html @@ -0,0 +1,144 @@ + + + +basic_seq_packet_socket::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+
+

+ This function is used to retrieve the non-blocking mode of the underlying + native socket. This mode has no effect on the behaviour of the socket + object's synchronous operations. +

+
+ + Return + Value +
+

+ true if the underlying socket + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + Remarks +
+

+ The current non-blocking mode is cached by the socket object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native socket. +

+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload2.html new file mode 100644 index 0000000..e997e0b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload2.html @@ -0,0 +1,159 @@ + + + +basic_seq_packet_socket::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload3.html new file mode 100644 index 0000000..592c898 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/native_non_blocking/overload3.html @@ -0,0 +1,150 @@ + + + +basic_seq_packet_socket::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking.html new file mode 100644 index 0000000..9c40ecc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_seq_packet_socket::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the socket. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload1.html new file mode 100644 index 0000000..a815a9d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload1.html @@ -0,0 +1,64 @@ + + + +basic_seq_packet_socket::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the socket. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the socket's synchronous + operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload2.html new file mode 100644 index 0000000..f4140a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload2.html @@ -0,0 +1,83 @@ + + + +basic_seq_packet_socket::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload3.html new file mode 100644 index 0000000..7c463a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/non_blocking/overload3.html @@ -0,0 +1,75 @@ + + + +basic_seq_packet_socket::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open.html new file mode 100644 index 0000000..160c65c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open.html @@ -0,0 +1,49 @@ + + + +basic_seq_packet_socket::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open + the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+  » more...
+
+void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open/overload1.html new file mode 100644 index 0000000..9e9a09b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open/overload1.html @@ -0,0 +1,81 @@ + + + +basic_seq_packet_socket::open (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open/overload2.html new file mode 100644 index 0000000..c072d82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/open/overload2.html @@ -0,0 +1,78 @@ + + + +basic_seq_packet_socket::open (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying which protocol is to be used. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::error_code ec;
+socket.open(asio::ip::tcp::v4(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_.html new file mode 100644 index 0000000..5fd0664 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_.html @@ -0,0 +1,55 @@ + + + +basic_seq_packet_socket::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_seq_packet_socket from another. +

+
basic_seq_packet_socket & operator=(
+    basic_seq_packet_socket && other);
+  » more...
+
+

+ Move-assign a basic_seq_packet_socket from a + socket of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_seq_packet_socket & > operator=(
+    basic_seq_packet_socket< Protocol1, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_/overload1.html new file mode 100644 index 0000000..1fc409a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_/overload1.html @@ -0,0 +1,70 @@ + + + +basic_seq_packet_socket::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_seq_packet_socket from + another. +

+
basic_seq_packet_socket & operator=(
+    basic_seq_packet_socket && other);
+
+

+ This assignment operator moves a sequenced packet socket from one object + to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_seq_packet_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_seq_packet_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_/overload2.html new file mode 100644 index 0000000..7541619 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/operator_eq_/overload2.html @@ -0,0 +1,73 @@ + + + +basic_seq_packet_socket::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_seq_packet_socket from + a socket of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_seq_packet_socket & > operator=(
+    basic_seq_packet_socket< Protocol1, Executor1 > && other);
+
+

+ This assignment operator moves a sequenced packet socket from one object + to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_seq_packet_socket + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_seq_packet_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/out_of_band_inline.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/out_of_band_inline.html new file mode 100644 index 0000000..d05f178 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/out_of_band_inline.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::out_of_band_inline + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for putting received out-of-band data inline. +

+
typedef implementation_defined out_of_band_inline;
+
+

+ Implements the SOL_SOCKET/SO_OOBINLINE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option;
+socket.get_option(option);
+bool value = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/protocol_type.html new file mode 100644 index 0000000..0656897 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_seq_packet_socket::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive.html new file mode 100644 index 0000000..674c777 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive.html @@ -0,0 +1,67 @@ + + + +basic_seq_packet_socket::receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Receive + some data on the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags & out_flags);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags in_flags,
+    socket_base::message_flags & out_flags);
+  » more...
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags in_flags,
+    socket_base::message_flags & out_flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload1.html new file mode 100644 index 0000000..c3fa840 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload1.html @@ -0,0 +1,105 @@ + + + +basic_seq_packet_socket::receive (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags & out_flags);
+
+

+ This function is used to receive data on the sequenced packet socket. + The function call will block until data has been received successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
out_flags
+

+ After the receive call completes, contains flags associated with + the received data. For example, if the socket_base::message_end_of_record + bit is set then the received data marks the end of a record. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.receive(asio::buffer(data, size), out_flags);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload2.html new file mode 100644 index 0000000..4e992ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload2.html @@ -0,0 +1,120 @@ + + + +basic_seq_packet_socket::receive (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags in_flags,
+    socket_base::message_flags & out_flags);
+
+

+ This function is used to receive data on the sequenced packet socket. + The function call will block until data has been received successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
in_flags
+

+ Flags specifying how the receive call is to be made. +

+
out_flags
+

+ After the receive call completes, contains flags associated with + the received data. For example, if the socket_base::message_end_of_record + bit is set then the received data marks the end of a record. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The receive operation may not receive all of the requested number of + bytes. Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.receive(asio::buffer(data, size), 0, out_flags);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload3.html new file mode 100644 index 0000000..82ba340 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive/overload3.html @@ -0,0 +1,97 @@ + + + +basic_seq_packet_socket::receive (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags in_flags,
+    socket_base::message_flags & out_flags,
+    asio::error_code & ec);
+
+

+ This function is used to receive data on the sequenced packet socket. + The function call will block until data has been received successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
in_flags
+

+ Flags specifying how the receive call is to be made. +

+
out_flags
+

+ After the receive call completes, contains flags associated with + the received data. For example, if the socket_base::message_end_of_record + bit is set then the received data marks the end of a record. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The receive operation may not receive all of the requested number of + bytes. Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive_buffer_size.html new file mode 100644 index 0000000..cf98b11 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::receive_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive buffer size of a socket. +

+
typedef implementation_defined receive_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_RCVBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive_low_watermark.html new file mode 100644 index 0000000..28e8959 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/receive_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::receive_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive low watermark. +

+
typedef implementation_defined receive_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_RCVLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release.html new file mode 100644 index 0000000..0ebed85 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native socket. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release/overload1.html new file mode 100644 index 0000000..3a68050 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release/overload1.html @@ -0,0 +1,72 @@ + + + +basic_seq_packet_socket::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release/overload2.html new file mode 100644 index 0000000..5f2ff34 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/release/overload2.html @@ -0,0 +1,73 @@ + + + +basic_seq_packet_socket::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint.html new file mode 100644 index 0000000..00594d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_seq_packet_socket::remote_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+  » more...
+
+endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint/overload1.html new file mode 100644 index 0000000..c447a64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_seq_packet_socket::remote_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint/overload2.html new file mode 100644 index 0000000..3bf034d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/remote_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_seq_packet_socket::remote_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. Returns + a default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/reuse_address.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/reuse_address.html new file mode 100644 index 0000000..c2f5e47 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/reuse_address.html @@ -0,0 +1,80 @@ + + + +basic_seq_packet_socket::reuse_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from 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. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send.html new file mode 100644 index 0000000..eef6125 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send.html @@ -0,0 +1,55 @@ + + + +basic_seq_packet_socket::send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Send + some data on the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send/overload1.html new file mode 100644 index 0000000..f23d2c3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send/overload1.html @@ -0,0 +1,102 @@ + + + +basic_seq_packet_socket::send (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+
+

+ This function is used to send data on the sequenced packet socket. The + function call will block until the data has been sent successfully, or + an until error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.send(asio::buffer(data, size), 0);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send/overload2.html new file mode 100644 index 0000000..a90033e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send/overload2.html @@ -0,0 +1,90 @@ + + + +basic_seq_packet_socket::send (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to send data on the sequenced packet socket. The + function call will block the data has been sent successfully, or an until + error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The send operation may not transmit all of the data to the peer. Consider + using the write + function if you need to ensure that all data is written before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send_buffer_size.html new file mode 100644 index 0000000..e7af67f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::send_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send buffer size of a socket. +

+
typedef implementation_defined send_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_SNDBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send_low_watermark.html new file mode 100644 index 0000000..986e395 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/send_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_seq_packet_socket::send_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send low watermark. +

+
typedef implementation_defined send_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_SNDLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option.html new file mode 100644 index 0000000..089e68a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option.html @@ -0,0 +1,53 @@ + + + +basic_seq_packet_socket::set_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+  » more...
+
+template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option/overload1.html new file mode 100644 index 0000000..25e516b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option/overload1.html @@ -0,0 +1,88 @@ + + + +basic_seq_packet_socket::set_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+socket.set_option(option);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option/overload2.html new file mode 100644 index 0000000..8b8f987 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/set_option/overload2.html @@ -0,0 +1,85 @@ + + + +basic_seq_packet_socket::set_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+asio::error_code ec;
+socket.set_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown.html new file mode 100644 index 0000000..c51151d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown.html @@ -0,0 +1,49 @@ + + + +basic_seq_packet_socket::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+  » more...
+
+void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown/overload1.html new file mode 100644 index 0000000..19865f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown/overload1.html @@ -0,0 +1,86 @@ + + + +basic_seq_packet_socket::shutdown (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.shutdown(asio::ip::tcp::socket::shutdown_send);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown/overload2.html new file mode 100644 index 0000000..de9429b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown/overload2.html @@ -0,0 +1,83 @@ + + + +basic_seq_packet_socket::shutdown (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.shutdown(asio::ip::tcp::socket::shutdown_send, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown_type.html new file mode 100644 index 0000000..53e9858 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/shutdown_type.html @@ -0,0 +1,71 @@ + + + +basic_seq_packet_socket::shutdown_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Different + ways a socket may be shutdown. +

+
enum shutdown_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
shutdown_receive
+

+ Shutdown the receive side of the socket. +

+
shutdown_send
+

+ Shutdown the send side of the socket. +

+
shutdown_both
+

+ Shutdown both send and receive on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait.html new file mode 100644 index 0000000..a6a3885 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait.html @@ -0,0 +1,50 @@ + + + +basic_seq_packet_socket::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait + for the socket to become ready to read, ready to write, or to have pending + error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait/overload1.html new file mode 100644 index 0000000..7b7d203 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait/overload1.html @@ -0,0 +1,74 @@ + + + +basic_seq_packet_socket::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.wait(asio::ip::tcp::socket::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait/overload2.html new file mode 100644 index 0000000..6a413dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait/overload2.html @@ -0,0 +1,80 @@ + + + +basic_seq_packet_socket::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.wait(asio::ip::tcp::socket::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait_type.html new file mode 100644 index 0000000..50f6c0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket/wait_type.html @@ -0,0 +1,74 @@ + + + +basic_seq_packet_socket::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a socket to become ready to read. +

+
wait_write
+

+ Wait for a socket to become ready to write. +

+
wait_error
+

+ Wait for a socket to have error conditions pending. +

+
+
+

+ For use with basic_socket::wait() and basic_socket::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket__rebind_executor.html new file mode 100644 index 0000000..7d2869b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_seq_packet_socket::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the socket type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The socket type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket__rebind_executor/other.html new file mode 100644 index 0000000..cdf5406 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_seq_packet_socket__rebind_executor/other.html @@ -0,0 +1,866 @@ + + + +basic_seq_packet_socket::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + socket type when rebound to the specified executor. +

+
typedef basic_seq_packet_socket< Protocol, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_seq_packet_socket [constructor] +

+ 		+

+ Construct a basic_seq_packet_socket without opening it.
+ —
Construct and open a basic_seq_packet_socket.
— +
Construct a basic_seq_packet_socket, opening it and binding + it to the given local endpoint.
—
Construct a basic_seq_packet_socket + on an existing native socket.
—
Move-construct a + basic_seq_packet_socket from another.
—
Move-construct + a basic_seq_packet_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_seq_packet_socket from another.
—
+ Move-assign a basic_seq_packet_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_seq_packet_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_seq_packet_socket class + template provides asynchronous and blocking sequenced packet socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single socket object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_seq_packet_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port.html new file mode 100644 index 0000000..97fe6c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port.html @@ -0,0 +1,391 @@ + + + +basic_serial_port + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides serial port functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_serial_port :
+  public serial_port_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the serial port type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_basic_serial_port is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a serial port. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native serial port to the serial port. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_serial_port [constructor] +

+ 		+

+ 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.
+ —
Move-construct a basic_serial_port from a serial port of + another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the serial port. +

+
+

+ close +

+ 		+

+ Close the serial port. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the serial port. +

+
+

+ is_open +

+ 		+

+ Determine whether the serial port is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native serial port representation. +

+
+

+ open +

+ 		+

+ Open the serial port using the specified device name. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_serial_port from another.
—
Move-assign + a basic_serial_port from a serial port of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the serial port. +

+
+

+ send_break +

+ 		+

+ Send a break sequence to the serial port. +

+
+

+ set_option +

+ 		+

+ Set an option on the serial port. +

+
+

+ write_some +

+ 		+

+ Write some data to the serial port. +

+
+

+ ~basic_serial_port [destructor] +

+ 		+

+ Destroys the serial port. +

+
+

+ The basic_serial_port + class provides a wrapper over serial port functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_serial_port.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/_basic_serial_port.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/_basic_serial_port.html new file mode 100644 index 0000000..ed4967d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/_basic_serial_port.html @@ -0,0 +1,46 @@ + + + +basic_serial_port::~basic_serial_port + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the serial port. +

+
~basic_serial_port();
+
+

+ This function destroys the serial port, cancelling any outstanding asynchronous + wait operations associated with the serial port as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign.html new file mode 100644 index 0000000..72b26bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign.html @@ -0,0 +1,49 @@ + + + +basic_serial_port::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign an + existing native serial port to the serial port. +

+
void assign(
+    const native_handle_type & native_serial_port);
+  » more...
+
+void assign(
+    const native_handle_type & native_serial_port,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign/overload1.html new file mode 100644 index 0000000..cff0246 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign/overload1.html @@ -0,0 +1,42 @@ + + + +basic_serial_port::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native serial port to the serial port. +

+
void assign(
+    const native_handle_type & native_serial_port);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign/overload2.html new file mode 100644 index 0000000..02e27c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/assign/overload2.html @@ -0,0 +1,43 @@ + + + +basic_serial_port::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native serial port to the serial port. +

+
void assign(
+    const native_handle_type & native_serial_port,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/async_read_some.html new file mode 100644 index 0000000..16f2390 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/async_read_some.html @@ -0,0 +1,144 @@ + + + +basic_serial_port::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the serial port. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
basic_serial_port.async_read_some(
+    asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/async_write_some.html new file mode 100644 index 0000000..3b42a65 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/async_write_some.html @@ -0,0 +1,144 @@ + + + +basic_serial_port::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the serial port. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the serial port. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
basic_serial_port.async_write_some(
+    asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port.html new file mode 100644 index 0000000..10e813e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port.html @@ -0,0 +1,116 @@ + + + +basic_serial_port::basic_serial_port + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_serial_port + without opening it. +

+
explicit basic_serial_port(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_serial_port(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct and open a basic_serial_port. +

+
basic_serial_port(
+    const executor_type & ex,
+    const char * device);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_serial_port(
+    ExecutionContext & context,
+    const char * device,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+basic_serial_port(
+    const executor_type & ex,
+    const std::string & device);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_serial_port(
+    ExecutionContext & context,
+    const std::string & device,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct a basic_serial_port on an existing + native serial port. +

+
basic_serial_port(
+    const executor_type & ex,
+    const native_handle_type & native_serial_port);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_serial_port(
+    ExecutionContext & context,
+    const native_handle_type & native_serial_port,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_serial_port from another. +

+
basic_serial_port(
+    basic_serial_port && other);
+  » more...
+
+

+ Move-construct a basic_serial_port from a serial + port of another executor type. +

+
template<
+    typename Executor1>
+basic_serial_port(
+    basic_serial_port< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload1.html new file mode 100644 index 0000000..ba53806 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload1.html @@ -0,0 +1,61 @@ + + + +basic_serial_port::basic_serial_port (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_serial_port without opening + it. +

+
basic_serial_port(
+    const executor_type & ex);
+
+

+ This constructor creates a serial port without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload10.html new file mode 100644 index 0000000..49a44f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload10.html @@ -0,0 +1,72 @@ + + + +basic_serial_port::basic_serial_port (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_serial_port from a serial + port of another executor type. +

+
template<
+    typename Executor1>
+basic_serial_port(
+    basic_serial_port< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a serial port from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_serial_port object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_serial_port(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload2.html new file mode 100644 index 0000000..8d06f5f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload2.html @@ -0,0 +1,64 @@ + + + +basic_serial_port::basic_serial_port (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_serial_port without opening + it. +

+
template<
+    typename ExecutionContext>
+basic_serial_port(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a serial port without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload3.html new file mode 100644 index 0000000..635ef05 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload3.html @@ -0,0 +1,66 @@ + + + +basic_serial_port::basic_serial_port (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_serial_port. +

+
basic_serial_port(
+    const executor_type & ex,
+    const char * device);
+
+

+ This constructor creates and opens a serial port for the specified device + name. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. +

+
device
+

+ The platform-specific device name for this serial port. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload4.html new file mode 100644 index 0000000..5c10ea8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload4.html @@ -0,0 +1,69 @@ + + + +basic_serial_port::basic_serial_port (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_serial_port. +

+
template<
+    typename ExecutionContext>
+basic_serial_port(
+    ExecutionContext & context,
+    const char * device,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates and opens a serial port for the specified device + name. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. +

+
device
+

+ The platform-specific device name for this serial port. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload5.html new file mode 100644 index 0000000..beaf551 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload5.html @@ -0,0 +1,66 @@ + + + +basic_serial_port::basic_serial_port (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_serial_port. +

+
basic_serial_port(
+    const executor_type & ex,
+    const std::string & device);
+
+

+ This constructor creates and opens a serial port for the specified device + name. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. +

+
device
+

+ The platform-specific device name for this serial port. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload6.html new file mode 100644 index 0000000..a1b5905 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload6.html @@ -0,0 +1,69 @@ + + + +basic_serial_port::basic_serial_port (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_serial_port. +

+
template<
+    typename ExecutionContext>
+basic_serial_port(
+    ExecutionContext & context,
+    const std::string & device,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates and opens a serial port for the specified device + name. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. +

+
device
+

+ The platform-specific device name for this serial port. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload7.html new file mode 100644 index 0000000..8701ec4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload7.html @@ -0,0 +1,80 @@ + + + +basic_serial_port::basic_serial_port (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_serial_port on an existing + native serial port. +

+
basic_serial_port(
+    const executor_type & ex,
+    const native_handle_type & native_serial_port);
+
+

+ This constructor creates a serial port object to hold an existing native + serial port. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. +

+
native_serial_port
+

+ A native serial port. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload8.html new file mode 100644 index 0000000..2b94b11 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload8.html @@ -0,0 +1,83 @@ + + + +basic_serial_port::basic_serial_port (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_serial_port on an existing + native serial port. +

+
template<
+    typename ExecutionContext>
+basic_serial_port(
+    ExecutionContext & context,
+    const native_handle_type & native_serial_port,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a serial port object to hold an existing native + serial port. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. +

+
native_serial_port
+

+ A native serial port. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload9.html new file mode 100644 index 0000000..fed5352 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/basic_serial_port/overload9.html @@ -0,0 +1,68 @@ + + + +basic_serial_port::basic_serial_port (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_serial_port from another. +

+
basic_serial_port(
+    basic_serial_port && other);
+
+

+ This constructor moves a serial port from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_serial_port object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_serial_port(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel.html new file mode 100644 index 0000000..768ca15 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel.html @@ -0,0 +1,47 @@ + + + +basic_serial_port::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel all + asynchronous operations associated with the serial port. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel/overload1.html new file mode 100644 index 0000000..b6de49f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel/overload1.html @@ -0,0 +1,59 @@ + + + +basic_serial_port::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the serial port. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel/overload2.html new file mode 100644 index 0000000..178cb97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/cancel/overload2.html @@ -0,0 +1,60 @@ + + + +basic_serial_port::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the serial port. +

+
void cancel(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close.html new file mode 100644 index 0000000..da67d9c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close.html @@ -0,0 +1,47 @@ + + + +basic_serial_port::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the serial + port. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close/overload1.html new file mode 100644 index 0000000..325e5b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close/overload1.html @@ -0,0 +1,59 @@ + + + +basic_serial_port::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the serial port. +

+
void close();
+
+

+ This function is used to close the serial port. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close/overload2.html new file mode 100644 index 0000000..9343403 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/close/overload2.html @@ -0,0 +1,60 @@ + + + +basic_serial_port::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the serial port. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the serial port. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/executor_type.html new file mode 100644 index 0000000..33bbb86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_serial_port::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_serial_port.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_executor.html new file mode 100644 index 0000000..e2a4f84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_serial_port::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option.html new file mode 100644 index 0000000..f64a6a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option.html @@ -0,0 +1,53 @@ + + + +basic_serial_port::get_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + an option from the serial port. +

+
template<
+    typename GettableSerialPortOption>
+void get_option(
+    GettableSerialPortOption & option) const;
+  » more...
+
+template<
+    typename GettableSerialPortOption>
+void get_option(
+    GettableSerialPortOption & option,
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option/overload1.html new file mode 100644 index 0000000..adb4d1d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option/overload1.html @@ -0,0 +1,74 @@ + + + +basic_serial_port::get_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an option from the serial port. +

+
template<
+    typename GettableSerialPortOption>
+void get_option(
+    GettableSerialPortOption & option) const;
+
+

+ This function is used to get the current value of an option on the serial + port. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the serial port. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option/overload2.html new file mode 100644 index 0000000..2fbae29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/get_option/overload2.html @@ -0,0 +1,66 @@ + + + +basic_serial_port::get_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an option from the serial port. +

+
template<
+    typename GettableSerialPortOption>
+void get_option(
+    GettableSerialPortOption & option,
+    asio::error_code & ec) const;
+
+

+ This function is used to get the current value of an option on the serial + port. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the serial port. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/is_open.html new file mode 100644 index 0000000..c0aabf7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/is_open.html @@ -0,0 +1,42 @@ + + + +basic_serial_port::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the serial port is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer.html new file mode 100644 index 0000000..9a1b95f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_serial_port::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer/overload1.html new file mode 100644 index 0000000..cad3767 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer/overload1.html @@ -0,0 +1,55 @@ + + + +basic_serial_port::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 basic_serial_port cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer/overload2.html new file mode 100644 index 0000000..71bcc40 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer/overload2.html @@ -0,0 +1,55 @@ + + + +basic_serial_port::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_serial_port cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer_type.html new file mode 100644 index 0000000..a45f342 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/lowest_layer_type.html @@ -0,0 +1,388 @@ + + + +basic_serial_port::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + basic_basic_serial_port is always the lowest layer. +

+
typedef basic_serial_port lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the serial port type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_basic_serial_port is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a serial port. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native serial port to the serial port. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_serial_port [constructor] +

+ 		+

+ 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.
+ —
Move-construct a basic_serial_port from a serial port + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the serial + port. +

+
+

+ close +

+ 		+

+ Close the serial port. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the serial port. +

+
+

+ is_open +

+ 		+

+ Determine whether the serial port is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native serial port representation. +

+
+

+ open +

+ 		+

+ Open the serial port using the specified device name. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_serial_port from another.
—
Move-assign + a basic_serial_port from a serial port of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the serial port. +

+
+

+ send_break +

+ 		+

+ Send a break sequence to the serial port. +

+
+

+ set_option +

+ 		+

+ Set an option on the serial port. +

+
+

+ write_some +

+ 		+

+ Write some data to the serial port. +

+
+

+ ~basic_serial_port [destructor] +

+ 		+

+ Destroys the serial port. +

+
+

+ The basic_serial_port + class provides a wrapper over serial port functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_serial_port.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/native_handle.html new file mode 100644 index 0000000..46a9624 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/native_handle.html @@ -0,0 +1,47 @@ + + + +basic_serial_port::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the native serial port representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + serial port. This is intended to allow access to native serial port functionality + that is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/native_handle_type.html new file mode 100644 index 0000000..cb0e64d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_serial_port::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a serial port. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_serial_port.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open.html new file mode 100644 index 0000000..cc8159e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open.html @@ -0,0 +1,49 @@ + + + +basic_serial_port::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the serial + port using the specified device name. +

+
void open(
+    const std::string & device);
+  » more...
+
+void open(
+    const std::string & device,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open/overload1.html new file mode 100644 index 0000000..c7c5699 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open/overload1.html @@ -0,0 +1,71 @@ + + + +basic_serial_port::open (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the serial port using the specified device name. +

+
void open(
+    const std::string & device);
+
+

+ This function opens the serial port for the specified device name. +

+
+ + Parameters +
+
+

+
+
device
+

+ The platform-specific device name. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open/overload2.html new file mode 100644 index 0000000..4d2a961 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/open/overload2.html @@ -0,0 +1,64 @@ + + + +basic_serial_port::open (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the serial port using the specified device name. +

+
void open(
+    const std::string & device,
+    asio::error_code & ec);
+
+

+ This function opens the serial port using the given platform-specific + device name. +

+
+ + Parameters +
+
+

+
+
device
+

+ The platform-specific device name. +

+
ec
+

+ Set the indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_.html new file mode 100644 index 0000000..1299ccd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_.html @@ -0,0 +1,55 @@ + + + +basic_serial_port::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_serial_port + from another. +

+
basic_serial_port & operator=(
+    basic_serial_port && other);
+  » more...
+
+

+ Move-assign a basic_serial_port from a serial + port of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_serial_port & > operator=(
+    basic_serial_port< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_/overload1.html new file mode 100644 index 0000000..86f9add --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_serial_port::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_serial_port from another. +

+
basic_serial_port & operator=(
+    basic_serial_port && other);
+
+

+ This assignment operator moves a serial port from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_serial_port object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_serial_port(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_/overload2.html new file mode 100644 index 0000000..616425e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +basic_serial_port::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_serial_port from a serial + port of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_serial_port & > operator=(
+    basic_serial_port< Executor1 > && other);
+
+

+ This assignment operator moves a serial port from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_serial_port object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_serial_port(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some.html new file mode 100644 index 0000000..b2749c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some.html @@ -0,0 +1,53 @@ + + + +basic_serial_port::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the serial port. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some/overload1.html new file mode 100644 index 0000000..cd47d53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some/overload1.html @@ -0,0 +1,108 @@ + + + +basic_serial_port::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the serial port. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to read data from the serial port. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
basic_serial_port.read_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some/overload2.html new file mode 100644 index 0000000..198a45d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/read_some/overload2.html @@ -0,0 +1,85 @@ + + + +basic_serial_port::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the serial port. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to read data from the serial port. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break.html new file mode 100644 index 0000000..3eee231 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break.html @@ -0,0 +1,47 @@ + + + +basic_serial_port::send_break + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Send + a break sequence to the serial port. +

+
void send_break();
+  » more...
+
+void send_break(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break/overload1.html new file mode 100644 index 0000000..79c4e0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break/overload1.html @@ -0,0 +1,58 @@ + + + +basic_serial_port::send_break (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send a break sequence to the serial port. +

+
void send_break();
+
+

+ This function causes a break sequence of platform-specific duration to + be sent out the serial port. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break/overload2.html new file mode 100644 index 0000000..b88c5ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/send_break/overload2.html @@ -0,0 +1,59 @@ + + + +basic_serial_port::send_break (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send a break sequence to the serial port. +

+
void send_break(
+    asio::error_code & ec);
+
+

+ This function causes a break sequence of platform-specific duration to + be sent out the serial port. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option.html new file mode 100644 index 0000000..cc62615 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option.html @@ -0,0 +1,53 @@ + + + +basic_serial_port::set_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + an option on the serial port. +

+
template<
+    typename SettableSerialPortOption>
+void set_option(
+    const SettableSerialPortOption & option);
+  » more...
+
+template<
+    typename SettableSerialPortOption>
+void set_option(
+    const SettableSerialPortOption & option,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option/overload1.html new file mode 100644 index 0000000..7987a91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option/overload1.html @@ -0,0 +1,73 @@ + + + +basic_serial_port::set_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set an option on the serial port. +

+
template<
+    typename SettableSerialPortOption>
+void set_option(
+    const SettableSerialPortOption & option);
+
+

+ This function is used to set an option on the serial port. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be set on the serial port. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option/overload2.html new file mode 100644 index 0000000..3b13b17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/set_option/overload2.html @@ -0,0 +1,65 @@ + + + +basic_serial_port::set_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set an option on the serial port. +

+
template<
+    typename SettableSerialPortOption>
+void set_option(
+    const SettableSerialPortOption & option,
+    asio::error_code & ec);
+
+

+ This function is used to set an option on the serial port. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be set on the serial port. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some.html new file mode 100644 index 0000000..674ff24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some.html @@ -0,0 +1,53 @@ + + + +basic_serial_port::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the serial port. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some/overload1.html new file mode 100644 index 0000000..6d4b155 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some/overload1.html @@ -0,0 +1,107 @@ + + + +basic_serial_port::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the serial port. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write data to the serial port. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the serial port. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
basic_serial_port.write_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some/overload2.html new file mode 100644 index 0000000..df3add4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port/write_some/overload2.html @@ -0,0 +1,84 @@ + + + +basic_serial_port::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the serial port. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write data to the serial port. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the serial port. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port__rebind_executor.html new file mode 100644 index 0000000..240d696 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_serial_port::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the serial port type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The serial port type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_serial_port.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port__rebind_executor/other.html new file mode 100644 index 0000000..27da0ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_serial_port__rebind_executor/other.html @@ -0,0 +1,388 @@ + + + +basic_serial_port::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + serial port type when rebound to the specified executor. +

+
typedef basic_serial_port< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the serial port type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_basic_serial_port is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a serial port. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native serial port to the serial port. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_serial_port [constructor] +

+ 		+

+ 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.
+ —
Move-construct a basic_serial_port from a serial port + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the serial + port. +

+
+

+ close +

+ 		+

+ Close the serial port. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the serial port. +

+
+

+ is_open +

+ 		+

+ Determine whether the serial port is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native serial port representation. +

+
+

+ open +

+ 		+

+ Open the serial port using the specified device name. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_serial_port from another.
—
Move-assign + a basic_serial_port from a serial port of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the serial port. +

+
+

+ send_break +

+ 		+

+ Send a break sequence to the serial port. +

+
+

+ set_option +

+ 		+

+ Set an option on the serial port. +

+
+

+ write_some +

+ 		+

+ Write some data to the serial port. +

+
+

+ ~basic_serial_port [destructor] +

+ 		+

+ Destroys the serial port. +

+
+

+ The basic_serial_port + class provides a wrapper over serial port functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_serial_port.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set.html new file mode 100644 index 0000000..0f10932 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set.html @@ -0,0 +1,337 @@ + + + +basic_signal_set + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides signal functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_signal_set :
+  public signal_set_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the signal set type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ Enumeration representing the different types of flags that may + specified when adding a signal to a set. +

+
+

+ flags_t +

+ 		+

+ Portability typedef. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ add +

+ 		+

+ Add a signal to a signal_set.
—
Add a signal to a signal_set + with the specified flags. +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous operation to wait for a signal to be delivered. +

+
+

+ basic_signal_set [constructor] +

+ 		+

+ 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. +

+
+

+ cancel +

+ 		+

+ Cancel all operations associated with the signal set. +

+
+

+ clear +

+ 		+

+ Remove all signals from a signal_set. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ remove +

+ 		+

+ Remove a signal from a signal_set. +

+
+

+ ~basic_signal_set [destructor] +

+ 		+

+ Destroys the signal set. +

+
+

+ The basic_signal_set + class provides the ability to perform an asynchronous wait for one or more + signals to occur. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Example +
+

+ Performing an asynchronous wait: +

+
void handler(
+    const asio::error_code& error,
+    int signal_number)
+{
+  if (!error)
+  {
+    // A signal occurred.
+  }
+}
+
+...
+
+// Construct a signal set registered for process termination.
+asio::signal_set signals(my_context, SIGINT, SIGTERM);
+
+// Start an asynchronous wait for one of the signals to occur.
+signals.async_wait(handler);
+
+
+ + Queueing + of signal notifications +
+

+ 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. +

+
+ + 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(). +

+
+ + 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. +

+
+ + Requirements +
+

+ Header: asio/basic_signal_set.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/_basic_signal_set.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/_basic_signal_set.html new file mode 100644 index 0000000..fb20995 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/_basic_signal_set.html @@ -0,0 +1,46 @@ + + + +basic_signal_set::~basic_signal_set + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the signal set. +

+
~basic_signal_set();
+
+

+ This function destroys the signal set, cancelling any outstanding asynchronous + wait operations associated with the signal set as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add.html new file mode 100644 index 0000000..4f70f47 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add.html @@ -0,0 +1,63 @@ + + + +basic_signal_set::add + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Add a signal to a + signal_set. +

+
void add(
+    int signal_number);
+  » more...
+
+void add(
+    int signal_number,
+    asio::error_code & ec);
+  » more...
+
+

+ Add a signal to a signal_set with the specified flags. +

+
void add(
+    int signal_number,
+    flags_t f);
+  » more...
+
+void add(
+    int signal_number,
+    flags_t f,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload1.html new file mode 100644 index 0000000..7b322c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload1.html @@ -0,0 +1,72 @@ + + + +basic_signal_set::add (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add a signal to a signal_set. +

+
void add(
+    int signal_number);
+
+

+ This function adds the specified signal to the set. It has no effect + if the signal is already in the set. +

+
+ + Parameters +
+
+

+
+
signal_number
+

+ The signal to be added to the set. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload2.html new file mode 100644 index 0000000..2218a7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload2.html @@ -0,0 +1,64 @@ + + + +basic_signal_set::add (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add a signal to a signal_set. +

+
void add(
+    int signal_number,
+    asio::error_code & ec);
+
+

+ This function adds the specified signal to the set. It has no effect + if the signal is already in the set. +

+
+ + Parameters +
+
+

+
+
signal_number
+

+ The signal to be added to the set. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload3.html new file mode 100644 index 0000000..f2e8a34 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload3.html @@ -0,0 +1,87 @@ + + + +basic_signal_set::add (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add a signal to a signal_set with the specified flags. +

+
void add(
+    int signal_number,
+    flags_t f);
+
+

+ This function adds the specified signal to the set. It has no effect + if the signal is already in the set. +

+

+ Flags other than flags::dont_care + require OS support for the sigaction + call, and this function will fail with error::operation_not_supported + if this is unavailable. +

+

+ The specified flags will conflict with a prior, active registration of + the same signal, if either specified a flags value other than flags::dont_care. In this case, the add will fail with error::invalid_argument. +

+
+ + Parameters +
+
+

+
+
signal_number
+

+ The signal to be added to the set. +

+
f
+

+ Flags to modify the behaviour of the specified signal. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload4.html new file mode 100644 index 0000000..8187ede --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/add/overload4.html @@ -0,0 +1,79 @@ + + + +basic_signal_set::add (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add a signal to a signal_set with the specified flags. +

+
void add(
+    int signal_number,
+    flags_t f,
+    asio::error_code & ec);
+
+

+ This function adds the specified signal to the set. It has no effect + if the signal is already in the set. +

+

+ Flags other than flags::dont_care + require OS support for the sigaction + call, and this function will fail with error::operation_not_supported + if this is unavailable. +

+

+ The specified flags will conflict with a prior, active registration of + the same signal, if either specified a flags value other than flags::dont_care. In this case, the add will fail with error::invalid_argument. +

+
+ + Parameters +
+
+

+
+
signal_number
+

+ The signal to be added to the set. +

+
f
+

+ Flags to modify the behaviour of the specified signal. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/async_wait.html new file mode 100644 index 0000000..3abae0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/async_wait.html @@ -0,0 +1,134 @@ + + + +basic_signal_set::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous operation to wait for a signal to be delivered. +

+
template<
+    typename SignalToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    SignalToken && token = default_completion_token_t< executor_type >());
+
+

+ This function may be used to initiate an asynchronous wait against the + signal set. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ For each call to async_wait(), the completion handler will be called + exactly once. The completion handler will be called when: +

+
    +
  • + One of the registered signals in the signal set occurs; or +
    • +
  • + The signal set was cancelled, in which case the handler is passed the + error code asio::error::operation_aborted. +
    • +
+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  int signal_number // Indicates which signal occurred.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, int)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+ + Remarks +
+

+ Unlike the POSIX function signal, + async_wait executes its + completion handler as specified in the asynchronous + operation requirements. This means it places no async-signal safety + restrictions on what work can be performed in a completion handler. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set.html new file mode 100644 index 0000000..c7cedfd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set.html @@ -0,0 +1,105 @@ + + + +basic_signal_set::basic_signal_set + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a signal set without adding any signals. +

+
explicit basic_signal_set(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_signal_set(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a signal set and add one signal. +

+
basic_signal_set(
+    const executor_type & ex,
+    int signal_number_1);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_signal_set(
+    ExecutionContext & context,
+    int signal_number_1,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a signal set and add two signals. +

+
basic_signal_set(
+    const executor_type & ex,
+    int signal_number_1,
+    int signal_number_2);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_signal_set(
+    ExecutionContext & context,
+    int signal_number_1,
+    int signal_number_2,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a signal set and add three signals. +

+
basic_signal_set(
+    const executor_type & ex,
+    int signal_number_1,
+    int signal_number_2,
+    int signal_number_3);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_signal_set(
+    ExecutionContext & context,
+    int signal_number_1,
+    int signal_number_2,
+    int signal_number_3,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload1.html new file mode 100644 index 0000000..d9431c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload1.html @@ -0,0 +1,60 @@ + + + +basic_signal_set::basic_signal_set (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set without adding any signals. +

+
basic_signal_set(
+    const executor_type & ex);
+
+

+ This constructor creates a signal set without registering for any signals. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the signal set will use, by default, to dispatch + handlers for any asynchronous operations performed on the signal + set. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload2.html new file mode 100644 index 0000000..b378d7b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload2.html @@ -0,0 +1,63 @@ + + + +basic_signal_set::basic_signal_set (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set without adding any signals. +

+
template<
+    typename ExecutionContext>
+basic_signal_set(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a signal set without registering for any signals. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the signal + set will use, by default, to dispatch handlers for any asynchronous + operations performed on the signal set. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload3.html new file mode 100644 index 0000000..4b78d6d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload3.html @@ -0,0 +1,75 @@ + + + +basic_signal_set::basic_signal_set (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set and add one signal. +

+
basic_signal_set(
+    const executor_type & ex,
+    int signal_number_1);
+
+

+ This constructor creates a signal set and registers for one signal. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the signal set will use, by default, to dispatch + handlers for any asynchronous operations performed on the signal + set. +

+
signal_number_1
+

+ The signal number to be added. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to performing: +

+
asio::signal_set signals(ex);
+signals.add(signal_number_1);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload4.html new file mode 100644 index 0000000..f4f4353 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload4.html @@ -0,0 +1,78 @@ + + + +basic_signal_set::basic_signal_set (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set and add one signal. +

+
template<
+    typename ExecutionContext>
+basic_signal_set(
+    ExecutionContext & context,
+    int signal_number_1,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a signal set and registers for one signal. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the signal + set will use, by default, to dispatch handlers for any asynchronous + operations performed on the signal set. +

+
signal_number_1
+

+ The signal number to be added. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to performing: +

+
asio::signal_set signals(context);
+signals.add(signal_number_1);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload5.html new file mode 100644 index 0000000..84fc2ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload5.html @@ -0,0 +1,81 @@ + + + +basic_signal_set::basic_signal_set (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set and add two signals. +

+
basic_signal_set(
+    const executor_type & ex,
+    int signal_number_1,
+    int signal_number_2);
+
+

+ This constructor creates a signal set and registers for two signals. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the signal set will use, by default, to dispatch + handlers for any asynchronous operations performed on the signal + set. +

+
signal_number_1
+

+ The first signal number to be added. +

+
signal_number_2
+

+ The second signal number to be added. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to performing: +

+
asio::signal_set signals(ex);
+signals.add(signal_number_1);
+signals.add(signal_number_2);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload6.html new file mode 100644 index 0000000..f856179 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload6.html @@ -0,0 +1,84 @@ + + + +basic_signal_set::basic_signal_set (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set and add two signals. +

+
template<
+    typename ExecutionContext>
+basic_signal_set(
+    ExecutionContext & context,
+    int signal_number_1,
+    int signal_number_2,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a signal set and registers for two signals. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the signal + set will use, by default, to dispatch handlers for any asynchronous + operations performed on the signal set. +

+
signal_number_1
+

+ The first signal number to be added. +

+
signal_number_2
+

+ The second signal number to be added. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to performing: +

+
asio::signal_set signals(context);
+signals.add(signal_number_1);
+signals.add(signal_number_2);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload7.html new file mode 100644 index 0000000..400de03 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload7.html @@ -0,0 +1,87 @@ + + + +basic_signal_set::basic_signal_set (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set and add three signals. +

+
basic_signal_set(
+    const executor_type & ex,
+    int signal_number_1,
+    int signal_number_2,
+    int signal_number_3);
+
+

+ This constructor creates a signal set and registers for three signals. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the signal set will use, by default, to dispatch + handlers for any asynchronous operations performed on the signal + set. +

+
signal_number_1
+

+ The first signal number to be added. +

+
signal_number_2
+

+ The second signal number to be added. +

+
signal_number_3
+

+ The third signal number to be added. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to performing: +

+
asio::signal_set signals(ex);
+signals.add(signal_number_1);
+signals.add(signal_number_2);
+signals.add(signal_number_3);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload8.html new file mode 100644 index 0000000..f902f82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/basic_signal_set/overload8.html @@ -0,0 +1,90 @@ + + + +basic_signal_set::basic_signal_set (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a signal set and add three signals. +

+
template<
+    typename ExecutionContext>
+basic_signal_set(
+    ExecutionContext & context,
+    int signal_number_1,
+    int signal_number_2,
+    int signal_number_3,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a signal set and registers for three signals. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the signal + set will use, by default, to dispatch handlers for any asynchronous + operations performed on the signal set. +

+
signal_number_1
+

+ The first signal number to be added. +

+
signal_number_2
+

+ The second signal number to be added. +

+
signal_number_3
+

+ The third signal number to be added. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to performing: +

+
asio::signal_set signals(context);
+signals.add(signal_number_1);
+signals.add(signal_number_2);
+signals.add(signal_number_3);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel.html new file mode 100644 index 0000000..3832b92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel.html @@ -0,0 +1,47 @@ + + + +basic_signal_set::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel all + operations associated with the signal set. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel/overload1.html new file mode 100644 index 0000000..067303a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel/overload1.html @@ -0,0 +1,83 @@ + + + +basic_signal_set::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all operations associated with the signal set. +

+
void cancel();
+
+

+ This function forces the completion of any pending asynchronous wait + operations against the signal set. The handler for each cancelled operation + will be invoked with the asio::error::operation_aborted + error code. +

+

+ Cancellation does not alter the set of registered signals. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ If a registered signal occurred before 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel/overload2.html new file mode 100644 index 0000000..745be7d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/cancel/overload2.html @@ -0,0 +1,84 @@ + + + +basic_signal_set::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all operations associated with the signal set. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function forces the completion of any pending asynchronous wait + operations against the signal set. The handler for each cancelled operation + will be invoked with the asio::error::operation_aborted + error code. +

+

+ Cancellation does not alter the set of registered signals. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ If a registered signal occurred before 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear.html new file mode 100644 index 0000000..4020b2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear.html @@ -0,0 +1,47 @@ + + + +basic_signal_set::clear + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Remove all signals + from a signal_set. +

+
void clear();
+  » more...
+
+void clear(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear/overload1.html new file mode 100644 index 0000000..36b68ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear/overload1.html @@ -0,0 +1,65 @@ + + + +basic_signal_set::clear (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Remove all signals from a signal_set. +

+
void clear();
+
+

+ This function removes all signals from the set. It has no effect if the + set is already empty. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Removes all queued notifications. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear/overload2.html new file mode 100644 index 0000000..b7f5bad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/clear/overload2.html @@ -0,0 +1,66 @@ + + + +basic_signal_set::clear (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Remove all signals from a signal_set. +

+
void clear(
+    asio::error_code & ec);
+
+

+ This function removes all signals from the set. It has no effect if the + set is already empty. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Removes all queued notifications. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/executor_type.html new file mode 100644 index 0000000..97b5f9a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_signal_set::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_signal_set.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/flags.html new file mode 100644 index 0000000..5e08790 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/flags.html @@ -0,0 +1,88 @@ + + + +basic_signal_set::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from signal_set_base. +

+

+ +Enumeration representing + the different types of flags that may specified when adding a signal to + a set. +

+
enum flags
+
+

+ + + + + +

+
+ + Values +
+
+

+
+
none
+

+ Bitmask representing no flags. +

+
restart
+

+ Affects the behaviour of interruptible functions such that, if the + function would have failed with error::interrupted when interrupted + by the specified signal, the function shall instead be restarted + and not fail with error::interrupted. +

+
no_child_stop
+

+ Do not generate SIGCHLD when child processes stop or stopped child + processes continue. +

+
no_child_wait
+

+ Do not transform child processes into zombies when they terminate. +

+
dont_care
+

+ Special value to indicate that the signal registration does not care + which flags are set, and so will not conflict with any prior registrations + of the same signal. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/flags_t.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/flags_t.html new file mode 100644 index 0000000..2b6a490 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/flags_t.html @@ -0,0 +1,55 @@ + + + +basic_signal_set::flags_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from signal_set_base. +

+

+ +Portability + typedef. +

+
typedef flags flags_t;
+
+
+ + Requirements +
+

+ Header: asio/basic_signal_set.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/get_executor.html new file mode 100644 index 0000000..aceb378 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_signal_set::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove.html new file mode 100644 index 0000000..9d0e895 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove.html @@ -0,0 +1,49 @@ + + + +basic_signal_set::remove + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Remove a signal + from a signal_set. +

+
void remove(
+    int signal_number);
+  » more...
+
+void remove(
+    int signal_number,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove/overload1.html new file mode 100644 index 0000000..a670a6d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove/overload1.html @@ -0,0 +1,80 @@ + + + +basic_signal_set::remove (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Remove a signal from a signal_set. +

+
void remove(
+    int signal_number);
+
+

+ This function removes the specified signal from the set. It has no effect + if the signal is not in the set. +

+
+ + Parameters +
+
+

+
+
signal_number
+

+ The signal to be removed from the set. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Removes any notifications that have been queued for the specified signal + number. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove/overload2.html new file mode 100644 index 0000000..107a37c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set/remove/overload2.html @@ -0,0 +1,72 @@ + + + +basic_signal_set::remove (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Remove a signal from a signal_set. +

+
void remove(
+    int signal_number,
+    asio::error_code & ec);
+
+

+ This function removes the specified signal from the set. It has no effect + if the signal is not in the set. +

+
+ + Parameters +
+
+

+
+
signal_number
+

+ The signal to be removed from the set. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Removes any notifications that have been queued for the specified signal + number. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set__rebind_executor.html new file mode 100644 index 0000000..7d0961f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_signal_set::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the signal set type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The signal set type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_signal_set.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set__rebind_executor/other.html new file mode 100644 index 0000000..b0c6243 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_signal_set__rebind_executor/other.html @@ -0,0 +1,333 @@ + + + +basic_signal_set::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + signal set type when rebound to the specified executor. +

+
typedef basic_signal_set< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the signal set type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ Enumeration representing the different types of flags that may + specified when adding a signal to a set. +

+
+

+ flags_t +

+ 		+

+ Portability typedef. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ add +

+ 		+

+ Add a signal to a signal_set.
—
Add a signal to a + signal_set with the specified flags. +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous operation to wait for a signal to be delivered. +

+
+

+ basic_signal_set [constructor] +

+ 		+

+ 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. +

+
+

+ cancel +

+ 		+

+ Cancel all operations associated with the signal set. +

+
+

+ clear +

+ 		+

+ Remove all signals from a signal_set. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ remove +

+ 		+

+ Remove a signal from a signal_set. +

+
+

+ ~basic_signal_set [destructor] +

+ 		+

+ Destroys the signal set. +

+
+

+ The basic_signal_set + class provides the ability to perform an asynchronous wait for one or more + signals to occur. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Example +
+

+ Performing an asynchronous wait: +

+
void handler(
+    const asio::error_code& error,
+    int signal_number)
+{
+  if (!error)
+  {
+    // A signal occurred.
+  }
+}
+
+...
+
+// Construct a signal set registered for process termination.
+asio::signal_set signals(my_context, SIGINT, SIGTERM);
+
+// Start an asynchronous wait for one of the signals to occur.
+signals.async_wait(handler);
+
+
+ + Queueing + of signal notifications +
+

+ 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. +

+
+ + 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(). +

+
+ + 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. +

+
+ + Requirements +
+

+ Header: asio/basic_signal_set.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket.html new file mode 100644 index 0000000..c82af7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket.html @@ -0,0 +1,833 @@ + + + +basic_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides socket functionality. +

+
template<
+    typename Protocol,
+    typename Executor>
+class basic_socket :
+  public socket_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close if + unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_socket [constructor] +

+ 		+

+ Construct a basic_socket without opening it.
—
Construct + and open a basic_socket.
—
Construct a basic_socket, + opening it and binding it to the given local endpoint.
— +
Construct a basic_socket on an existing native socket. +
—
Move-construct a basic_socket from another.
+ —
Move-construct a basic_socket from a socket of another protocol + type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets the + non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket from another.
—
Move-assign + a basic_socket from a socket of another protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, or + to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_socket [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/_basic_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/_basic_socket.html new file mode 100644 index 0000000..7b996de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/_basic_socket.html @@ -0,0 +1,46 @@ + + + +basic_socket::~basic_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~basic_socket();
+
+

+ This function destroys the socket, cancelling any outstanding asynchronous + operations associated with the socket as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign.html new file mode 100644 index 0000000..9b0905f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign.html @@ -0,0 +1,51 @@ + + + +basic_socket::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign an existing + native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign/overload1.html new file mode 100644 index 0000000..1b9cfc6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign/overload1.html @@ -0,0 +1,43 @@ + + + +basic_socket::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign/overload2.html new file mode 100644 index 0000000..533b0ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/assign/overload2.html @@ -0,0 +1,44 @@ + + + +basic_socket::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/async_connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/async_connect.html new file mode 100644 index 0000000..344edce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/async_connect.html @@ -0,0 +1,139 @@ + + + +basic_socket::async_connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous connect. +

+
template<
+    typename ConnectToken = default_completion_token_t<executor_type>>
+DEDUCED async_connect(
+    const endpoint_type & peer_endpoint,
+    ConnectToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously connect a socket to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ The socket is automatically opened if it is not already open. If the connect + fails, and the socket was automatically opened, the socket is not returned + to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. Copies + will be made of the endpoint object as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void connect_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Connect succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.async_connect(endpoint, connect_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/async_wait.html new file mode 100644 index 0000000..7b1ed6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/async_wait.html @@ -0,0 +1,134 @@ + + + +basic_socket::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for a socket to enter + a ready to read, write or error condition state. It is an initiating function + for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+...
+socket.async_wait(asio::ip::tcp::socket::wait_read, wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark.html new file mode 100644 index 0000000..4405b3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark.html @@ -0,0 +1,47 @@ + + + +basic_socket::at_mark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether + the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+  » more...
+
+bool at_mark(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark/overload1.html new file mode 100644 index 0000000..cfce441 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark/overload1.html @@ -0,0 +1,66 @@ + + + +basic_socket::at_mark (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark/overload2.html new file mode 100644 index 0000000..de2a859 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/at_mark/overload2.html @@ -0,0 +1,67 @@ + + + +basic_socket::at_mark (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark(
+    asio::error_code & ec) const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available.html new file mode 100644 index 0000000..bd4a394 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available.html @@ -0,0 +1,47 @@ + + + +basic_socket::available + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine the + number of bytes available for reading. +

+
std::size_t available() const;
+  » more...
+
+std::size_t available(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available/overload1.html new file mode 100644 index 0000000..8fb6887 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available/overload1.html @@ -0,0 +1,67 @@ + + + +basic_socket::available (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the number of bytes available for reading. +

+
std::size_t available() const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available/overload2.html new file mode 100644 index 0000000..cf7b161 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/available/overload2.html @@ -0,0 +1,68 @@ + + + +basic_socket::available (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the number of bytes available for reading. +

+
std::size_t available(
+    asio::error_code & ec) const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket.html new file mode 100644 index 0000000..61882e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket.html @@ -0,0 +1,123 @@ + + + +basic_socket::basic_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_socket + without opening it. +

+
explicit basic_socket(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct and open a basic_socket. +

+
basic_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_socket, + opening it and binding it to the given local endpoint. +

+
basic_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct a basic_socket + on an existing native socket. +

+
basic_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_socket from another. +

+
basic_socket(
+    basic_socket && other);
+  » more...
+
+

+ Move-construct a basic_socket from a socket of + another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_socket(
+    basic_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload1.html new file mode 100644 index 0000000..5f1453f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload1.html @@ -0,0 +1,60 @@ + + + +basic_socket::basic_socket (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket without opening + it. +

+
basic_socket(
+    const executor_type & ex);
+
+

+ This constructor creates a socket without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload10.html new file mode 100644 index 0000000..454014a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload10.html @@ -0,0 +1,73 @@ + + + +basic_socket::basic_socket (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_socket from a socket of + another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_socket(
+    basic_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload2.html new file mode 100644 index 0000000..0f4ab56 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload2.html @@ -0,0 +1,64 @@ + + + +basic_socket::basic_socket (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket without opening + it. +

+
template<
+    typename ExecutionContext>
+basic_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a socket without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload3.html new file mode 100644 index 0000000..5a19f0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload3.html @@ -0,0 +1,77 @@ + + + +basic_socket::basic_socket (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_socket. +

+
basic_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+
+

+ This constructor creates and opens a socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload4.html new file mode 100644 index 0000000..eee457e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload4.html @@ -0,0 +1,81 @@ + + + +basic_socket::basic_socket (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_socket. +

+
template<
+    typename ExecutionContext>
+basic_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates and opens a socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload5.html new file mode 100644 index 0000000..70ae43d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload5.html @@ -0,0 +1,80 @@ + + + +basic_socket::basic_socket (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket, opening it and + binding it to the given local endpoint. +

+
basic_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+
+

+ This constructor creates a socket and automatically opens it bound to + the specified endpoint on the local machine. The protocol used is the + protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload6.html new file mode 100644 index 0000000..7b3567c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload6.html @@ -0,0 +1,84 @@ + + + +basic_socket::basic_socket (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket, opening it and + binding it to the given local endpoint. +

+
template<
+    typename ExecutionContext>
+basic_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a socket and automatically opens it bound to + the specified endpoint on the local machine. The protocol used is the + protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload7.html new file mode 100644 index 0000000..63ea522 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload7.html @@ -0,0 +1,83 @@ + + + +basic_socket::basic_socket (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket on an existing + native socket. +

+
basic_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+

+ This constructor creates a socket object to hold an existing native socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ A native socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload8.html new file mode 100644 index 0000000..a10f82e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload8.html @@ -0,0 +1,87 @@ + + + +basic_socket::basic_socket (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket on an existing + native socket. +

+
template<
+    typename ExecutionContext>
+basic_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a socket object to hold an existing native socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ A native socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload9.html new file mode 100644 index 0000000..871c8d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/basic_socket/overload9.html @@ -0,0 +1,68 @@ + + + +basic_socket::basic_socket (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_socket from another. +

+
basic_socket(
+    basic_socket && other);
+
+

+ This constructor moves a socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind.html new file mode 100644 index 0000000..a03ba80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind.html @@ -0,0 +1,49 @@ + + + +basic_socket::bind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bind the socket to the + given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+  » more...
+
+void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind/overload1.html new file mode 100644 index 0000000..8bf75aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind/overload1.html @@ -0,0 +1,81 @@ + + + +basic_socket::bind (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind/overload2.html new file mode 100644 index 0000000..a7bd4d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bind/overload2.html @@ -0,0 +1,78 @@ + + + +basic_socket::bind (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+asio::error_code ec;
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/broadcast.html new file mode 100644 index 0000000..13811fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/broadcast.html @@ -0,0 +1,79 @@ + + + +basic_socket::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket option + to permit sending of broadcast messages. +

+
typedef implementation_defined broadcast;
+
+

+ Implements the SOL_SOCKET/SO_BROADCAST socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bytes_readable.html new file mode 100644 index 0000000..4cbd7b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/bytes_readable.html @@ -0,0 +1,68 @@ + + + +basic_socket::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +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. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::bytes_readable command(true);
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel.html new file mode 100644 index 0000000..8b6eb2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel.html @@ -0,0 +1,47 @@ + + + +basic_socket::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel all asynchronous + operations associated with the socket. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel/overload1.html new file mode 100644 index 0000000..14330b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel/overload1.html @@ -0,0 +1,102 @@ + + + +basic_socket::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel/overload2.html new file mode 100644 index 0000000..69fcba6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/cancel/overload2.html @@ -0,0 +1,103 @@ + + + +basic_socket::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close.html new file mode 100644 index 0000000..56bcfab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close.html @@ -0,0 +1,46 @@ + + + +basic_socket::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the socket. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close/overload1.html new file mode 100644 index 0000000..6b876fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close/overload1.html @@ -0,0 +1,68 @@ + + + +basic_socket::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the socket. +

+
void close();
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close/overload2.html new file mode 100644 index 0000000..87875c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/close/overload2.html @@ -0,0 +1,82 @@ + + + +basic_socket::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the socket. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect.html new file mode 100644 index 0000000..3e2e3c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect.html @@ -0,0 +1,49 @@ + + + +basic_socket::connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Connect the socket + to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+  » more...
+
+void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect/overload1.html new file mode 100644 index 0000000..5d68c66 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect/overload1.html @@ -0,0 +1,87 @@ + + + +basic_socket::connect (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.connect(endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect/overload2.html new file mode 100644 index 0000000..af36a69 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/connect/overload2.html @@ -0,0 +1,84 @@ + + + +basic_socket::connect (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+asio::error_code ec;
+socket.connect(endpoint, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/debug.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/debug.html new file mode 100644 index 0000000..1015c74 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/debug.html @@ -0,0 +1,79 @@ + + + +basic_socket::debug + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket option to enable + socket-level debugging. +

+
typedef implementation_defined debug;
+
+

+ Implements the SOL_SOCKET/SO_DEBUG socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/do_not_route.html new file mode 100644 index 0000000..c495391 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/do_not_route.html @@ -0,0 +1,79 @@ + + + +basic_socket::do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to prevent routing, use local interfaces only. +

+
typedef implementation_defined do_not_route;
+
+

+ Implements the SOL_SOCKET/SO_DONTROUTE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/enable_connection_aborted.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/enable_connection_aborted.html new file mode 100644 index 0000000..31d82c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/enable_connection_aborted.html @@ -0,0 +1,81 @@ + + + +basic_socket::enable_connection_aborted + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to report aborted connections on accept. +

+
typedef implementation_defined enable_connection_aborted;
+
+

+ Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with asio::error::connection_aborted. + By default the option is false. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/endpoint_type.html new file mode 100644 index 0000000..12b1261 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_socket::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The endpoint + type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/executor_type.html new file mode 100644 index 0000000..1881177 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_socket::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_executor.html new file mode 100644 index 0000000..257128f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_socket::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option.html new file mode 100644 index 0000000..44f5fbc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option.html @@ -0,0 +1,53 @@ + + + +basic_socket::get_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get an option + from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+  » more...
+
+template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option/overload1.html new file mode 100644 index 0000000..cd52ad4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option/overload1.html @@ -0,0 +1,86 @@ + + + +basic_socket::get_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option/overload2.html new file mode 100644 index 0000000..64945a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/get_option/overload2.html @@ -0,0 +1,83 @@ + + + +basic_socket::get_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+asio::error_code ec;
+socket.get_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control.html new file mode 100644 index 0000000..f320eef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control.html @@ -0,0 +1,53 @@ + + + +basic_socket::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform an + IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control/overload1.html new file mode 100644 index 0000000..1710401 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control/overload1.html @@ -0,0 +1,86 @@ + + + +basic_socket::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control/overload2.html new file mode 100644 index 0000000..ddccd50 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/io_control/overload2.html @@ -0,0 +1,83 @@ + + + +basic_socket::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+asio::error_code ec;
+socket.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/is_open.html new file mode 100644 index 0000000..1e02e4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/is_open.html @@ -0,0 +1,42 @@ + + + +basic_socket::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether + the socket is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/keep_alive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/keep_alive.html new file mode 100644 index 0000000..ad541e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/keep_alive.html @@ -0,0 +1,79 @@ + + + +basic_socket::keep_alive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket option + to send keep-alives. +

+
typedef implementation_defined keep_alive;
+
+

+ Implements the SOL_SOCKET/SO_KEEPALIVE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/linger.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/linger.html new file mode 100644 index 0000000..3f221ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/linger.html @@ -0,0 +1,80 @@ + + + +basic_socket::linger + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket option to specify + whether the socket lingers on close if unsent data is present. +

+
typedef implementation_defined linger;
+
+

+ Implements the SOL_SOCKET/SO_LINGER socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option(true, 30);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option;
+socket.get_option(option);
+bool is_set = option.enabled();
+unsigned short timeout = option.timeout();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint.html new file mode 100644 index 0000000..6437dd4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_socket::local_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+  » more...
+
+endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint/overload1.html new file mode 100644 index 0000000..a733555 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint/overload1.html @@ -0,0 +1,73 @@ + + + +basic_socket::local_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint/overload2.html new file mode 100644 index 0000000..68e8a7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/local_endpoint/overload2.html @@ -0,0 +1,80 @@ + + + +basic_socket::local_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. Returns a + default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer.html new file mode 100644 index 0000000..6d9552d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_socket::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a reference + to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer/overload1.html new file mode 100644 index 0000000..a12a51b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer/overload1.html @@ -0,0 +1,55 @@ + + + +basic_socket::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 basic_socket + cannot contain any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer/overload2.html new file mode 100644 index 0000000..e201780 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer/overload2.html @@ -0,0 +1,55 @@ + + + +basic_socket::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_socket cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer_type.html new file mode 100644 index 0000000..2bf6aa0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/lowest_layer_type.html @@ -0,0 +1,831 @@ + + + +basic_socket::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + basic_socket + is always the lowest layer. +

+
typedef basic_socket< Protocol, Executor > lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_socket [constructor] +

+ 		+

+ Construct a basic_socket without opening it.
—
Construct + and open a basic_socket.
—
Construct a basic_socket, + opening it and binding it to the given local endpoint.
+ —
Construct a basic_socket on an existing native socket. +
—
Move-construct a basic_socket from another.
+ —
Move-construct a basic_socket from a socket of another + protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket from another.
—
Move-assign + a basic_socket from a socket of another protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_socket [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/max_listen_connections.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/max_listen_connections.html new file mode 100644 index 0000000..53843b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/max_listen_connections.html @@ -0,0 +1,45 @@ + + + +basic_socket::max_listen_connections + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +The + maximum length of the queue of pending incoming connections. +

+
static const int max_listen_connections = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_do_not_route.html new file mode 100644 index 0000000..b1d6f58 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_do_not_route.html @@ -0,0 +1,45 @@ + + + +basic_socket::message_do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specify + that the data should not be subject to routing. +

+
static const int message_do_not_route = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_end_of_record.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_end_of_record.html new file mode 100644 index 0000000..73881ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_end_of_record.html @@ -0,0 +1,45 @@ + + + +basic_socket::message_end_of_record + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specifies + that the data marks the end of a record. +

+
static const int message_end_of_record = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_flags.html new file mode 100644 index 0000000..5f9501e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_flags.html @@ -0,0 +1,55 @@ + + + +basic_socket::message_flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Bitmask + type for flags that can be passed to send and receive operations. +

+
typedef int message_flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_out_of_band.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_out_of_band.html new file mode 100644 index 0000000..18eb088 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_out_of_band.html @@ -0,0 +1,45 @@ + + + +basic_socket::message_out_of_band + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Process + out-of-band data. +

+
static const int message_out_of_band = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_peek.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_peek.html new file mode 100644 index 0000000..af7742b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/message_peek.html @@ -0,0 +1,45 @@ + + + +basic_socket::message_peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Peek at + incoming data without removing it from the input queue. +

+
static const int message_peek = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_handle.html new file mode 100644 index 0000000..62bd33c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_handle.html @@ -0,0 +1,47 @@ + + + +basic_socket::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + native socket representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + socket. This is intended to allow access to native socket functionality + that is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_handle_type.html new file mode 100644 index 0000000..fcc8603 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_socket::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a socket. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking.html new file mode 100644 index 0000000..0da87c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_socket::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload1.html new file mode 100644 index 0000000..09cf75f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload1.html @@ -0,0 +1,141 @@ + + + +basic_socket::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Gets the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+
+

+ This function is used to retrieve the non-blocking mode of the underlying + native socket. This mode has no effect on the behaviour of the socket + object's synchronous operations. +

+
+ + Return + Value +
+

+ true if the underlying socket + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + Remarks +
+

+ The current non-blocking mode is cached by the socket object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native socket. +

+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload2.html new file mode 100644 index 0000000..4bfcfe2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload2.html @@ -0,0 +1,156 @@ + + + +basic_socket::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload3.html new file mode 100644 index 0000000..5d17a1d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/native_non_blocking/overload3.html @@ -0,0 +1,147 @@ + + + +basic_socket::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking.html new file mode 100644 index 0000000..9564380 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_socket::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets the + non-blocking mode of the socket. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload1.html new file mode 100644 index 0000000..088efa7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload1.html @@ -0,0 +1,61 @@ + + + +basic_socket::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Gets the non-blocking mode of the socket. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the socket's synchronous + operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload2.html new file mode 100644 index 0000000..ed3d43f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload2.html @@ -0,0 +1,80 @@ + + + +basic_socket::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload3.html new file mode 100644 index 0000000..119182b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/non_blocking/overload3.html @@ -0,0 +1,72 @@ + + + +basic_socket::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open.html new file mode 100644 index 0000000..c503925 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open.html @@ -0,0 +1,49 @@ + + + +basic_socket::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the socket using the + specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+  » more...
+
+void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open/overload1.html new file mode 100644 index 0000000..9161325 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open/overload1.html @@ -0,0 +1,78 @@ + + + +basic_socket::open (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open/overload2.html new file mode 100644 index 0000000..5891c8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/open/overload2.html @@ -0,0 +1,75 @@ + + + +basic_socket::open (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying which protocol is to be used. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::error_code ec;
+socket.open(asio::ip::tcp::v4(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_.html new file mode 100644 index 0000000..3c777a6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_.html @@ -0,0 +1,56 @@ + + + +basic_socket::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_socket + from another. +

+
basic_socket & operator=(
+    basic_socket && other);
+  » more...
+
+

+ Move-assign a basic_socket from a socket of + another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_socket & > operator=(
+    basic_socket< Protocol1, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_/overload1.html new file mode 100644 index 0000000..cbd4952 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_socket::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_socket from another. +

+
basic_socket & operator=(
+    basic_socket && other);
+
+

+ This assignment operator moves a socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_/overload2.html new file mode 100644 index 0000000..68770cc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +basic_socket::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_socket from a socket of + another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_socket & > operator=(
+    basic_socket< Protocol1, Executor1 > && other);
+
+

+ This assignment operator moves a socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/out_of_band_inline.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/out_of_band_inline.html new file mode 100644 index 0000000..87bf670 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/out_of_band_inline.html @@ -0,0 +1,79 @@ + + + +basic_socket::out_of_band_inline + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for putting received out-of-band data inline. +

+
typedef implementation_defined out_of_band_inline;
+
+

+ Implements the SOL_SOCKET/SO_OOBINLINE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option;
+socket.get_option(option);
+bool value = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/protocol_type.html new file mode 100644 index 0000000..578783c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_socket::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The protocol + type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/receive_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/receive_buffer_size.html new file mode 100644 index 0000000..ad049ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/receive_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_socket::receive_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive buffer size of a socket. +

+
typedef implementation_defined receive_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_RCVBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/receive_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/receive_low_watermark.html new file mode 100644 index 0000000..e996ee4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/receive_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_socket::receive_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive low watermark. +

+
typedef implementation_defined receive_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_RCVLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release.html new file mode 100644 index 0000000..fd3ae82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release.html @@ -0,0 +1,47 @@ + + + +basic_socket::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release ownership + of the underlying native socket. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release/overload1.html new file mode 100644 index 0000000..0c0943f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release/overload1.html @@ -0,0 +1,69 @@ + + + +basic_socket::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native socket. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release/overload2.html new file mode 100644 index 0000000..51858ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/release/overload2.html @@ -0,0 +1,70 @@ + + + +basic_socket::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native socket. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint.html new file mode 100644 index 0000000..5f3b888 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_socket::remote_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+  » more...
+
+endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint/overload1.html new file mode 100644 index 0000000..cce5544 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint/overload1.html @@ -0,0 +1,73 @@ + + + +basic_socket::remote_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint/overload2.html new file mode 100644 index 0000000..c00e279 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/remote_endpoint/overload2.html @@ -0,0 +1,80 @@ + + + +basic_socket::remote_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. Returns + a default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/reuse_address.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/reuse_address.html new file mode 100644 index 0000000..0670660 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/reuse_address.html @@ -0,0 +1,80 @@ + + + +basic_socket::reuse_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from 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. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/send_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/send_buffer_size.html new file mode 100644 index 0000000..512d282 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/send_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_socket::send_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send buffer size of a socket. +

+
typedef implementation_defined send_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_SNDBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/send_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/send_low_watermark.html new file mode 100644 index 0000000..4cd4828 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/send_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_socket::send_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send low watermark. +

+
typedef implementation_defined send_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_SNDLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option.html new file mode 100644 index 0000000..9dffe71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option.html @@ -0,0 +1,53 @@ + + + +basic_socket::set_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set an option + on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+  » more...
+
+template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option/overload1.html new file mode 100644 index 0000000..ea125b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option/overload1.html @@ -0,0 +1,85 @@ + + + +basic_socket::set_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+socket.set_option(option);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option/overload2.html new file mode 100644 index 0000000..7bb565d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/set_option/overload2.html @@ -0,0 +1,82 @@ + + + +basic_socket::set_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+asio::error_code ec;
+socket.set_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown.html new file mode 100644 index 0000000..6e8fa65 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown.html @@ -0,0 +1,49 @@ + + + +basic_socket::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable sends or + receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+  » more...
+
+void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown/overload1.html new file mode 100644 index 0000000..b990986 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown/overload1.html @@ -0,0 +1,83 @@ + + + +basic_socket::shutdown (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.shutdown(asio::ip::tcp::socket::shutdown_send);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown/overload2.html new file mode 100644 index 0000000..8836d1a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown/overload2.html @@ -0,0 +1,80 @@ + + + +basic_socket::shutdown (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.shutdown(asio::ip::tcp::socket::shutdown_send, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown_type.html new file mode 100644 index 0000000..978079b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/shutdown_type.html @@ -0,0 +1,71 @@ + + + +basic_socket::shutdown_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Different + ways a socket may be shutdown. +

+
enum shutdown_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
shutdown_receive
+

+ Shutdown the receive side of the socket. +

+
shutdown_send
+

+ Shutdown the send side of the socket. +

+
shutdown_both
+

+ Shutdown both send and receive on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait.html new file mode 100644 index 0000000..7395034 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait.html @@ -0,0 +1,49 @@ + + + +basic_socket::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait for the socket to + become ready to read, ready to write, or to have pending error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait/overload1.html new file mode 100644 index 0000000..2ad8340 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait/overload1.html @@ -0,0 +1,71 @@ + + + +basic_socket::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.wait(asio::ip::tcp::socket::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait/overload2.html new file mode 100644 index 0000000..1a8727b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait/overload2.html @@ -0,0 +1,77 @@ + + + +basic_socket::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.wait(asio::ip::tcp::socket::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait_type.html new file mode 100644 index 0000000..7c8674b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket/wait_type.html @@ -0,0 +1,73 @@ + + + +basic_socket::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Wait types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a socket to become ready to read. +

+
wait_write
+

+ Wait for a socket to become ready to write. +

+
wait_error
+

+ Wait for a socket to have error conditions pending. +

+
+
+

+ For use with basic_socket::wait() and basic_socket::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket__rebind_executor.html new file mode 100644 index 0000000..82a7d91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_socket::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the socket type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The socket type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket__rebind_executor/other.html new file mode 100644 index 0000000..a3ccf33 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket__rebind_executor/other.html @@ -0,0 +1,830 @@ + + + +basic_socket::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + socket type when rebound to the specified executor. +

+
typedef basic_socket< Protocol, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_socket [constructor] +

+ 		+

+ Construct a basic_socket without opening it.
—
Construct + and open a basic_socket.
—
Construct a basic_socket, + opening it and binding it to the given local endpoint.
+ —
Construct a basic_socket on an existing native socket. +
—
Move-construct a basic_socket from another.
+ —
Move-construct a basic_socket from a socket of another + protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket from another.
—
Move-assign + a basic_socket from a socket of another protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_socket [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor.html new file mode 100644 index 0000000..c18add1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor.html @@ -0,0 +1,773 @@ + + + +basic_socket_acceptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides the ability to accept new connections. +

+
template<
+    typename Protocol,
+    typename Executor>
+class basic_socket_acceptor :
+  public socket_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the acceptor type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close if + unsent data is present. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of an acceptor. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ accept +

+ 		+

+ Accept a new connection.
—
Accept a new connection + and obtain the endpoint of the peer. +

+
+

+ assign +

+ 		+

+ Assigns an existing native acceptor to the acceptor. +

+
+

+ async_accept +

+ 		+

+ Start an asynchronous accept. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the acceptor to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ basic_socket_acceptor [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_socket_acceptor from an acceptor of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the acceptor to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the acceptor. +

+
+

+ close +

+ 		+

+ Close the acceptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the acceptor. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the acceptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the acceptor is open. +

+
+

+ listen +

+ 		+

+ Place the acceptor into the state where it will listen for new + connections. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the acceptor. +

+
+

+ native_handle +

+ 		+

+ Get the native acceptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native acceptor implementation. +
—
Sets the non-blocking mode of the native acceptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the acceptor.
—
Sets + the non-blocking mode of the acceptor. +

+
+

+ open +

+ 		+

+ Open the acceptor using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_acceptor from another.
—
+ Move-assign a basic_socket_acceptor from an acceptor of another + protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native acceptor. +

+
+

+ set_option +

+ 		+

+ Set an option on the acceptor. +

+
+

+ wait +

+ 		+

+ Wait for the acceptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_socket_acceptor [destructor] +

+ 		+

+ Destroys the acceptor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket_acceptor + class template is used for accepting new socket connections. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous accept operations + are thread safe, if the underlying operating system calls are also thread + safe. This means that it is permitted to perform concurrent calls to synchronous + accept operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Example +
+

+ Opening a socket acceptor with the SO_REUSEADDR option enabled: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::ip::tcp::endpoint endpoint(asio::ip::tcp::v4(), port);
+acceptor.open(endpoint.protocol());
+acceptor.set_option(asio::ip::tcp::acceptor::reuse_address(true));
+acceptor.bind(endpoint);
+acceptor.listen();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/_basic_socket_acceptor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/_basic_socket_acceptor.html new file mode 100644 index 0000000..df1407b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/_basic_socket_acceptor.html @@ -0,0 +1,46 @@ + + + +basic_socket_acceptor::~basic_socket_acceptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the acceptor. +

+
~basic_socket_acceptor();
+
+

+ This function destroys the acceptor, cancelling any outstanding asynchronous + operations associated with the acceptor as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept.html new file mode 100644 index 0000000..598ca76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept.html @@ -0,0 +1,155 @@ + + + +basic_socket_acceptor::accept + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Accept + a new connection. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+void accept(
+    basic_socket< Protocol1, Executor1 > & peer,
+    constraint_t< is_convertible< Protocol, Protocol1 >::value >  = 0);
+  » more...
+
+template<
+    typename Protocol1,
+    typename Executor1>
+void accept(
+    basic_socket< Protocol1, Executor1 > & peer,
+    asio::error_code & ec,
+    constraint_t< is_convertible< Protocol, Protocol1 >::value >  = 0);
+  » more...
+
+

+ Accept a new connection and obtain the endpoint of the peer. +

+
template<
+    typename Executor1>
+void accept(
+    basic_socket< protocol_type, Executor1 > & peer,
+    endpoint_type & peer_endpoint);
+  » more...
+
+template<
+    typename Executor1>
+void accept(
+    basic_socket< protocol_type, Executor1 > & peer,
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+  » more...
+
+Protocol::socket::template rebind_executor< executor_type >::other accept();
+  » more...
+
+Protocol::socket::template rebind_executor< executor_type >::other accept(
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const Executor1 & ex,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const Executor1 & ex,
+    asio::error_code & ec,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    asio::error_code & ec,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+Protocol::socket::template rebind_executor< executor_type >::other accept(
+    endpoint_type & peer_endpoint);
+  » more...
+
+Protocol::socket::template rebind_executor< executor_type >::other accept(
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const Executor1 & ex,
+    endpoint_type & peer_endpoint,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    endpoint_type & peer_endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const executor_type & ex,
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload1.html new file mode 100644 index 0000000..12d7136 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload1.html @@ -0,0 +1,86 @@ + + + +basic_socket_acceptor::accept (1 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+void accept(
+    basic_socket< Protocol1, Executor1 > & peer,
+    constraint_t< is_convertible< Protocol, Protocol1 >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer into the + given socket. The function call will block until a new connection has + been accepted successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
peer
+

+ The socket into which the new connection will be accepted. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(my_context);
+acceptor.accept(socket);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload10.html new file mode 100644 index 0000000..e709027 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload10.html @@ -0,0 +1,94 @@ + + + +basic_socket_acceptor::accept (10 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    asio::error_code & ec,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
context
+

+ The I/O execution context object to be used for the newly accepted + socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ On success, a socket object representing the newly accepted connection. + On error, a socket object where is_open() is false. +

+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(acceptor.accept(my_context2, ec));
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload11.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload11.html new file mode 100644 index 0000000..5726102 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload11.html @@ -0,0 +1,95 @@ + + + +basic_socket_acceptor::accept (11 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
Protocol::socket::template rebind_executor< executor_type >::other accept(
+    endpoint_type & peer_endpoint);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. +

+
+
+
+ + Return + Value +
+

+ A socket object representing the newly accepted connection. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+asio::ip::tcp::socket socket(acceptor.accept(endpoint));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload12.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload12.html new file mode 100644 index 0000000..9922d40 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload12.html @@ -0,0 +1,92 @@ + + + +basic_socket_acceptor::accept (12 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
Protocol::socket::template rebind_executor< executor_type >::other accept(
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ On success, a socket object representing the newly accepted connection. + On error, a socket object where is_open() is false. +

+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+asio::ip::tcp::socket socket(acceptor.accept(endpoint, ec));
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload13.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload13.html new file mode 100644 index 0000000..b4b5994 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload13.html @@ -0,0 +1,104 @@ + + + +basic_socket_acceptor::accept (13 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const Executor1 & ex,
+    endpoint_type & peer_endpoint,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor object to be used for the newly accepted socket. +

+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. +

+
+
+
+ + Return + Value +
+

+ A socket object representing the newly accepted connection. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+asio::ip::tcp::socket socket(
+    acceptor.accept(my_context2, endpoint));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload14.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload14.html new file mode 100644 index 0000000..5f9e883 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload14.html @@ -0,0 +1,105 @@ + + + +basic_socket_acceptor::accept (14 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    endpoint_type & peer_endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
context
+

+ The I/O execution context object to be used for the newly accepted + socket. +

+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. +

+
+
+
+ + Return + Value +
+

+ A socket object representing the newly accepted connection. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+asio::ip::tcp::socket socket(
+    acceptor.accept(my_context2, endpoint));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload15.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload15.html new file mode 100644 index 0000000..8f90053 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload15.html @@ -0,0 +1,101 @@ + + + +basic_socket_acceptor::accept (15 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const executor_type & ex,
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor object to be used for the newly accepted socket. +

+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ On success, a socket object representing the newly accepted connection. + On error, a socket object where is_open() is false. +

+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+asio::ip::tcp::socket socket(
+    acceptor.accept(my_context2, endpoint, ec));
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload16.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload16.html new file mode 100644 index 0000000..315d8e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload16.html @@ -0,0 +1,102 @@ + + + +basic_socket_acceptor::accept (16 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
context
+

+ The I/O execution context object to be used for the newly accepted + socket. +

+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ On success, a socket object representing the newly accepted connection. + On error, a socket object where is_open() is false. +

+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+asio::ip::tcp::socket socket(
+    acceptor.accept(my_context2, endpoint, ec));
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload2.html new file mode 100644 index 0000000..5f9f4f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload2.html @@ -0,0 +1,83 @@ + + + +basic_socket_acceptor::accept (2 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+void accept(
+    basic_socket< Protocol1, Executor1 > & peer,
+    asio::error_code & ec,
+    constraint_t< is_convertible< Protocol, Protocol1 >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer into the + given socket. The function call will block until a new connection has + been accepted successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
peer
+

+ The socket into which the new connection will be accepted. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(my_context);
+asio::error_code ec;
+acceptor.accept(socket, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload3.html new file mode 100644 index 0000000..c7a1699 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload3.html @@ -0,0 +1,92 @@ + + + +basic_socket_acceptor::accept (3 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection and obtain the endpoint of the peer. +

+
template<
+    typename Executor1>
+void accept(
+    basic_socket< protocol_type, Executor1 > & peer,
+    endpoint_type & peer_endpoint);
+
+

+ This function is used to accept a new connection from a peer into the + given socket, and additionally provide the endpoint of the remote peer. + The function call will block until a new connection has been accepted + successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
peer
+

+ The socket into which the new connection will be accepted. +

+
peer_endpoint
+

+ An endpoint object which will receive the endpoint of the remote + peer. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint;
+acceptor.accept(socket, endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload4.html new file mode 100644 index 0000000..3e4ec55 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload4.html @@ -0,0 +1,89 @@ + + + +basic_socket_acceptor::accept (4 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection and obtain the endpoint of the peer. +

+
template<
+    typename Executor1>
+void accept(
+    basic_socket< protocol_type, Executor1 > & peer,
+    endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+
+

+ This function is used to accept a new connection from a peer into the + given socket, and additionally provide the endpoint of the remote peer. + The function call will block until a new connection has been accepted + successfully or an error occurs. +

+
+ + Parameters +
+
+

+
+
peer
+

+ The socket into which the new connection will be accepted. +

+
peer_endpoint
+

+ An endpoint object which will receive the endpoint of the remote + peer. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint;
+asio::error_code ec;
+acceptor.accept(socket, endpoint, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload5.html new file mode 100644 index 0000000..0e1adcf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload5.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::accept (5 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
Protocol::socket::template rebind_executor< executor_type >::other accept();
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Return + Value +
+

+ A socket object representing the newly accepted connection. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(acceptor.accept());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload6.html new file mode 100644 index 0000000..b0b851f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload6.html @@ -0,0 +1,85 @@ + + + +basic_socket_acceptor::accept (6 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
Protocol::socket::template rebind_executor< executor_type >::other accept(
+    asio::error_code & ec);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ On success, a socket object representing the newly accepted connection. + On error, a socket object where is_open() is false. +

+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(acceptor.accept(ec));
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload7.html new file mode 100644 index 0000000..d95afd8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload7.html @@ -0,0 +1,96 @@ + + + +basic_socket_acceptor::accept (7 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const Executor1 & ex,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor object to be used for the newly accepted socket. +

+
+
+
+ + Return + Value +
+

+ A socket object representing the newly accepted connection. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(acceptor.accept());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload8.html new file mode 100644 index 0000000..fc72b9f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload8.html @@ -0,0 +1,97 @@ + + + +basic_socket_acceptor::accept (8 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename ExecutionContext>
+Protocol::socket::template rebind_executor< typenameExecutionContext::executor_type >::other accept(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
context
+

+ The I/O execution context object to be used for the newly accepted + socket. +

+
+
+
+ + Return + Value +
+

+ A socket object representing the newly accepted connection. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(acceptor.accept());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload9.html new file mode 100644 index 0000000..2a9bcf4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/accept/overload9.html @@ -0,0 +1,93 @@ + + + +basic_socket_acceptor::accept (9 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Accept a new connection. +

+
template<
+    typename Executor1>
+Protocol::socket::template rebind_executor< Executor1 >::other accept(
+    const Executor1 & ex,
+    asio::error_code & ec,
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+
+

+ This function is used to accept a new connection from a peer. The function + call will block until a new connection has been accepted successfully + or an error occurs. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor object to be used for the newly accepted socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ On success, a socket object representing the newly accepted connection. + On error, a socket object where is_open() is false. +

+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(acceptor.accept(my_context2, ec));
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign.html new file mode 100644 index 0000000..c327982 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign.html @@ -0,0 +1,51 @@ + + + +basic_socket_acceptor::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assigns + an existing native acceptor to the acceptor. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor);
+  » more...
+
+void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign/overload1.html new file mode 100644 index 0000000..e607d85 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign/overload1.html @@ -0,0 +1,43 @@ + + + +basic_socket_acceptor::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assigns an existing native acceptor to the acceptor. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign/overload2.html new file mode 100644 index 0000000..3c73173 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/assign/overload2.html @@ -0,0 +1,44 @@ + + + +basic_socket_acceptor::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assigns an existing native acceptor to the acceptor. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept.html new file mode 100644 index 0000000..bfb02e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept.html @@ -0,0 +1,110 @@ + + + +basic_socket_acceptor::async_accept + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous accept. +

+
template<
+    typename Protocol1,
+    typename Executor1,
+    typename AcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    basic_socket< Protocol1, Executor1 > & peer,
+    AcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_convertible< Protocol, Protocol1 >::value >  = 0);
+  » more...
+
+template<
+    typename Executor1,
+    typename AcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    basic_socket< protocol_type, Executor1 > & peer,
+    endpoint_type & peer_endpoint,
+    AcceptToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    MoveAcceptToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename Executor1,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    const Executor1 & ex,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    ExecutionContext & context,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+template<
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    endpoint_type & peer_endpoint,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename Executor1,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    const Executor1 & ex,
+    endpoint_type & peer_endpoint,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    ExecutionContext & context,
+    endpoint_type & peer_endpoint,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload1.html new file mode 100644 index 0000000..4ff4ac8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload1.html @@ -0,0 +1,136 @@ + + + +basic_socket_acceptor::async_accept (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename Protocol1,
+    typename Executor1,
+    typename AcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    basic_socket< Protocol1, Executor1 > & peer,
+    AcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_convertible< Protocol, Protocol1 >::value >  = 0);
+
+

+ This function is used to asynchronously accept a new connection into + a socket, and additionally obtain the endpoint of the remote peer. It + is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
peer
+

+ The socket into which the new connection will be accepted. Ownership + of the peer object is retained by the caller, which must guarantee + that it is valid until the completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void accept_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Accept succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::socket socket(my_context);
+acceptor.async_accept(socket, accept_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload2.html new file mode 100644 index 0000000..daf8c79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload2.html @@ -0,0 +1,123 @@ + + + +basic_socket_acceptor::async_accept (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename Executor1,
+    typename AcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    basic_socket< protocol_type, Executor1 > & peer,
+    endpoint_type & peer_endpoint,
+    AcceptToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously accept a new connection into + a socket, and additionally obtain the endpoint of the remote peer. It + is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
peer
+

+ The socket into which the new connection will be accepted. Ownership + of the peer object is retained by the caller, which must guarantee + that it is valid until the completion handler is called. +

+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. Ownership of the peer_endpoint object is retained by + the caller, which must guarantee that it is valid until the handler + is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload3.html new file mode 100644 index 0000000..83e731f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload3.html @@ -0,0 +1,136 @@ + + + +basic_socket_acceptor::async_accept (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    MoveAcceptToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously accept a new connection. It is + an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // On success, the newly accepted socket.
+  typename Protocol::socket::template
+    rebind_executor<executor_type>::other peer
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code,
+  typename Protocol::socket::template
+    rebind_executor<executor_type>::other))
+
+
+ + Example +
+
void accept_handler(const asio::error_code& error,
+    asio::ip::tcp::socket peer)
+{
+  if (!error)
+  {
+    // Accept succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+acceptor.async_accept(accept_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload4.html new file mode 100644 index 0000000..ffc275a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload4.html @@ -0,0 +1,143 @@ + + + +basic_socket_acceptor::async_accept (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename Executor1,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    const Executor1 & ex,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+
+

+ This function is used to asynchronously accept a new connection. It is + an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor object to be used for the newly accepted socket. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // On success, the newly accepted socket.
+  typename Protocol::socket::template rebind_executor<
+    Executor1>::other peer
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code,
+  typename Protocol::socket::template rebind_executor<
+    Executor1>::other))
+
+
+ + Example +
+
void accept_handler(const asio::error_code& error,
+    asio::ip::tcp::socket peer)
+{
+  if (!error)
+  {
+    // Accept succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+acceptor.async_accept(my_context2, accept_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload5.html new file mode 100644 index 0000000..c9e4118 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload5.html @@ -0,0 +1,144 @@ + + + +basic_socket_acceptor::async_accept (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename ExecutionContext,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    ExecutionContext & context,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to asynchronously accept a new connection. It is + an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
context
+

+ The I/O execution context object to be used for the newly accepted + socket. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // On success, the newly accepted socket.
+  typename Protocol::socket::template rebind_executor<
+    typename ExecutionContext::executor_type>::other peer
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code,
+  typename Protocol::socket::template rebind_executor<
+    typename ExecutionContext::executor_type>::other))
+
+
+ + Example +
+
void accept_handler(const asio::error_code& error,
+    asio::ip::tcp::socket peer)
+{
+  if (!error)
+  {
+    // Accept succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+acceptor.async_accept(my_context2, accept_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload6.html new file mode 100644 index 0000000..20d8869 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload6.html @@ -0,0 +1,145 @@ + + + +basic_socket_acceptor::async_accept (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    endpoint_type & peer_endpoint,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously accept a new connection. It is + an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. Ownership of the peer_endpoint object is retained by + the caller, which must guarantee that it is valid until the completion + handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // On success, the newly accepted socket.
+  typename Protocol::socket::template
+    rebind_executor<executor_type>::other peer
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code,
+  typename Protocol::socket::template
+    rebind_executor<executor_type>::other))
+
+
+ + Example +
+
void accept_handler(const asio::error_code& error,
+    asio::ip::tcp::socket peer)
+{
+  if (!error)
+  {
+    // Accept succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+acceptor.async_accept(endpoint, accept_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload7.html new file mode 100644 index 0000000..9f81a52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload7.html @@ -0,0 +1,152 @@ + + + +basic_socket_acceptor::async_accept (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename Executor1,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    const Executor1 & ex,
+    endpoint_type & peer_endpoint,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_executor< Executor1 >::value||execution::is_executor< Executor1 >::value >  = 0);
+
+

+ This function is used to asynchronously accept a new connection. It is + an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor object to be used for the newly accepted socket. +

+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. Ownership of the peer_endpoint object is retained by + the caller, which must guarantee that it is valid until the completion + handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // On success, the newly accepted socket.
+  typename Protocol::socket::template rebind_executor<
+    Executor1>::other peer
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code,
+  typename Protocol::socket::template rebind_executor<
+    Executor1>::other))
+
+
+ + Example +
+
void accept_handler(const asio::error_code& error,
+    asio::ip::tcp::socket peer)
+{
+  if (!error)
+  {
+    // Accept succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+acceptor.async_accept(my_context2, endpoint, accept_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload8.html new file mode 100644 index 0000000..616ad1d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_accept/overload8.html @@ -0,0 +1,153 @@ + + + +basic_socket_acceptor::async_accept (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous accept. +

+
template<
+    typename ExecutionContext,
+    typename MoveAcceptToken = default_completion_token_t<executor_type>>
+DEDUCED async_accept(
+    ExecutionContext & context,
+    endpoint_type & peer_endpoint,
+    MoveAcceptToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to asynchronously accept a new connection. It is + an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ This overload requires that the Protocol template parameter satisfy the + AcceptableProtocol type requirements. +

+
+ + Parameters +
+
+

+
+
context
+

+ The I/O execution context object to be used for the newly accepted + socket. +

+
peer_endpoint
+

+ An endpoint object into which the endpoint of the remote peer will + be written. Ownership of the peer_endpoint object is retained by + the caller, which must guarantee that it is valid until the completion + handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the accept completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  // Result of operation.
+  const asio::error_code& error,
+
+  // On success, the newly accepted socket.
+  typename Protocol::socket::template rebind_executor<
+    typename ExecutionContext::executor_type>::other peer
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code,
+  typename Protocol::socket::template rebind_executor<
+    typename ExecutionContext::executor_type>::other))
+
+
+ + Example +
+
void accept_handler(const asio::error_code& error,
+    asio::ip::tcp::socket peer)
+{
+  if (!error)
+  {
+    // Accept succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint;
+acceptor.async_accept(my_context2, endpoint, accept_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_wait.html new file mode 100644 index 0000000..89f5ff1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/async_wait.html @@ -0,0 +1,136 @@ + + + +basic_socket_acceptor::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + wait for the acceptor to become ready to read, ready to write, or to have + pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for an acceptor to + enter a ready to read, write or error condition state. It is an initiating + function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired acceptor state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::acceptor acceptor(my_context);
+...
+acceptor.async_wait(
+    asio::ip::tcp::acceptor::wait_read,
+    wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor.html new file mode 100644 index 0000000..e890369 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor.html @@ -0,0 +1,123 @@ + + + +basic_socket_acceptor::basic_socket_acceptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an acceptor without opening it. +

+
explicit basic_socket_acceptor(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_socket_acceptor(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct an open acceptor. +

+
basic_socket_acceptor(
+    const executor_type & ex,
+    const protocol_type & protocol);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_socket_acceptor(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct an acceptor opened on the given endpoint. +

+
basic_socket_acceptor(
+    const executor_type & ex,
+    const endpoint_type & endpoint,
+    bool reuse_addr = true);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_socket_acceptor(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    bool reuse_addr = true,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct a basic_socket_acceptor on an existing + native acceptor. +

+
basic_socket_acceptor(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_socket_acceptor(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_socket_acceptor from another. +

+
basic_socket_acceptor(
+    basic_socket_acceptor && other);
+  » more...
+
+

+ Move-construct a basic_socket_acceptor from an + acceptor of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_socket_acceptor(
+    basic_socket_acceptor< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload1.html new file mode 100644 index 0000000..181801d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload1.html @@ -0,0 +1,61 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an acceptor without opening it. +

+
basic_socket_acceptor(
+    const executor_type & ex);
+
+

+ This constructor creates an acceptor without opening it to listen for + new connections. The open() function must be called before the + acceptor can accept new socket connections. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the acceptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the acceptor. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload10.html new file mode 100644 index 0000000..4b09572 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload10.html @@ -0,0 +1,73 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_socket_acceptor from an + acceptor of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_socket_acceptor(
+    basic_socket_acceptor< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves an acceptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket_acceptor + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket_acceptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload2.html new file mode 100644 index 0000000..e2534d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload2.html @@ -0,0 +1,65 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an acceptor without opening it. +

+
template<
+    typename ExecutionContext>
+basic_socket_acceptor(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates an acceptor without opening it to listen for + new connections. The open() function must be called before the + acceptor can accept new socket connections. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the acceptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the acceptor. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload3.html new file mode 100644 index 0000000..531d1fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload3.html @@ -0,0 +1,77 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an open acceptor. +

+
basic_socket_acceptor(
+    const executor_type & ex,
+    const protocol_type & protocol);
+
+

+ This constructor creates an acceptor and automatically opens it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the acceptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the acceptor. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload4.html new file mode 100644 index 0000000..8dd7a2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload4.html @@ -0,0 +1,81 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an open acceptor. +

+
template<
+    typename ExecutionContext>
+basic_socket_acceptor(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates an acceptor and automatically opens it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the acceptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the acceptor. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload5.html new file mode 100644 index 0000000..3905429 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload5.html @@ -0,0 +1,98 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an acceptor opened on the given endpoint. +

+
basic_socket_acceptor(
+    const executor_type & ex,
+    const endpoint_type & endpoint,
+    bool reuse_addr = true);
+
+

+ This constructor creates an acceptor and automatically opens it to listen + for new connections on the specified endpoint. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the acceptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the acceptor. +

+
endpoint
+

+ An endpoint on the local machine on which the acceptor will listen + for new connections. +

+
reuse_addr
+

+ Whether the constructor should set the socket option socket_base::reuse_address. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to the following code: +

+
basic_socket_acceptor<Protocol> acceptor(my_context);
+acceptor.open(endpoint.protocol());
+if (reuse_addr)
+  acceptor.set_option(socket_base::reuse_address(true));
+acceptor.bind(endpoint);
+acceptor.listen();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload6.html new file mode 100644 index 0000000..b242809 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload6.html @@ -0,0 +1,102 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an acceptor opened on the given endpoint. +

+
template<
+    typename ExecutionContext>
+basic_socket_acceptor(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    bool reuse_addr = true,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates an acceptor and automatically opens it to listen + for new connections on the specified endpoint. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the acceptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the acceptor. +

+
endpoint
+

+ An endpoint on the local machine on which the acceptor will listen + for new connections. +

+
reuse_addr
+

+ Whether the constructor should set the socket option socket_base::reuse_address. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This constructor is equivalent to the following code: +

+
basic_socket_acceptor<Protocol> acceptor(my_context);
+acceptor.open(endpoint.protocol());
+if (reuse_addr)
+  acceptor.set_option(socket_base::reuse_address(true));
+acceptor.bind(endpoint);
+acceptor.listen();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload7.html new file mode 100644 index 0000000..99ee161 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload7.html @@ -0,0 +1,84 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket_acceptor on an + existing native acceptor. +

+
basic_socket_acceptor(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor);
+
+

+ This constructor creates an acceptor object to hold an existing native + acceptor. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the acceptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the acceptor. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_acceptor
+

+ A native acceptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload8.html new file mode 100644 index 0000000..d8f2d02 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload8.html @@ -0,0 +1,88 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket_acceptor on an + existing native acceptor. +

+
template<
+    typename ExecutionContext>
+basic_socket_acceptor(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_acceptor,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates an acceptor object to hold an existing native + acceptor. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the acceptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the acceptor. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_acceptor
+

+ A native acceptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload9.html new file mode 100644 index 0000000..17c065a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/basic_socket_acceptor/overload9.html @@ -0,0 +1,68 @@ + + + +basic_socket_acceptor::basic_socket_acceptor (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_socket_acceptor from another. +

+
basic_socket_acceptor(
+    basic_socket_acceptor && other);
+
+

+ This constructor moves an acceptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket_acceptor + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket_acceptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind.html new file mode 100644 index 0000000..3d3d152 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind.html @@ -0,0 +1,49 @@ + + + +basic_socket_acceptor::bind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bind + the acceptor to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+  » more...
+
+void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind/overload1.html new file mode 100644 index 0000000..7ffc0dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind/overload1.html @@ -0,0 +1,82 @@ + + + +basic_socket_acceptor::bind (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Bind the acceptor to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+
+

+ This function binds the socket acceptor to the specified endpoint on + the local machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket acceptor will + be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::ip::tcp::endpoint endpoint(asio::ip::tcp::v4(), 12345);
+acceptor.open(endpoint.protocol());
+acceptor.bind(endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind/overload2.html new file mode 100644 index 0000000..d4f312f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bind/overload2.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::bind (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Bind the acceptor to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+
+

+ This function binds the socket acceptor to the specified endpoint on + the local machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket acceptor will + be bound. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::ip::tcp::endpoint endpoint(asio::ip::tcp::v4(), 12345);
+acceptor.open(endpoint.protocol());
+asio::error_code ec;
+acceptor.bind(endpoint, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/broadcast.html new file mode 100644 index 0000000..4ee74bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/broadcast.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to permit sending of broadcast messages. +

+
typedef implementation_defined broadcast;
+
+

+ Implements the SOL_SOCKET/SO_BROADCAST socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bytes_readable.html new file mode 100644 index 0000000..04fe214 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/bytes_readable.html @@ -0,0 +1,68 @@ + + + +basic_socket_acceptor::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +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. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::bytes_readable command(true);
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel.html new file mode 100644 index 0000000..474eb55 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel.html @@ -0,0 +1,47 @@ + + + +basic_socket_acceptor::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the acceptor. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel/overload1.html new file mode 100644 index 0000000..4a458f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel/overload1.html @@ -0,0 +1,60 @@ + + + +basic_socket_acceptor::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the acceptor. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel/overload2.html new file mode 100644 index 0000000..9942a6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/cancel/overload2.html @@ -0,0 +1,61 @@ + + + +basic_socket_acceptor::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the acceptor. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close.html new file mode 100644 index 0000000..3aafcdc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close.html @@ -0,0 +1,47 @@ + + + +basic_socket_acceptor::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the acceptor. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close/overload1.html new file mode 100644 index 0000000..7f7e9a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close/overload1.html @@ -0,0 +1,62 @@ + + + +basic_socket_acceptor::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the acceptor. +

+
void close();
+
+

+ This function is used to close the acceptor. Any asynchronous accept + operations will be cancelled immediately. +

+

+ A subsequent call to open() is required before the acceptor can + again be used to again perform socket accept operations. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close/overload2.html new file mode 100644 index 0000000..557a362 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/close/overload2.html @@ -0,0 +1,76 @@ + + + +basic_socket_acceptor::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the acceptor. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the acceptor. Any asynchronous accept + operations will be cancelled immediately. +

+

+ A subsequent call to open() is required before the acceptor can + again be used to again perform socket accept operations. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::error_code ec;
+acceptor.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/debug.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/debug.html new file mode 100644 index 0000000..cfc71ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/debug.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::debug + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to enable socket-level debugging. +

+
typedef implementation_defined debug;
+
+

+ Implements the SOL_SOCKET/SO_DEBUG socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/do_not_route.html new file mode 100644 index 0000000..8337c37 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/do_not_route.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to prevent routing, use local interfaces only. +

+
typedef implementation_defined do_not_route;
+
+

+ Implements the SOL_SOCKET/SO_DONTROUTE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/enable_connection_aborted.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/enable_connection_aborted.html new file mode 100644 index 0000000..54586c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/enable_connection_aborted.html @@ -0,0 +1,81 @@ + + + +basic_socket_acceptor::enable_connection_aborted + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to report aborted connections on accept. +

+
typedef implementation_defined enable_connection_aborted;
+
+

+ Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with asio::error::connection_aborted. + By default the option is false. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/endpoint_type.html new file mode 100644 index 0000000..72a8e42 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_acceptor::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/executor_type.html new file mode 100644 index 0000000..340705a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_acceptor::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_executor.html new file mode 100644 index 0000000..0b1d4cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_socket_acceptor::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option.html new file mode 100644 index 0000000..88974df --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option.html @@ -0,0 +1,53 @@ + + + +basic_socket_acceptor::get_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + an option from the acceptor. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+  » more...
+
+template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option/overload1.html new file mode 100644 index 0000000..241300d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option/overload1.html @@ -0,0 +1,86 @@ + + + +basic_socket_acceptor::get_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an option from the acceptor. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+
+

+ This function is used to get the current value of an option on the acceptor. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the acceptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_REUSEADDR option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::acceptor::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option/overload2.html new file mode 100644 index 0000000..d8fdf2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/get_option/overload2.html @@ -0,0 +1,83 @@ + + + +basic_socket_acceptor::get_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an option from the acceptor. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+
+

+ This function is used to get the current value of an option on the acceptor. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the acceptor. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_REUSEADDR option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::acceptor::reuse_address option;
+asio::error_code ec;
+acceptor.get_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+bool is_set = option.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control.html new file mode 100644 index 0000000..36bcccc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control.html @@ -0,0 +1,53 @@ + + + +basic_socket_acceptor::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + an IO control command on the acceptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control/overload1.html new file mode 100644 index 0000000..557976b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control/overload1.html @@ -0,0 +1,85 @@ + + + +basic_socket_acceptor::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform an IO control command on the acceptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the acceptor. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the acceptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::acceptor::non_blocking_io command(true);
+socket.io_control(command);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control/overload2.html new file mode 100644 index 0000000..73ea736 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/io_control/overload2.html @@ -0,0 +1,82 @@ + + + +basic_socket_acceptor::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform an IO control command on the acceptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the acceptor. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the acceptor. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::acceptor::non_blocking_io command(true);
+asio::error_code ec;
+socket.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/is_open.html new file mode 100644 index 0000000..7ee79cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/is_open.html @@ -0,0 +1,42 @@ + + + +basic_socket_acceptor::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the acceptor is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/keep_alive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/keep_alive.html new file mode 100644 index 0000000..e21aee0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/keep_alive.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::keep_alive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to send keep-alives. +

+
typedef implementation_defined keep_alive;
+
+

+ Implements the SOL_SOCKET/SO_KEEPALIVE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/linger.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/linger.html new file mode 100644 index 0000000..113810c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/linger.html @@ -0,0 +1,81 @@ + + + +basic_socket_acceptor::linger + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to specify whether the socket lingers on close if unsent data is + present. +

+
typedef implementation_defined linger;
+
+

+ Implements the SOL_SOCKET/SO_LINGER socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option(true, 30);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option;
+socket.get_option(option);
+bool is_set = option.enabled();
+unsigned short timeout = option.timeout();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen.html new file mode 100644 index 0000000..e91fcd1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen.html @@ -0,0 +1,49 @@ + + + +basic_socket_acceptor::listen + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Place + the acceptor into the state where it will listen for new connections. +

+
void listen(
+    int backlog = socket_base::max_listen_connections);
+  » more...
+
+void listen(
+    int backlog,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen/overload1.html new file mode 100644 index 0000000..fe239db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen/overload1.html @@ -0,0 +1,72 @@ + + + +basic_socket_acceptor::listen (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Place the acceptor into the state where it will listen for new connections. +

+
void listen(
+    int backlog = socket_base::max_listen_connections);
+
+

+ This function puts the socket acceptor into the state where it may accept + new connections. +

+
+ + Parameters +
+
+

+
+
backlog
+

+ The maximum length of the queue of pending connections. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen/overload2.html new file mode 100644 index 0000000..26d356a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/listen/overload2.html @@ -0,0 +1,77 @@ + + + +basic_socket_acceptor::listen (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Place the acceptor into the state where it will listen for new connections. +

+
void listen(
+    int backlog,
+    asio::error_code & ec);
+
+

+ This function puts the socket acceptor into the state where it may accept + new connections. +

+
+ + Parameters +
+
+

+
+
backlog
+

+ The maximum length of the queue of pending connections. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::error_code ec;
+acceptor.listen(asio::socket_base::max_listen_connections, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint.html new file mode 100644 index 0000000..fb0eeba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_socket_acceptor::local_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the local endpoint of the acceptor. +

+
endpoint_type local_endpoint() const;
+  » more...
+
+endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint/overload1.html new file mode 100644 index 0000000..cdbc8ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint/overload1.html @@ -0,0 +1,73 @@ + + + +basic_socket_acceptor::local_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the local endpoint of the acceptor. +

+
endpoint_type local_endpoint() const;
+
+

+ This function is used to obtain the locally bound endpoint of the acceptor. +

+
+ + Return + Value +
+

+ An object that represents the local endpoint of the acceptor. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::endpoint endpoint = acceptor.local_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint/overload2.html new file mode 100644 index 0000000..0729785 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/local_endpoint/overload2.html @@ -0,0 +1,81 @@ + + + +basic_socket_acceptor::local_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the local endpoint of the acceptor. +

+
endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the locally bound endpoint of the acceptor. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the local endpoint of the acceptor. Returns + a default-constructed endpoint object if an error occurred and the error + handler did not throw an exception. +

+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = acceptor.local_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/max_listen_connections.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/max_listen_connections.html new file mode 100644 index 0000000..9cdcec4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/max_listen_connections.html @@ -0,0 +1,45 @@ + + + +basic_socket_acceptor::max_listen_connections + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +The + maximum length of the queue of pending incoming connections. +

+
static const int max_listen_connections = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_do_not_route.html new file mode 100644 index 0000000..104a252 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_do_not_route.html @@ -0,0 +1,45 @@ + + + +basic_socket_acceptor::message_do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specify + that the data should not be subject to routing. +

+
static const int message_do_not_route = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_end_of_record.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_end_of_record.html new file mode 100644 index 0000000..9957dd0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_end_of_record.html @@ -0,0 +1,45 @@ + + + +basic_socket_acceptor::message_end_of_record + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specifies + that the data marks the end of a record. +

+
static const int message_end_of_record = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_flags.html new file mode 100644 index 0000000..b2b8707 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_flags.html @@ -0,0 +1,55 @@ + + + +basic_socket_acceptor::message_flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Bitmask + type for flags that can be passed to send and receive operations. +

+
typedef int message_flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_out_of_band.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_out_of_band.html new file mode 100644 index 0000000..408046b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_out_of_band.html @@ -0,0 +1,45 @@ + + + +basic_socket_acceptor::message_out_of_band + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Process + out-of-band data. +

+
static const int message_out_of_band = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_peek.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_peek.html new file mode 100644 index 0000000..a5eb99e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/message_peek.html @@ -0,0 +1,45 @@ + + + +basic_socket_acceptor::message_peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Peek + at incoming data without removing it from the input queue. +

+
static const int message_peek = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_handle.html new file mode 100644 index 0000000..e39a25e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_handle.html @@ -0,0 +1,47 @@ + + + +basic_socket_acceptor::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the native acceptor representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + acceptor. This is intended to allow access to native acceptor functionality + that is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_handle_type.html new file mode 100644 index 0000000..2fa5dda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_acceptor::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of an acceptor. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking.html new file mode 100644 index 0000000..5140dc5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_socket_acceptor::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native acceptor implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native acceptor implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload1.html new file mode 100644 index 0000000..6044862 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload1.html @@ -0,0 +1,65 @@ + + + +basic_socket_acceptor::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Gets the non-blocking mode of the native acceptor implementation. +

+
bool native_non_blocking() const;
+
+

+ This function is used to retrieve the non-blocking mode of the underlying + native acceptor. This mode has no effect on the behaviour of the acceptor + object's synchronous operations. +

+
+ + Return + Value +
+

+ true if the underlying acceptor + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + Remarks +
+

+ The current non-blocking mode is cached by the acceptor object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native acceptor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload2.html new file mode 100644 index 0000000..bc66d2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload2.html @@ -0,0 +1,80 @@ + + + +basic_socket_acceptor::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the native acceptor implementation. +

+
void native_non_blocking(
+    bool mode);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native acceptor. It has no effect on the behaviour of the acceptor object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + acceptor is put into non-blocking mode and direct system calls + may fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload3.html new file mode 100644 index 0000000..e6fb29c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/native_non_blocking/overload3.html @@ -0,0 +1,71 @@ + + + +basic_socket_acceptor::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the native acceptor implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native acceptor. It has no effect on the behaviour of the acceptor object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + acceptor is put into non-blocking mode and direct system calls + may fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking.html new file mode 100644 index 0000000..417e86c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_socket_acceptor::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the acceptor. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the acceptor. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload1.html new file mode 100644 index 0000000..eba7d8e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload1.html @@ -0,0 +1,61 @@ + + + +basic_socket_acceptor::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Gets the non-blocking mode of the acceptor. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the acceptor's synchronous + operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload2.html new file mode 100644 index 0000000..e0ab10c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload2.html @@ -0,0 +1,80 @@ + + + +basic_socket_acceptor::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the acceptor. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the acceptor's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload3.html new file mode 100644 index 0000000..8c88441 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/non_blocking/overload3.html @@ -0,0 +1,72 @@ + + + +basic_socket_acceptor::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the acceptor. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the acceptor's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open.html new file mode 100644 index 0000000..2710f82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open.html @@ -0,0 +1,49 @@ + + + +basic_socket_acceptor::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open + the acceptor using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+  » more...
+
+void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open/overload1.html new file mode 100644 index 0000000..8f3f7c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open/overload1.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::open (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the acceptor using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+
+

+ This function opens the socket acceptor so that it will use the specified + protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying which protocol is to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+acceptor.open(asio::ip::tcp::v4());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open/overload2.html new file mode 100644 index 0000000..cc6d15e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/open/overload2.html @@ -0,0 +1,76 @@ + + + +basic_socket_acceptor::open (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Open the acceptor using the specified protocol. +

+
void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+
+

+ This function opens the socket acceptor so that it will use the specified + protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying which protocol is to be used. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::error_code ec;
+acceptor.open(asio::ip::tcp::v4(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_.html new file mode 100644 index 0000000..88a384f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_.html @@ -0,0 +1,56 @@ + + + +basic_socket_acceptor::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_socket_acceptor + from another. +

+
basic_socket_acceptor & operator=(
+    basic_socket_acceptor && other);
+  » more...
+
+

+ Move-assign a basic_socket_acceptor from an + acceptor of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_socket_acceptor & > operator=(
+    basic_socket_acceptor< Protocol1, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_/overload1.html new file mode 100644 index 0000000..8623e29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_socket_acceptor::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_socket_acceptor from another. +

+
basic_socket_acceptor & operator=(
+    basic_socket_acceptor && other);
+
+

+ This assignment operator moves an acceptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket_acceptor + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket_acceptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_/overload2.html new file mode 100644 index 0000000..eaaad2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +basic_socket_acceptor::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_socket_acceptor from an + acceptor of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_socket_acceptor & > operator=(
+    basic_socket_acceptor< Protocol1, Executor1 > && other);
+
+

+ This assignment operator moves an acceptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_socket_acceptor + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_socket_acceptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/out_of_band_inline.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/out_of_band_inline.html new file mode 100644 index 0000000..2b73f24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/out_of_band_inline.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::out_of_band_inline + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for putting received out-of-band data inline. +

+
typedef implementation_defined out_of_band_inline;
+
+

+ Implements the SOL_SOCKET/SO_OOBINLINE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option;
+socket.get_option(option);
+bool value = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/protocol_type.html new file mode 100644 index 0000000..dfd4189 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_acceptor::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/receive_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/receive_buffer_size.html new file mode 100644 index 0000000..21f7136 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/receive_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::receive_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive buffer size of a socket. +

+
typedef implementation_defined receive_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_RCVBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/receive_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/receive_low_watermark.html new file mode 100644 index 0000000..6350710 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/receive_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::receive_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive low watermark. +

+
typedef implementation_defined receive_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_RCVLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release.html new file mode 100644 index 0000000..9dcc1fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release.html @@ -0,0 +1,47 @@ + + + +basic_socket_acceptor::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native acceptor. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release/overload1.html new file mode 100644 index 0000000..ad0d065 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release/overload1.html @@ -0,0 +1,69 @@ + + + +basic_socket_acceptor::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native acceptor. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous accept operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. Ownership + of the native acceptor is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release/overload2.html new file mode 100644 index 0000000..c4789b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/release/overload2.html @@ -0,0 +1,70 @@ + + + +basic_socket_acceptor::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native acceptor. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous accept operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. Ownership + of the native acceptor is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/reuse_address.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/reuse_address.html new file mode 100644 index 0000000..423067f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/reuse_address.html @@ -0,0 +1,80 @@ + + + +basic_socket_acceptor::reuse_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from 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. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/send_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/send_buffer_size.html new file mode 100644 index 0000000..3cbc31f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/send_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::send_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send buffer size of a socket. +

+
typedef implementation_defined send_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_SNDBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/send_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/send_low_watermark.html new file mode 100644 index 0000000..56ea57d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/send_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_socket_acceptor::send_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send low watermark. +

+
typedef implementation_defined send_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_SNDLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option.html new file mode 100644 index 0000000..186d60a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option.html @@ -0,0 +1,53 @@ + + + +basic_socket_acceptor::set_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + an option on the acceptor. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+  » more...
+
+template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option/overload1.html new file mode 100644 index 0000000..daaa799 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option/overload1.html @@ -0,0 +1,85 @@ + + + +basic_socket_acceptor::set_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set an option on the acceptor. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+
+

+ This function is used to set an option on the acceptor. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the acceptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Setting the SOL_SOCKET/SO_REUSEADDR option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::acceptor::reuse_address option(true);
+acceptor.set_option(option);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option/overload2.html new file mode 100644 index 0000000..22f09af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/set_option/overload2.html @@ -0,0 +1,82 @@ + + + +basic_socket_acceptor::set_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set an option on the acceptor. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+
+

+ This function is used to set an option on the acceptor. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the acceptor. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Setting the SOL_SOCKET/SO_REUSEADDR option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::ip::tcp::acceptor::reuse_address option(true);
+asio::error_code ec;
+acceptor.set_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/shutdown_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/shutdown_type.html new file mode 100644 index 0000000..c57428f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/shutdown_type.html @@ -0,0 +1,71 @@ + + + +basic_socket_acceptor::shutdown_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Different + ways a socket may be shutdown. +

+
enum shutdown_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
shutdown_receive
+

+ Shutdown the receive side of the socket. +

+
shutdown_send
+

+ Shutdown the send side of the socket. +

+
shutdown_both
+

+ Shutdown both send and receive on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait.html new file mode 100644 index 0000000..2625867 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait.html @@ -0,0 +1,50 @@ + + + +basic_socket_acceptor::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait + for the acceptor to become ready to read, ready to write, or to have pending + error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait/overload1.html new file mode 100644 index 0000000..d30811d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait/overload1.html @@ -0,0 +1,71 @@ + + + +basic_socket_acceptor::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for the acceptor to become ready to read, ready to write, or to + have pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for an acceptor to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired acceptor state. +

+
+
+
+ + Example +
+

+ Waiting for an acceptor to become readable. +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+acceptor.wait(asio::ip::tcp::acceptor::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait/overload2.html new file mode 100644 index 0000000..34ed1bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait/overload2.html @@ -0,0 +1,77 @@ + + + +basic_socket_acceptor::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for the acceptor to become ready to read, ready to write, or to + have pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for an acceptor to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired acceptor state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for an acceptor to become readable. +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::error_code ec;
+acceptor.wait(asio::ip::tcp::acceptor::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait_type.html new file mode 100644 index 0000000..57ae1b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor/wait_type.html @@ -0,0 +1,74 @@ + + + +basic_socket_acceptor::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a socket to become ready to read. +

+
wait_write
+

+ Wait for a socket to become ready to write. +

+
wait_error
+

+ Wait for a socket to have error conditions pending. +

+
+
+

+ For use with basic_socket::wait() and basic_socket::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor__rebind_executor.html new file mode 100644 index 0000000..77b8354 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_socket_acceptor::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the acceptor type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The socket type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor__rebind_executor/other.html new file mode 100644 index 0000000..50795e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_acceptor__rebind_executor/other.html @@ -0,0 +1,770 @@ + + + +basic_socket_acceptor::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + socket type when rebound to the specified executor. +

+
typedef basic_socket_acceptor< Protocol, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the acceptor type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of an acceptor. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ accept +

+ 		+

+ Accept a new connection.
—
Accept a new connection + and obtain the endpoint of the peer. +

+
+

+ assign +

+ 		+

+ Assigns an existing native acceptor to the acceptor. +

+
+

+ async_accept +

+ 		+

+ Start an asynchronous accept. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the acceptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_socket_acceptor [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_socket_acceptor from an acceptor of another protocol + type. +

+
+

+ bind +

+ 		+

+ Bind the acceptor to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the acceptor. +

+
+

+ close +

+ 		+

+ Close the acceptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the acceptor. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the acceptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the acceptor is open. +

+
+

+ listen +

+ 		+

+ Place the acceptor into the state where it will listen for new + connections. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the acceptor. +

+
+

+ native_handle +

+ 		+

+ Get the native acceptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native acceptor implementation. +
—
Sets the non-blocking mode of the native acceptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the acceptor.
—
Sets + the non-blocking mode of the acceptor. +

+
+

+ open +

+ 		+

+ Open the acceptor using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_acceptor from another.
—
+ Move-assign a basic_socket_acceptor from an acceptor of another + protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native acceptor. +

+
+

+ set_option +

+ 		+

+ Set an option on the acceptor. +

+
+

+ wait +

+ 		+

+ Wait for the acceptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_socket_acceptor [destructor] +

+ 		+

+ Destroys the acceptor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket_acceptor class template + is used for accepting new socket connections. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous accept operations + are thread safe, if the underlying operating system calls are also thread + safe. This means that it is permitted to perform concurrent calls to synchronous + accept operations on a + single socket object. Other synchronous operations, such as open or close, + are not thread safe. +

+
+ + Example +
+

+ Opening a socket acceptor with the SO_REUSEADDR option enabled: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::ip::tcp::endpoint endpoint(asio::ip::tcp::v4(), port);
+acceptor.open(endpoint.protocol());
+acceptor.set_option(asio::ip::tcp::acceptor::reuse_address(true));
+acceptor.bind(endpoint);
+acceptor.listen();
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_acceptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream.html new file mode 100644 index 0000000..8c783ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream.html @@ -0,0 +1,291 @@ + + + +basic_socket_iostream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Iostream interface for a socket. +

+
template<
+    typename Protocol,
+    typename Clock = chrono::steady_clock,
+    typename WaitTraits = wait_traits<Clock>>
+class basic_socket_iostream :
+  public std::basic_iostream< char >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ time_point +

+ 		+

+ The time type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_socket_iostream [constructor] +

+ 		+

+ Construct a basic_socket_iostream without establishing a connection. +
—
Construct a basic_socket_iostream from the supplied + socket.
—
Move-construct a basic_socket_iostream from + another.
—
Establish a connection to an endpoint corresponding + to a resolver query. +

+
+

+ close +

+ 		+

+ Close the connection. +

+
+

+ connect +

+ 		+

+ Establish a connection to an endpoint corresponding to a resolver + query. +

+
+

+ error +

+ 		+

+ Get the last error associated with the stream. +

+
+

+ expires_after +

+ 		+

+ Set the stream's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the stream's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the stream's expiry time as an absolute time. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_iostream from another. +

+
+

+ rdbuf +

+ 		+

+ Return a pointer to the underlying streambuf. +

+
+

+ socket +

+ 		+

+ Get a reference to the underlying socket. +

+
+
+ + Requirements +
+

+ Header: asio/basic_socket_iostream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream.html new file mode 100644 index 0000000..be8dd26 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream.html @@ -0,0 +1,68 @@ + + + +basic_socket_iostream::basic_socket_iostream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_socket_iostream + without establishing a connection. +

+
basic_socket_iostream();
+  » more...
+
+

+ Construct a basic_socket_iostream from the + supplied socket. +

+
explicit basic_socket_iostream(
+    basic_stream_socket< protocol_type > s);
+  » more...
+
+

+ Move-construct a basic_socket_iostream from another. +

+
basic_socket_iostream(
+    basic_socket_iostream && other);
+  » more...
+
+

+ Establish a connection to an endpoint corresponding to a resolver query. +

+
template<
+    typename... T>
+explicit basic_socket_iostream(
+    T... x);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload1.html new file mode 100644 index 0000000..e3312ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload1.html @@ -0,0 +1,42 @@ + + + +basic_socket_iostream::basic_socket_iostream (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket_iostream without + establishing a connection. +

+
basic_socket_iostream();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload2.html new file mode 100644 index 0000000..dbd172e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload2.html @@ -0,0 +1,43 @@ + + + +basic_socket_iostream::basic_socket_iostream (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket_iostream from the + supplied socket. +

+
basic_socket_iostream(
+    basic_stream_socket< protocol_type > s);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload3.html new file mode 100644 index 0000000..0fd5ff3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload3.html @@ -0,0 +1,42 @@ + + + +basic_socket_iostream::basic_socket_iostream (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_socket_iostream from another. +

+
basic_socket_iostream(
+    basic_socket_iostream && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload4.html new file mode 100644 index 0000000..13de519 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/basic_socket_iostream/overload4.html @@ -0,0 +1,49 @@ + + + +basic_socket_iostream::basic_socket_iostream (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establish a connection to an endpoint corresponding to a resolver query. +

+
template<
+    typename... T>
+basic_socket_iostream(
+    T... x);
+
+

+ This constructor automatically establishes a connection based on the + supplied resolver query parameters. The arguments are used to construct + a resolver query object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/clock_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/clock_type.html new file mode 100644 index 0000000..081742f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/clock_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_iostream::clock_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + clock type. +

+
typedef Clock clock_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_iostream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/close.html new file mode 100644 index 0000000..1e28905 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/close.html @@ -0,0 +1,42 @@ + + + +basic_socket_iostream::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the connection. +

+
void close();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/connect.html new file mode 100644 index 0000000..a4c6aa5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/connect.html @@ -0,0 +1,50 @@ + + + +basic_socket_iostream::connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Establish + a connection to an endpoint corresponding to a resolver query. +

+
template<
+    typename... T>
+void connect(
+    T... x);
+
+

+ This function automatically establishes a connection based on the supplied + resolver query parameters. The arguments are used to construct a resolver + query object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/duration.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/duration.html new file mode 100644 index 0000000..77abccf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/duration.html @@ -0,0 +1,52 @@ + + + +basic_socket_iostream::duration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + duration type. +

+
typedef WaitTraits::duration duration;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_iostream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/endpoint_type.html new file mode 100644 index 0000000..aa00229 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_iostream::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_iostream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/error.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/error.html new file mode 100644 index 0000000..a3a583e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/error.html @@ -0,0 +1,64 @@ + + + +basic_socket_iostream::error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the last error associated with the stream. +

+
const asio::error_code & error() const;
+
+
+ + Return + Value +
+

+ An error_code corresponding + to the last error from the stream. +

+
+ + Example +
+

+ To print the error associated with a failure to establish a connection: +

+
tcp::iostream s("www.boost.org", "http");
+if (!s)
+{
+  std::cout << "Error: " << s.error().message() << std::endl;
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expires_after.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expires_after.html new file mode 100644 index 0000000..71cd1c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expires_after.html @@ -0,0 +1,61 @@ + + + +basic_socket_iostream::expires_after + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the stream's expiry time relative to now. +

+
void expires_after(
+    const duration & expiry_time);
+
+

+ This function sets the expiry time associated with the stream. Stream operations + performed after this time (where the operations cannot be completed using + the internal buffers) will fail with the error asio::error::operation_aborted. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expires_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expires_at.html new file mode 100644 index 0000000..6578126 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expires_at.html @@ -0,0 +1,61 @@ + + + +basic_socket_iostream::expires_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the stream's expiry time as an absolute time. +

+
void expires_at(
+    const time_point & expiry_time);
+
+

+ This function sets the expiry time associated with the stream. Stream operations + performed after this time (where the operations cannot be completed using + the internal buffers) will fail with the error asio::error::operation_aborted. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the stream. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expiry.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expiry.html new file mode 100644 index 0000000..146f88e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/expiry.html @@ -0,0 +1,50 @@ + + + +basic_socket_iostream::expiry + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the stream's expiry time as an absolute time. +

+
time_point expiry() const;
+
+
+ + Return + Value +
+

+ An absolute time value representing the stream's expiry time. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/operator_eq_.html new file mode 100644 index 0000000..fa7c155 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/operator_eq_.html @@ -0,0 +1,44 @@ + + + +basic_socket_iostream::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_socket_iostream + from another. +

+
basic_socket_iostream & operator=(
+    basic_socket_iostream && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/protocol_type.html new file mode 100644 index 0000000..b966eff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_iostream::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_iostream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/rdbuf.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/rdbuf.html new file mode 100644 index 0000000..e0b0b71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/rdbuf.html @@ -0,0 +1,42 @@ + + + +basic_socket_iostream::rdbuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Return + a pointer to the underlying streambuf. +

+
basic_socket_streambuf< Protocol, Clock, WaitTraits > * rdbuf() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/socket.html new file mode 100644 index 0000000..9939fda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/socket.html @@ -0,0 +1,42 @@ + + + +basic_socket_iostream::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the underlying socket. +

+
basic_socket< Protocol > & socket();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/time_point.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/time_point.html new file mode 100644 index 0000000..861fa8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_iostream/time_point.html @@ -0,0 +1,52 @@ + + + +basic_socket_iostream::time_point + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + time type. +

+
typedef WaitTraits::time_point time_point;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_iostream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf.html new file mode 100644 index 0000000..1383cec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf.html @@ -0,0 +1,351 @@ + + + +basic_socket_streambuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Iostream streambuf for a socket. +

+
template<
+    typename Protocol,
+    typename Clock = chrono::steady_clock,
+    typename WaitTraits = wait_traits<Clock>>
+class basic_socket_streambuf :
+  public std::streambuf,
+  basic_socket< Protocol >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ time_point +

+ 		+

+ The time type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_socket_streambuf [constructor] +

+ 		+

+ Construct a basic_socket_streambuf without establishing a connection. +
—
Construct a basic_socket_streambuf from the supplied + socket.
—
Move-construct a basic_socket_streambuf from + another. +

+
+

+ close +

+ 		+

+ Close the connection. +

+
+

+ connect +

+ 		+

+ Establish a connection. +

+
+

+ error +

+ 		+

+ Get the last error associated with the stream buffer. +

+
+

+ expires_after +

+ 		+

+ Set the stream buffer's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the stream buffer's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the stream buffer's expiry time as an absolute time. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_streambuf from another. +

+
+

+ socket +

+ 		+

+ Get a reference to the underlying socket. +

+
+

+ ~basic_socket_streambuf [destructor] +

+ 		+

+ Destructor flushes buffered data. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ overflow +

+ 		+
+

+ setbuf +

+ 		+
+

+ sync +

+ 		+
+

+ underflow +

+ 		+
+
+ + Requirements +
+

+ Header: asio/basic_socket_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/_basic_socket_streambuf.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/_basic_socket_streambuf.html new file mode 100644 index 0000000..34eca72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/_basic_socket_streambuf.html @@ -0,0 +1,42 @@ + + + +basic_socket_streambuf::~basic_socket_streambuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor + flushes buffered data. +

+
virtual ~basic_socket_streambuf();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf.html new file mode 100644 index 0000000..f8eb061 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf.html @@ -0,0 +1,59 @@ + + + +basic_socket_streambuf::basic_socket_streambuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_socket_streambuf + without establishing a connection. +

+
basic_socket_streambuf();
+  » more...
+
+

+ Construct a basic_socket_streambuf from the + supplied socket. +

+
explicit basic_socket_streambuf(
+    basic_stream_socket< protocol_type > s);
+  » more...
+
+

+ Move-construct a basic_socket_streambuf from another. +

+
basic_socket_streambuf(
+    basic_socket_streambuf && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload1.html new file mode 100644 index 0000000..e4c78ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload1.html @@ -0,0 +1,42 @@ + + + +basic_socket_streambuf::basic_socket_streambuf (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket_streambuf without + establishing a connection. +

+
basic_socket_streambuf();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload2.html new file mode 100644 index 0000000..4720196 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload2.html @@ -0,0 +1,43 @@ + + + +basic_socket_streambuf::basic_socket_streambuf (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_socket_streambuf from + the supplied socket. +

+
basic_socket_streambuf(
+    basic_stream_socket< protocol_type > s);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload3.html new file mode 100644 index 0000000..cc58180 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/basic_socket_streambuf/overload3.html @@ -0,0 +1,43 @@ + + + +basic_socket_streambuf::basic_socket_streambuf (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_socket_streambuf from + another. +

+
basic_socket_streambuf(
+    basic_socket_streambuf && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/clock_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/clock_type.html new file mode 100644 index 0000000..5883ed1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/clock_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_streambuf::clock_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + clock type. +

+
typedef Clock clock_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/close.html new file mode 100644 index 0000000..f96f6b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/close.html @@ -0,0 +1,51 @@ + + + +basic_socket_streambuf::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the connection. +

+
basic_socket_streambuf * close();
+
+
+ + Return + Value +
+

+ this if a connection was successfully + established, a null pointer otherwise. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect.html new file mode 100644 index 0000000..9b8216a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect.html @@ -0,0 +1,50 @@ + + + +basic_socket_streambuf::connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Establish + a connection. +

+
basic_socket_streambuf * connect(
+    const endpoint_type & endpoint);
+  » more...
+
+template<
+    typename... T>
+basic_socket_streambuf * connect(
+    T... x);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect/overload1.html new file mode 100644 index 0000000..3fd5632 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect/overload1.html @@ -0,0 +1,54 @@ + + + +basic_socket_streambuf::connect (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establish a connection. +

+
basic_socket_streambuf * connect(
+    const endpoint_type & endpoint);
+
+

+ This function establishes a connection to the specified endpoint. +

+
+ + Return + Value +
+

+ this if a connection was + successfully established, a null pointer otherwise. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect/overload2.html new file mode 100644 index 0000000..5d9b2c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/connect/overload2.html @@ -0,0 +1,58 @@ + + + +basic_socket_streambuf::connect (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establish a connection. +

+
template<
+    typename... T>
+basic_socket_streambuf * connect(
+    T... x);
+
+

+ This function automatically establishes a connection based on the supplied + resolver query parameters. The arguments are used to construct a resolver + query object. +

+
+ + Return + Value +
+

+ this if a connection was + successfully established, a null pointer otherwise. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/duration.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/duration.html new file mode 100644 index 0000000..ee380ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/duration.html @@ -0,0 +1,52 @@ + + + +basic_socket_streambuf::duration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + duration type. +

+
typedef WaitTraits::duration duration;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/endpoint_type.html new file mode 100644 index 0000000..5cdbecc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_streambuf::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/error.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/error.html new file mode 100644 index 0000000..727a75f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/error.html @@ -0,0 +1,51 @@ + + + +basic_socket_streambuf::error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the last error associated with the stream buffer. +

+
const asio::error_code & error() const;
+
+
+ + Return + Value +
+

+ An error_code corresponding + to the last error from the stream buffer. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expires_after.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expires_after.html new file mode 100644 index 0000000..14517fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expires_after.html @@ -0,0 +1,61 @@ + + + +basic_socket_streambuf::expires_after + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the stream buffer's expiry time relative to now. +

+
void expires_after(
+    const duration & expiry_time);
+
+

+ This function sets the expiry time associated with the stream. Stream operations + performed after this time (where the operations cannot be completed using + the internal buffers) will fail with the error asio::error::operation_aborted. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expires_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expires_at.html new file mode 100644 index 0000000..d73b8ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expires_at.html @@ -0,0 +1,61 @@ + + + +basic_socket_streambuf::expires_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the stream buffer's expiry time as an absolute time. +

+
void expires_at(
+    const time_point & expiry_time);
+
+

+ This function sets the expiry time associated with the stream. Stream operations + performed after this time (where the operations cannot be completed using + the internal buffers) will fail with the error asio::error::operation_aborted. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the stream. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expiry.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expiry.html new file mode 100644 index 0000000..d7feb24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/expiry.html @@ -0,0 +1,50 @@ + + + +basic_socket_streambuf::expiry + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the stream buffer's expiry time as an absolute time. +

+
time_point expiry() const;
+
+
+ + Return + Value +
+

+ An absolute time value representing the stream buffer's expiry time. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/operator_eq_.html new file mode 100644 index 0000000..c9a78f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/operator_eq_.html @@ -0,0 +1,44 @@ + + + +basic_socket_streambuf::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_socket_streambuf + from another. +

+
basic_socket_streambuf & operator=(
+    basic_socket_streambuf && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/overflow.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/overflow.html new file mode 100644 index 0000000..20412a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/overflow.html @@ -0,0 +1,41 @@ + + + +basic_socket_streambuf::overflow + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
int_type overflow(
+    int_type c);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/protocol_type.html new file mode 100644 index 0000000..c124595 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_socket_streambuf::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/setbuf.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/setbuf.html new file mode 100644 index 0000000..aae3d1e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/setbuf.html @@ -0,0 +1,42 @@ + + + +basic_socket_streambuf::setbuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::streambuf * setbuf(
+    char_type * s,
+    std::streamsize n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/socket.html new file mode 100644 index 0000000..c373f2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/socket.html @@ -0,0 +1,42 @@ + + + +basic_socket_streambuf::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the underlying socket. +

+
basic_socket< Protocol > & socket();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/sync.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/sync.html new file mode 100644 index 0000000..660b7d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/sync.html @@ -0,0 +1,40 @@ + + + +basic_socket_streambuf::sync + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
int sync();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/time_point.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/time_point.html new file mode 100644 index 0000000..ace67dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/time_point.html @@ -0,0 +1,52 @@ + + + +basic_socket_streambuf::time_point + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + time type. +

+
typedef WaitTraits::time_point time_point;
+
+
+ + Requirements +
+

+ Header: asio/basic_socket_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/underflow.html b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/underflow.html new file mode 100644 index 0000000..b4f53d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_socket_streambuf/underflow.html @@ -0,0 +1,40 @@ + + + +basic_socket_streambuf::underflow + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
int_type underflow();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file.html new file mode 100644 index 0000000..8ffc49f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file.html @@ -0,0 +1,547 @@ + + + +basic_stream_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides stream-oriented file functionality. +

+
template<
+    typename Executor>
+class basic_stream_file :
+  public basic_file< Executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_file [constructor] +

+ 		+

+ Construct a basic_stream_file without opening it.
—
+ Construct and open a basic_stream_file.
—
Construct + a basic_stream_file on an existing native file.
—
Move-construct + a basic_stream_file from another.
—
Move-construct + a basic_stream_file from a file of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_file from another.
—
Move-assign + a basic_stream_file from a file of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the file. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ seek +

+ 		+

+ Seek to a position in the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+

+ write_some +

+ 		+

+ Write some data to the file. +

+
+

+ ~basic_stream_file [destructor] +

+ 		+

+ Destroys the file. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_stream_file + class template provides asynchronous and blocking stream-oriented file functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_stream_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/_basic_stream_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/_basic_stream_file.html new file mode 100644 index 0000000..3ff3559 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/_basic_stream_file.html @@ -0,0 +1,46 @@ + + + +basic_stream_file::~basic_stream_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the file. +

+
~basic_stream_file();
+
+

+ This function destroys the file, cancelling any outstanding asynchronous + operations associated with the file as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/append.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/append.html new file mode 100644 index 0000000..5eaf179 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/append.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::append + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open the + file in append mode. +

+
static const flags append = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign.html new file mode 100644 index 0000000..7004d81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign.html @@ -0,0 +1,49 @@ + + + +basic_stream_file::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign an + existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file);
+  » more...
+
+void assign(
+    const native_handle_type & native_file,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign/overload1.html new file mode 100644 index 0000000..7ddde48 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign/overload1.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Assign an existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign/overload2.html new file mode 100644 index 0000000..f4f2da8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/assign/overload2.html @@ -0,0 +1,46 @@ + + + +basic_stream_file::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Assign an existing native file to the file. +

+
void assign(
+    const native_handle_type & native_file,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/async_read_some.html new file mode 100644 index 0000000..555c13e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/async_read_some.html @@ -0,0 +1,143 @@ + + + +basic_stream_file::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the stream file. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
file.async_read_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/async_write_some.html new file mode 100644 index 0000000..bc65a52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/async_write_some.html @@ -0,0 +1,143 @@ + + + +basic_stream_file::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the stream file. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the file. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
file.async_write_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file.html new file mode 100644 index 0000000..49d3e7f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file.html @@ -0,0 +1,120 @@ + + + +basic_stream_file::basic_stream_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_stream_file + without opening it. +

+
explicit basic_stream_file(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_stream_file(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct and open a basic_stream_file. +

+
basic_stream_file(
+    const executor_type & ex,
+    const char * path,
+    file_base::flags open_flags);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_file(
+    ExecutionContext & context,
+    const char * path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+basic_stream_file(
+    const executor_type & ex,
+    const std::string & path,
+    file_base::flags open_flags);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_file(
+    ExecutionContext & context,
+    const std::string & path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_stream_file on an existing + native file. +

+
basic_stream_file(
+    const executor_type & ex,
+    const native_handle_type & native_file);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_file(
+    ExecutionContext & context,
+    const native_handle_type & native_file,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Move-construct a basic_stream_file from another. +

+
basic_stream_file(
+    basic_stream_file && other);
+  » more...
+
+

+ Move-construct a basic_stream_file from a file + of another executor type. +

+
template<
+    typename Executor1>
+basic_stream_file(
+    basic_stream_file< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload1.html new file mode 100644 index 0000000..0161d97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload1.html @@ -0,0 +1,61 @@ + + + +basic_stream_file::basic_stream_file (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_file without opening + it. +

+
basic_stream_file(
+    const executor_type & ex);
+
+

+ This constructor initialises a file without opening it. The file needs + to be opened before data can be read from or or written to it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload10.html new file mode 100644 index 0000000..025a637 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload10.html @@ -0,0 +1,72 @@ + + + +basic_stream_file::basic_stream_file (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_stream_file from a file + of another executor type. +

+
template<
+    typename Executor1>
+basic_stream_file(
+    basic_stream_file< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a stream file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_file object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload2.html new file mode 100644 index 0000000..29ae4ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload2.html @@ -0,0 +1,65 @@ + + + +basic_stream_file::basic_stream_file (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_file without opening + it. +

+
template<
+    typename ExecutionContext>
+basic_stream_file(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a file without opening it. The file needs + to be opened before data can be read from or or written to it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload3.html new file mode 100644 index 0000000..59764e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload3.html @@ -0,0 +1,82 @@ + + + +basic_stream_file::basic_stream_file (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_stream_file. +

+
basic_stream_file(
+    const executor_type & ex,
+    const char * path,
+    file_base::flags open_flags);
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload4.html new file mode 100644 index 0000000..7f20414 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload4.html @@ -0,0 +1,86 @@ + + + +basic_stream_file::basic_stream_file (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_stream_file. +

+
template<
+    typename ExecutionContext>
+basic_stream_file(
+    ExecutionContext & context,
+    const char * path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload5.html new file mode 100644 index 0000000..3e0d189 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload5.html @@ -0,0 +1,82 @@ + + + +basic_stream_file::basic_stream_file (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_stream_file. +

+
basic_stream_file(
+    const executor_type & ex,
+    const std::string & path,
+    file_base::flags open_flags);
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload6.html new file mode 100644 index 0000000..7ed6bcc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload6.html @@ -0,0 +1,86 @@ + + + +basic_stream_file::basic_stream_file (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_stream_file. +

+
template<
+    typename ExecutionContext>
+basic_stream_file(
+    ExecutionContext & context,
+    const std::string & path,
+    file_base::flags open_flags,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises and opens a file. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload7.html new file mode 100644 index 0000000..696fa7a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload7.html @@ -0,0 +1,79 @@ + + + +basic_stream_file::basic_stream_file (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_file on an existing + native file. +

+
basic_stream_file(
+    const executor_type & ex,
+    const native_handle_type & native_file);
+
+

+ This constructor initialises a stream file object to hold an existing + native file. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the file will use, by default, to dispatch + handlers for any asynchronous operations performed on the file. +

+
native_file
+

+ The new underlying file implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload8.html new file mode 100644 index 0000000..979d5b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload8.html @@ -0,0 +1,83 @@ + + + +basic_stream_file::basic_stream_file (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_file on an existing + native file. +

+
template<
+    typename ExecutionContext>
+basic_stream_file(
+    ExecutionContext & context,
+    const native_handle_type & native_file,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor initialises a stream file object to hold an existing + native file. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the file + will use, by default, to dispatch handlers for any asynchronous + operations performed on the file. +

+
native_file
+

+ The new underlying file implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload9.html new file mode 100644 index 0000000..84c3c5b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/basic_stream_file/overload9.html @@ -0,0 +1,68 @@ + + + +basic_stream_file::basic_stream_file (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_stream_file from another. +

+
basic_stream_file(
+    basic_stream_file && other);
+
+

+ This constructor moves a stream file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_file object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel.html new file mode 100644 index 0000000..6375c36 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel.html @@ -0,0 +1,47 @@ + + + +basic_stream_file::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel all + asynchronous operations associated with the file. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel/overload1.html new file mode 100644 index 0000000..dea18b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel/overload1.html @@ -0,0 +1,95 @@ + + + +basic_stream_file::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Cancel all asynchronous operations associated with the file. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using the close() function to simultaneously cancel the + outstanding operations and close the file. +

+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel/overload2.html new file mode 100644 index 0000000..73ea3d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/cancel/overload2.html @@ -0,0 +1,96 @@ + + + +basic_stream_file::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Cancel all asynchronous operations associated with the file. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using the close() function to simultaneously cancel the + outstanding operations and close the file. +

+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close.html new file mode 100644 index 0000000..ab3d3d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close.html @@ -0,0 +1,46 @@ + + + +basic_stream_file::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the file. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close/overload1.html new file mode 100644 index 0000000..cc86045 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close/overload1.html @@ -0,0 +1,63 @@ + + + +basic_stream_file::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Close the file. +

+
void close();
+
+

+ This function is used to close the file. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close/overload2.html new file mode 100644 index 0000000..4e4db6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/close/overload2.html @@ -0,0 +1,77 @@ + + + +basic_stream_file::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Close the file. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the file. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::stream_file file(my_context);
+...
+asio::error_code ec;
+file.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/create.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/create.html new file mode 100644 index 0000000..4a85cab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/create.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::create + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Create the + file if it does not exist. +

+
static const flags create = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/exclusive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/exclusive.html new file mode 100644 index 0000000..8d8647a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/exclusive.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::exclusive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Ensure + a new file is created. Must be combined with create. +

+
static const flags exclusive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/executor_type.html new file mode 100644 index 0000000..dd4835b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_stream_file::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/flags.html new file mode 100644 index 0000000..51375fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/flags.html @@ -0,0 +1,55 @@ + + + +basic_stream_file::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +A bitmask type + (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/get_executor.html new file mode 100644 index 0000000..3f65c84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/get_executor.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/is_open.html new file mode 100644 index 0000000..b778f2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/is_open.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ +Determine + whether the file is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/native_handle.html new file mode 100644 index 0000000..4a44581 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/native_handle.html @@ -0,0 +1,50 @@ + + + +basic_stream_file::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ +Get + the native file representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + file. This is intended to allow access to native file functionality that + is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/native_handle_type.html new file mode 100644 index 0000000..ffbe4b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_stream_file::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a file. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open.html new file mode 100644 index 0000000..ca24282 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open.html @@ -0,0 +1,62 @@ + + + +basic_stream_file::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the file + using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags);
+  » more...
+
+void open(
+    const char * path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+  » more...
+
+void open(
+    const std::string & path,
+    file_base::flags open_flags);
+  » more...
+
+void open(
+    const std::string & path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload1.html new file mode 100644 index 0000000..b269561 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload1.html @@ -0,0 +1,121 @@ + + + +basic_stream_file::open (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+file.open("/path/to/my/file", asio::stream_file::read_only);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload2.html new file mode 100644 index 0000000..36667b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload2.html @@ -0,0 +1,127 @@ + + + +basic_stream_file::open (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const char * path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::stream_file file(my_context);
+asio::error_code ec;
+file.open("/path/to/my/file", asio::stream_file::read_only, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload3.html new file mode 100644 index 0000000..94bbadc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload3.html @@ -0,0 +1,121 @@ + + + +basic_stream_file::open (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const std::string & path,
+    file_base::flags open_flags);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+file.open("/path/to/my/file", asio::stream_file::read_only);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload4.html new file mode 100644 index 0000000..700e14c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/open/overload4.html @@ -0,0 +1,118 @@ + + + +basic_stream_file::open (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Open the file using the specified path. +

+
void open(
+    const std::string & path,
+    file_base::flags open_flags,
+    asio::error_code & ec);
+
+

+ This function opens the file so that it will use the specified path. +

+
+ + Parameters +
+
+

+
+
path
+

+ The path name identifying the file to be opened. +

+
open_flags
+

+ A set of flags that determine how the file should be opened. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+

+ Exactly one of the following file_base::flags + values must be specified: +

+
    +
  • + flags::read_only +
    • +
  • + flags::write_only +
    • +
  • + flags::read_write +
    • +
+

+ The following flags may be bitwise or-ed in addition: +

+
    +
  • + flags::append +
    • +
  • + flags::create +
    • +
  • + flags::exclusive +
    • +
  • + flags::truncate +
    • +
  • + flags::sync_all_on_write +
    • +
+
+ + Example +
+
asio::stream_file file(my_context);
+asio::error_code ec;
+file.open("/path/to/my/file", asio::stream_file::read_only, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_.html new file mode 100644 index 0000000..f8caa11 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_.html @@ -0,0 +1,55 @@ + + + +basic_stream_file::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_stream_file + from another. +

+
basic_stream_file & operator=(
+    basic_stream_file && other);
+  » more...
+
+

+ Move-assign a basic_stream_file from a file + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_stream_file & > operator=(
+    basic_stream_file< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_/overload1.html new file mode 100644 index 0000000..307d533 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_stream_file::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_stream_file from another. +

+
basic_stream_file & operator=(
+    basic_stream_file && other);
+
+

+ This assignment operator moves a stream file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_file object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_/overload2.html new file mode 100644 index 0000000..2250cd7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +basic_stream_file::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_stream_file from a file + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_stream_file & > operator=(
+    basic_stream_file< Executor1 > && other);
+
+

+ This assignment operator moves a stream file from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_file object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_file(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_only.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_only.html new file mode 100644 index 0000000..8a75759 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_only.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::read_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file for reading. +

+
static const flags read_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some.html new file mode 100644 index 0000000..0fd4a50 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some.html @@ -0,0 +1,53 @@ + + + +basic_stream_file::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the file. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some/overload1.html new file mode 100644 index 0000000..2f73d03 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some/overload1.html @@ -0,0 +1,108 @@ + + + +basic_stream_file::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the file. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to read data from the stream file. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the end of the file was reached. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
file.read_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some/overload2.html new file mode 100644 index 0000000..c0ebde7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_some/overload2.html @@ -0,0 +1,85 @@ + + + +basic_stream_file::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the file. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to read data from the stream file. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_write.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_write.html new file mode 100644 index 0000000..fda0cbc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/read_write.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::read_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file for reading and writing. +

+
static const flags read_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release.html new file mode 100644 index 0000000..2c0e112 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release.html @@ -0,0 +1,47 @@ + + + +basic_stream_file::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native file. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release/overload1.html new file mode 100644 index 0000000..fdafaf3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release/overload1.html @@ -0,0 +1,72 @@ + + + +basic_stream_file::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Release ownership of the underlying native file. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. Ownership + of the native file is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release/overload2.html new file mode 100644 index 0000000..629f01a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/release/overload2.html @@ -0,0 +1,73 @@ + + + +basic_stream_file::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Release ownership of the underlying native file. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous read and write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. Ownership + of the native file is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize.html new file mode 100644 index 0000000..2091174 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize.html @@ -0,0 +1,49 @@ + + + +basic_stream_file::resize + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Alter the + size of the file. +

+
void resize(
+    uint64_t n);
+  » more...
+
+void resize(
+    uint64_t n,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize/overload1.html new file mode 100644 index 0000000..0ff56d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize/overload1.html @@ -0,0 +1,77 @@ + + + +basic_stream_file::resize (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Alter the size of the file. +

+
void resize(
+    uint64_t n);
+
+

+ This function resizes the file to the specified size, in bytes. If the + current file size exceeds n + then any extra data is discarded. If the current size is less than n then the file is extended and filled + with zeroes. +

+
+ + Parameters +
+
+

+
+
n
+

+ The new size for the file. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize/overload2.html new file mode 100644 index 0000000..99cdbb7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/resize/overload2.html @@ -0,0 +1,69 @@ + + + +basic_stream_file::resize (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Alter the size of the file. +

+
void resize(
+    uint64_t n,
+    asio::error_code & ec);
+
+

+ This function resizes the file to the specified size, in bytes. If the + current file size exceeds n + then any extra data is discarded. If the current size is less than n then the file is extended and filled + with zeroes. +

+
+ + Parameters +
+
+

+
+
n
+

+ The new size for the file. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek.html new file mode 100644 index 0000000..97feca8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek.html @@ -0,0 +1,51 @@ + + + +basic_stream_file::seek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Seek to a position + in the file. +

+
uint64_t seek(
+    int64_t offset,
+    file_base::seek_basis whence);
+  » more...
+
+uint64_t seek(
+    int64_t offset,
+    file_base::seek_basis whence,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek/overload1.html new file mode 100644 index 0000000..4b938c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek/overload1.html @@ -0,0 +1,85 @@ + + + +basic_stream_file::seek (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Seek to a position in the file. +

+
uint64_t seek(
+    int64_t offset,
+    file_base::seek_basis whence);
+
+

+ This function updates the current position in the file. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The requested position in the file, relative to whence. +

+
whence
+

+ One of seek_set, + seek_cur or seek_end. +

+
+
+
+ + Return + Value +
+

+ The new position relative to the beginning of the file. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek/overload2.html new file mode 100644 index 0000000..80687be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek/overload2.html @@ -0,0 +1,77 @@ + + + +basic_stream_file::seek (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Seek to a position in the file. +

+
uint64_t seek(
+    int64_t offset,
+    file_base::seek_basis whence,
+    asio::error_code & ec);
+
+

+ This function updates the current position in the file. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The requested position in the file, relative to whence. +

+
whence
+

+ One of seek_set, + seek_cur or seek_end. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The new position relative to the beginning of the file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek_basis.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek_basis.html new file mode 100644 index 0000000..9731d9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/seek_basis.html @@ -0,0 +1,71 @@ + + + +basic_stream_file::seek_basis + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Basis + for seeking in a file. +

+
enum seek_basis
+
+

+ + + +

+
+ + Values +
+
+

+
+
seek_set
+

+ Seek to an absolute position. +

+
seek_cur
+

+ Seek to an offset relative to the current file position. +

+
seek_end
+

+ Seek to an offset relative to the end of the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size.html new file mode 100644 index 0000000..baec23e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size.html @@ -0,0 +1,47 @@ + + + +basic_stream_file::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the size + of the file. +

+
uint64_t size() const;
+  » more...
+
+uint64_t size(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size/overload1.html new file mode 100644 index 0000000..a60e605 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size/overload1.html @@ -0,0 +1,60 @@ + + + +basic_stream_file::size (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Get the size of the file. +

+
uint64_t size() const;
+
+

+ This function determines the size of the file, in bytes. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size/overload2.html new file mode 100644 index 0000000..8d8fff4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/size/overload2.html @@ -0,0 +1,61 @@ + + + +basic_stream_file::size (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Get the size of the file. +

+
uint64_t size(
+    asio::error_code & ec) const;
+
+

+ This function determines the size of the file, in bytes. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all.html new file mode 100644 index 0000000..4a9ab6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all.html @@ -0,0 +1,47 @@ + + + +basic_stream_file::sync_all + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Synchronise + the file to disk. +

+
void sync_all();
+  » more...
+
+void sync_all(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all/overload1.html new file mode 100644 index 0000000..e666372 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all/overload1.html @@ -0,0 +1,61 @@ + + + +basic_stream_file::sync_all (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file to disk. +

+
void sync_all();
+
+

+ This function synchronises the file data and metadata to disk. Note that + the semantics of this synchronisation vary between operation systems. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all/overload2.html new file mode 100644 index 0000000..e690936 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all/overload2.html @@ -0,0 +1,62 @@ + + + +basic_stream_file::sync_all (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file to disk. +

+
void sync_all(
+    asio::error_code & ec);
+
+

+ This function synchronises the file data and metadata to disk. Note that + the semantics of this synchronisation vary between operation systems. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all_on_write.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all_on_write.html new file mode 100644 index 0000000..e8784ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_all_on_write.html @@ -0,0 +1,46 @@ + + + +basic_stream_file::sync_all_on_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file so that write operations automatically synchronise the file data + and metadata to disk. +

+
static const flags sync_all_on_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data.html new file mode 100644 index 0000000..1464396 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data.html @@ -0,0 +1,47 @@ + + + +basic_stream_file::sync_data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Synchronise + the file data to disk. +

+
void sync_data();
+  » more...
+
+void sync_data(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data/overload1.html new file mode 100644 index 0000000..5eda631 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data/overload1.html @@ -0,0 +1,61 @@ + + + +basic_stream_file::sync_data (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file data to disk. +

+
void sync_data();
+
+

+ This function synchronises the file data to disk. Note that the semantics + of this synchronisation vary between operation systems. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data/overload2.html new file mode 100644 index 0000000..cc5115c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/sync_data/overload2.html @@ -0,0 +1,62 @@ + + + +basic_stream_file::sync_data (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_file. +

+

+ Synchronise the file data to disk. +

+
void sync_data(
+    asio::error_code & ec);
+
+

+ This function synchronises the file data to disk. Note that the semantics + of this synchronisation vary between operation systems. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/truncate.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/truncate.html new file mode 100644 index 0000000..ec6306d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/truncate.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::truncate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file with any existing contents truncated. +

+
static const flags truncate = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_only.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_only.html new file mode 100644 index 0000000..ae1974b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_only.html @@ -0,0 +1,45 @@ + + + +basic_stream_file::write_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from file_base. +

+

+ +Open + the file for writing. +

+
static const flags write_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some.html new file mode 100644 index 0000000..1d87a2f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some.html @@ -0,0 +1,53 @@ + + + +basic_stream_file::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the file. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some/overload1.html new file mode 100644 index 0000000..0d9de12 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some/overload1.html @@ -0,0 +1,107 @@ + + + +basic_stream_file::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the file. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write data to the stream file. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the file. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the end of the file was reached. +

+
+
+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
file.write_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some/overload2.html new file mode 100644 index 0000000..1100718 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file/write_some/overload2.html @@ -0,0 +1,84 @@ + + + +basic_stream_file::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the file. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write data to the stream file. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the file. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file__rebind_executor.html new file mode 100644 index 0000000..7f1e3b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_stream_file::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the file type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The file type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_stream_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file__rebind_executor/other.html new file mode 100644 index 0000000..e0a71f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_file__rebind_executor/other.html @@ -0,0 +1,545 @@ + + + +basic_stream_file::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + file type when rebound to the specified executor. +

+
typedef basic_stream_file< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_file [constructor] +

+ 		+

+ Construct a basic_stream_file without opening it.
—
+ Construct and open a basic_stream_file.
—
Construct + a basic_stream_file on an existing native file.
—
+ Move-construct a basic_stream_file from another.
—
+ Move-construct a basic_stream_file from a file of another executor + type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_file from another.
—
Move-assign + a basic_stream_file from a file of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the file. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ seek +

+ 		+

+ Seek to a position in the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+

+ write_some +

+ 		+

+ Write some data to the file. +

+
+

+ ~basic_stream_file [destructor] +

+ 		+

+ Destroys the file. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_stream_file + class template provides asynchronous and blocking stream-oriented file + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_stream_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket.html new file mode 100644 index 0000000..fbf84ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket.html @@ -0,0 +1,917 @@ + + + +basic_stream_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides stream-oriented socket functionality. +

+
template<
+    typename Protocol,
+    typename Executor>
+class basic_stream_socket :
+  public basic_socket< Protocol, Executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close if + unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_stream_socket [constructor] +

+ 		+

+ 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.
—
Move-construct a basic_stream_socket + from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets the + non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_socket from another.
—
Move-assign + a basic_stream_socket from a socket of another protocol type. +

+
+

+ read_some +

+ 		+

+ Read some data from the socket. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, or + to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the socket. +

+
+

+ ~basic_stream_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_stream_socket + class template provides asynchronous and blocking stream-oriented socket + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations are + thread safe with respect to each other, if the underlying operating system + calls are also thread safe. This means that it is permitted to perform concurrent + calls to these synchronous operations on a single socket object. Other synchronous + operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/_basic_stream_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/_basic_stream_socket.html new file mode 100644 index 0000000..65e46f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/_basic_stream_socket.html @@ -0,0 +1,46 @@ + + + +basic_stream_socket::~basic_stream_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the socket. +

+
~basic_stream_socket();
+
+

+ This function destroys the socket, cancelling any outstanding asynchronous + operations associated with the socket as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign.html new file mode 100644 index 0000000..016e58d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign.html @@ -0,0 +1,51 @@ + + + +basic_stream_socket::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign/overload1.html new file mode 100644 index 0000000..cc71a72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign/overload1.html @@ -0,0 +1,46 @@ + + + +basic_stream_socket::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign/overload2.html new file mode 100644 index 0000000..5496f15 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/assign/overload2.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Assign an existing native socket to the socket. +

+
void assign(
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_connect.html new file mode 100644 index 0000000..c37b648 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_connect.html @@ -0,0 +1,142 @@ + + + +basic_stream_socket::async_connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Start + an asynchronous connect. +

+
template<
+    typename ConnectToken = default_completion_token_t<executor_type>>
+DEDUCED async_connect(
+    const endpoint_type & peer_endpoint,
+    ConnectToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously connect a socket to the specified + remote endpoint. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ The socket is automatically opened if it is not already open. If the connect + fails, and the socket was automatically opened, the socket is not returned + to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. Copies + will be made of the endpoint object as required. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the connect completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void connect_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Connect succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.async_connect(endpoint, connect_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_read_some.html new file mode 100644 index 0000000..aadd5ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_read_some.html @@ -0,0 +1,143 @@ + + + +basic_stream_socket::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the stream socket. + socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
socket.async_read_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive.html new file mode 100644 index 0000000..07a93f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive.html @@ -0,0 +1,57 @@ + + + +basic_stream_socket::async_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive/overload1.html new file mode 100644 index 0000000..ea91d66 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive/overload1.html @@ -0,0 +1,141 @@ + + + +basic_stream_socket::async_receive (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the stream + socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The receive operation may not receive all of the requested number of + bytes. Consider using the async_read function if you need + to ensure that the requested amount of data is received before the asynchronous + operation completes. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive/overload2.html new file mode 100644 index 0000000..61bd9d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_receive/overload2.html @@ -0,0 +1,146 @@ + + + +basic_stream_socket::async_receive (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous receive. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously receive data from the stream + socket. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. 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 completion handler is + called. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the receive completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes received.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The receive operation may not receive all of the requested number of + bytes. Consider using the async_read function if you need + to ensure that the requested amount of data is received before the asynchronous + operation completes. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.async_receive(asio::buffer(data, size), 0, handler);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send.html new file mode 100644 index 0000000..b9e0430 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send.html @@ -0,0 +1,57 @@ + + + +basic_stream_socket::async_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send/overload1.html new file mode 100644 index 0000000..8b36097 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send/overload1.html @@ -0,0 +1,140 @@ + + + +basic_stream_socket::async_send (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send data on the stream socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The send operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.async_send(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send/overload2.html new file mode 100644 index 0000000..c6455cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_send/overload2.html @@ -0,0 +1,145 @@ + + + +basic_stream_socket::async_send (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous send. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously send data on the stream socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. 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 completion handler is called. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the send completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Number of bytes sent.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The send operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.async_send(asio::buffer(data, size), 0, handler);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_wait.html new file mode 100644 index 0000000..94a6196 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_wait.html @@ -0,0 +1,137 @@ + + + +basic_stream_socket::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Asynchronously + wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for a socket to enter + a ready to read, write or error condition state. It is an initiating function + for an asynchronous operation, + and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::ip::tcp::socket socket(my_context);
+...
+socket.async_wait(asio::ip::tcp::socket::wait_read, wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_write_some.html new file mode 100644 index 0000000..7d30bd4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/async_write_some.html @@ -0,0 +1,143 @@ + + + +basic_stream_socket::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the stream socket. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the socket. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
socket.async_write_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ On POSIX or Windows operating systems, this asynchronous operation supports + cancellation for the following cancellation_type values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark.html new file mode 100644 index 0000000..35780f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::at_mark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+  » more...
+
+bool at_mark(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark/overload1.html new file mode 100644 index 0000000..2fd4924 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark/overload1.html @@ -0,0 +1,69 @@ + + + +basic_stream_socket::at_mark (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark() const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark/overload2.html new file mode 100644 index 0000000..cf30b82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/at_mark/overload2.html @@ -0,0 +1,70 @@ + + + +basic_stream_socket::at_mark (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine whether the socket is at the out-of-band data mark. +

+
bool at_mark(
+    asio::error_code & ec) const;
+
+

+ This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A bool indicating whether the socket is at the out-of-band data mark. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available.html new file mode 100644 index 0000000..d81c7cc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::available + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the number of bytes available for reading. +

+
std::size_t available() const;
+  » more...
+
+std::size_t available(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available/overload1.html new file mode 100644 index 0000000..309e737 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available/overload1.html @@ -0,0 +1,70 @@ + + + +basic_stream_socket::available (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available() const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available/overload2.html new file mode 100644 index 0000000..0d84bd0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/available/overload2.html @@ -0,0 +1,71 @@ + + + +basic_stream_socket::available (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Determine the number of bytes available for reading. +

+
std::size_t available(
+    asio::error_code & ec) const;
+
+

+ This function is used to determine the number of bytes that may be read + without blocking. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes that may be read without blocking, or 0 if an error + occurs. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket.html new file mode 100644 index 0000000..f334efc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket.html @@ -0,0 +1,123 @@ + + + +basic_stream_socket::basic_stream_socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_stream_socket + without opening it. +

+
explicit basic_stream_socket(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_stream_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct and open a basic_stream_socket. +

+
basic_stream_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_stream_socket, opening it + and binding it to the given local endpoint. +

+
basic_stream_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Construct a basic_stream_socket on an existing + native socket. +

+
basic_stream_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_stream_socket from another. +

+
basic_stream_socket(
+    basic_stream_socket && other);
+  » more...
+
+

+ Move-construct a basic_stream_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_stream_socket(
+    basic_stream_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload1.html new file mode 100644 index 0000000..9b4cf2f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload1.html @@ -0,0 +1,62 @@ + + + +basic_stream_socket::basic_stream_socket (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_socket without + opening it. +

+
basic_stream_socket(
+    const executor_type & ex);
+
+

+ This constructor creates a stream socket without opening it. The socket + needs to be opened and then connected or accepted before data can be + sent or received on it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload10.html new file mode 100644 index 0000000..9e9ef23 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload10.html @@ -0,0 +1,73 @@ + + + +basic_stream_socket::basic_stream_socket (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_stream_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+basic_stream_socket(
+    basic_stream_socket< Protocol1, Executor1 > && other,
+    constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a stream socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload2.html new file mode 100644 index 0000000..da6edf2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload2.html @@ -0,0 +1,66 @@ + + + +basic_stream_socket::basic_stream_socket (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_socket without + opening it. +

+
template<
+    typename ExecutionContext>
+basic_stream_socket(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a stream socket without opening it. The socket + needs to be opened and then connected or accepted before data can be + sent or received on it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload3.html new file mode 100644 index 0000000..2281278 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload3.html @@ -0,0 +1,78 @@ + + + +basic_stream_socket::basic_stream_socket (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_stream_socket. +

+
basic_stream_socket(
+    const executor_type & ex,
+    const protocol_type & protocol);
+
+

+ This constructor creates and opens a stream socket. The socket needs + to be connected or accepted before data can be sent or received on it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload4.html new file mode 100644 index 0000000..4a035e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload4.html @@ -0,0 +1,82 @@ + + + +basic_stream_socket::basic_stream_socket (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a basic_stream_socket. +

+
template<
+    typename ExecutionContext>
+basic_stream_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates and opens a stream socket. The socket needs + to be connected or accepted before data can be sent or received on it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload5.html new file mode 100644 index 0000000..1fe7d17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload5.html @@ -0,0 +1,81 @@ + + + +basic_stream_socket::basic_stream_socket (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_socket, opening + it and binding it to the given local endpoint. +

+
basic_stream_socket(
+    const executor_type & ex,
+    const endpoint_type & endpoint);
+
+

+ This constructor creates a stream socket and automatically opens it bound + to the specified endpoint on the local machine. The protocol used is + the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the stream socket will + be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload6.html new file mode 100644 index 0000000..47238f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload6.html @@ -0,0 +1,85 @@ + + + +basic_stream_socket::basic_stream_socket (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_socket, opening + it and binding it to the given local endpoint. +

+
template<
+    typename ExecutionContext>
+basic_stream_socket(
+    ExecutionContext & context,
+    const endpoint_type & endpoint,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a stream socket and automatically opens it bound + to the specified endpoint on the local machine. The protocol used is + the protocol associated with the given endpoint. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
endpoint
+

+ An endpoint on the local machine to which the stream socket will + be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload7.html new file mode 100644 index 0000000..d94045c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload7.html @@ -0,0 +1,84 @@ + + + +basic_stream_socket::basic_stream_socket (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_socket on an existing + native socket. +

+
basic_stream_socket(
+    const executor_type & ex,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket);
+
+

+ This constructor creates a stream socket object to hold an existing native + socket. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the socket will use, by default, to dispatch + handlers for any asynchronous operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload8.html new file mode 100644 index 0000000..ea15178 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload8.html @@ -0,0 +1,88 @@ + + + +basic_stream_socket::basic_stream_socket (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_stream_socket on an existing + native socket. +

+
template<
+    typename ExecutionContext>
+basic_stream_socket(
+    ExecutionContext & context,
+    const protocol_type & protocol,
+    const native_handle_type & native_socket,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a stream socket object to hold an existing native + socket. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the socket + will use, by default, to dispatch handlers for any asynchronous + operations performed on the socket. +

+
protocol
+

+ An object specifying protocol parameters to be used. +

+
native_socket
+

+ The new underlying socket implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload9.html new file mode 100644 index 0000000..b9ddd17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/basic_stream_socket/overload9.html @@ -0,0 +1,68 @@ + + + +basic_stream_socket::basic_stream_socket (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_stream_socket from another. +

+
basic_stream_socket(
+    basic_stream_socket && other);
+
+

+ This constructor moves a stream socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind.html new file mode 100644 index 0000000..f67d29a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind.html @@ -0,0 +1,49 @@ + + + +basic_stream_socket::bind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bind the + socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+  » more...
+
+void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind/overload1.html new file mode 100644 index 0000000..fb611c3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind/overload1.html @@ -0,0 +1,84 @@ + + + +basic_stream_socket::bind (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind/overload2.html new file mode 100644 index 0000000..84e9a1d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bind/overload2.html @@ -0,0 +1,81 @@ + + + +basic_stream_socket::bind (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Bind the socket to the given local endpoint. +

+
void bind(
+    const endpoint_type & endpoint,
+    asio::error_code & ec);
+
+

+ This function binds the socket to the specified endpoint on the local + machine. +

+
+ + Parameters +
+
+

+
+
endpoint
+

+ An endpoint on the local machine to which the socket will be bound. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+asio::error_code ec;
+socket.bind(asio::ip::tcp::endpoint(
+      asio::ip::tcp::v4(), 12345), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/broadcast.html new file mode 100644 index 0000000..59a27bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/broadcast.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to permit sending of broadcast messages. +

+
typedef implementation_defined broadcast;
+
+

+ Implements the SOL_SOCKET/SO_BROADCAST socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bytes_readable.html new file mode 100644 index 0000000..6784915 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/bytes_readable.html @@ -0,0 +1,68 @@ + + + +basic_stream_socket::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +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. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::bytes_readable command(true);
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel.html new file mode 100644 index 0000000..9c352e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the socket. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel/overload1.html new file mode 100644 index 0000000..44e685d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel/overload1.html @@ -0,0 +1,105 @@ + + + +basic_stream_socket::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel/overload2.html new file mode 100644 index 0000000..1d56b6d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/cancel/overload2.html @@ -0,0 +1,106 @@ + + + +basic_stream_socket::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close.html new file mode 100644 index 0000000..4d01daf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the + socket. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close/overload1.html new file mode 100644 index 0000000..447ba92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close/overload1.html @@ -0,0 +1,71 @@ + + + +basic_stream_socket::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close();
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close/overload2.html new file mode 100644 index 0000000..5bb3e50 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/close/overload2.html @@ -0,0 +1,85 @@ + + + +basic_stream_socket::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Close the socket. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.close(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+ + Remarks +
+

+ For portable behaviour with respect to graceful closure of a connected + socket, call shutdown() before closing the socket. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect.html new file mode 100644 index 0000000..957070d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect.html @@ -0,0 +1,49 @@ + + + +basic_stream_socket::connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Connect + the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+  » more...
+
+void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect/overload1.html new file mode 100644 index 0000000..099aa91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect/overload1.html @@ -0,0 +1,90 @@ + + + +basic_stream_socket::connect (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+socket.connect(endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect/overload2.html new file mode 100644 index 0000000..36b061b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/connect/overload2.html @@ -0,0 +1,87 @@ + + + +basic_stream_socket::connect (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Connect the socket to the specified endpoint. +

+
void connect(
+    const endpoint_type & peer_endpoint,
+    asio::error_code & ec);
+
+

+ This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. +

+

+ The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. +

+
+ + Parameters +
+
+

+
+
peer_endpoint
+

+ The remote endpoint to which the socket will be connected. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::ip::tcp::endpoint endpoint(
+    asio::ip::address::from_string("1.2.3.4"), 12345);
+asio::error_code ec;
+socket.connect(endpoint, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/debug.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/debug.html new file mode 100644 index 0000000..11815c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/debug.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::debug + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to enable socket-level debugging. +

+
typedef implementation_defined debug;
+
+

+ Implements the SOL_SOCKET/SO_DEBUG socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/do_not_route.html new file mode 100644 index 0000000..1b56d17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/do_not_route.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to prevent routing, use local interfaces only. +

+
typedef implementation_defined do_not_route;
+
+

+ Implements the SOL_SOCKET/SO_DONTROUTE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/enable_connection_aborted.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/enable_connection_aborted.html new file mode 100644 index 0000000..d8c2fe0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/enable_connection_aborted.html @@ -0,0 +1,81 @@ + + + +basic_stream_socket::enable_connection_aborted + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to report aborted connections on accept. +

+
typedef implementation_defined enable_connection_aborted;
+
+

+ Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with asio::error::connection_aborted. + By default the option is false. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/endpoint_type.html new file mode 100644 index 0000000..cb1a814 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/endpoint_type.html @@ -0,0 +1,52 @@ + + + +basic_stream_socket::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef Protocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/executor_type.html new file mode 100644 index 0000000..50ffeff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_stream_socket::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_executor.html new file mode 100644 index 0000000..aa5549e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_executor.html @@ -0,0 +1,45 @@ + + + +basic_stream_socket::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option.html new file mode 100644 index 0000000..95a7cc9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option.html @@ -0,0 +1,53 @@ + + + +basic_stream_socket::get_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+  » more...
+
+template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option/overload1.html new file mode 100644 index 0000000..90df2fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option/overload1.html @@ -0,0 +1,89 @@ + + + +basic_stream_socket::get_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option/overload2.html new file mode 100644 index 0000000..a1efef2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/get_option/overload2.html @@ -0,0 +1,86 @@ + + + +basic_stream_socket::get_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get an option from the socket. +

+
template<
+    typename GettableSocketOption>
+void get_option(
+    GettableSocketOption & option,
+    asio::error_code & ec) const;
+
+

+ This function is used to get the current value of an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The option value to be obtained from the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::keep_alive option;
+asio::error_code ec;
+socket.get_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+bool is_set = option.value();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control.html new file mode 100644 index 0000000..2bd1925 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control.html @@ -0,0 +1,53 @@ + + + +basic_stream_socket::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control/overload1.html new file mode 100644 index 0000000..6d4dc10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control/overload1.html @@ -0,0 +1,89 @@ + + + +basic_stream_socket::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control/overload2.html new file mode 100644 index 0000000..4790235 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/io_control/overload2.html @@ -0,0 +1,86 @@ + + + +basic_stream_socket::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Perform an IO control command on the socket. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the socket. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::socket::bytes_readable command;
+asio::error_code ec;
+socket.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/is_open.html new file mode 100644 index 0000000..bc77384 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/is_open.html @@ -0,0 +1,45 @@ + + + +basic_stream_socket::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Determine + whether the socket is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/keep_alive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/keep_alive.html new file mode 100644 index 0000000..bc2fa71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/keep_alive.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::keep_alive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to send keep-alives. +

+
typedef implementation_defined keep_alive;
+
+

+ Implements the SOL_SOCKET/SO_KEEPALIVE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/linger.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/linger.html new file mode 100644 index 0000000..17a5291 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/linger.html @@ -0,0 +1,81 @@ + + + +basic_stream_socket::linger + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option to specify whether the socket lingers on close if unsent data is + present. +

+
typedef implementation_defined linger;
+
+

+ Implements the SOL_SOCKET/SO_LINGER socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option(true, 30);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option;
+socket.get_option(option);
+bool is_set = option.enabled();
+unsigned short timeout = option.timeout();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint.html new file mode 100644 index 0000000..4045d61 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::local_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+  » more...
+
+endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint/overload1.html new file mode 100644 index 0000000..6b646cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_stream_socket::local_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint() const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint/overload2.html new file mode 100644 index 0000000..fdc7213 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/local_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_stream_socket::local_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the local endpoint of the socket. +

+
endpoint_type local_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the locally bound endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the local endpoint of the socket. Returns a + default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer.html new file mode 100644 index 0000000..5a8e02b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_stream_socket::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer/overload1.html new file mode 100644 index 0000000..35283a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer/overload1.html @@ -0,0 +1,58 @@ + + + +basic_stream_socket::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ 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 basic_socket + cannot contain any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer/overload2.html new file mode 100644 index 0000000..4cdb92a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer/overload2.html @@ -0,0 +1,58 @@ + + + +basic_stream_socket::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_socket cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer_type.html new file mode 100644 index 0000000..ae2d25b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/lowest_layer_type.html @@ -0,0 +1,834 @@ + + + +basic_stream_socket::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +A + basic_socket + is always the lowest layer. +

+
typedef basic_socket< Protocol, Executor > lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_socket [constructor] +

+ 		+

+ Construct a basic_socket without opening it.
—
Construct + and open a basic_socket.
—
Construct a basic_socket, + opening it and binding it to the given local endpoint.
+ —
Construct a basic_socket on an existing native socket. +
—
Move-construct a basic_socket from another.
+ —
Move-construct a basic_socket from a socket of another + protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket from another.
—
Move-assign + a basic_socket from a socket of another protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_socket [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/max_listen_connections.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/max_listen_connections.html new file mode 100644 index 0000000..6070c4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/max_listen_connections.html @@ -0,0 +1,45 @@ + + + +basic_stream_socket::max_listen_connections + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +The + maximum length of the queue of pending incoming connections. +

+
static const int max_listen_connections = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_do_not_route.html new file mode 100644 index 0000000..a0c606f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_do_not_route.html @@ -0,0 +1,45 @@ + + + +basic_stream_socket::message_do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specify + that the data should not be subject to routing. +

+
static const int message_do_not_route = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_end_of_record.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_end_of_record.html new file mode 100644 index 0000000..7dd6e7a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_end_of_record.html @@ -0,0 +1,45 @@ + + + +basic_stream_socket::message_end_of_record + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Specifies + that the data marks the end of a record. +

+
static const int message_end_of_record = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_flags.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_flags.html new file mode 100644 index 0000000..93c45dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_flags.html @@ -0,0 +1,55 @@ + + + +basic_stream_socket::message_flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Bitmask + type for flags that can be passed to send and receive operations. +

+
typedef int message_flags;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_out_of_band.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_out_of_band.html new file mode 100644 index 0000000..0ef3d17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_out_of_band.html @@ -0,0 +1,45 @@ + + + +basic_stream_socket::message_out_of_band + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Process + out-of-band data. +

+
static const int message_out_of_band = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_peek.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_peek.html new file mode 100644 index 0000000..0786418 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/message_peek.html @@ -0,0 +1,45 @@ + + + +basic_stream_socket::message_peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Peek + at incoming data without removing it from the input queue. +

+
static const int message_peek = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_handle.html new file mode 100644 index 0000000..907d24b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_handle.html @@ -0,0 +1,50 @@ + + + +basic_stream_socket::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ +Get + the native socket representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + socket. This is intended to allow access to native socket functionality + that is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_handle_type.html new file mode 100644 index 0000000..f0dfc6a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_stream_socket::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a socket. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking.html new file mode 100644 index 0000000..e9bf55b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_stream_socket::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload1.html new file mode 100644 index 0000000..524a6c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload1.html @@ -0,0 +1,144 @@ + + + +basic_stream_socket::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the native socket implementation. +

+
bool native_non_blocking() const;
+
+

+ This function is used to retrieve the non-blocking mode of the underlying + native socket. This mode has no effect on the behaviour of the socket + object's synchronous operations. +

+
+ + Return + Value +
+

+ true if the underlying socket + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + Remarks +
+

+ The current non-blocking mode is cached by the socket object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native socket. +

+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload2.html new file mode 100644 index 0000000..8d68a5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload2.html @@ -0,0 +1,159 @@ + + + +basic_stream_socket::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload3.html new file mode 100644 index 0000000..be42601 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/native_non_blocking/overload3.html @@ -0,0 +1,150 @@ + + + +basic_stream_socket::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the native socket implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+

+ This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + socket is put into non-blocking mode and direct system calls may + fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+ + Example +
+

+ This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's sendfile system + call might be encapsulated: +

+
template <typename Handler>
+struct sendfile_op
+{
+  tcp::socket& sock_;
+  int fd_;
+  Handler handler_;
+  off_t offset_;
+  std::size_t total_bytes_transferred_;
+
+  // Function call operator meeting WriteHandler requirements.
+  // Used as the handler for the async_write_some operation.
+  void operator()(asio::error_code ec, std::size_t)
+  {
+    // Put the underlying socket into non-blocking mode.
+    if (!ec)
+      if (!sock_.native_non_blocking())
+        sock_.native_non_blocking(true, ec);
+
+    if (!ec)
+    {
+      for (;;)
+      {
+        // Try the system call.
+        errno = 0;
+        int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
+        ec = asio::error_code(n < 0 ? errno : 0,
+            asio::error::get_system_category());
+        total_bytes_transferred_ += ec ? 0 : n;
+
+        // Retry operation immediately if interrupted by signal.
+        if (ec == asio::error::interrupted)
+          continue;
+
+        // Check if we need to run the operation again.
+        if (ec == asio::error::would_block
+            || ec == asio::error::try_again)
+        {
+          // We have to wait for the socket to become ready again.
+          sock_.async_wait(tcp::socket::wait_write, *this);
+          return;
+        }
+
+        if (ec || n == 0)
+        {
+          // An error occurred, or we have reached the end of the file.
+          // Either way we must exit the loop so we can call the handler.
+          break;
+        }
+
+        // Loop around to try calling sendfile again.
+      }
+    }
+
+    // Pass result back to user's handler.
+    handler_(ec, total_bytes_transferred_);
+  }
+};
+
+template <typename Handler>
+void async_sendfile(tcp::socket& sock, int fd, Handler h)
+{
+  sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
+  sock.async_wait(tcp::socket::wait_write, op);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking.html new file mode 100644 index 0000000..896e8fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking.html @@ -0,0 +1,55 @@ + + + +basic_stream_socket::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the socket. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload1.html new file mode 100644 index 0000000..db0f8c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload1.html @@ -0,0 +1,64 @@ + + + +basic_stream_socket::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Gets the non-blocking mode of the socket. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the socket's synchronous + operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload2.html new file mode 100644 index 0000000..df528df --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload2.html @@ -0,0 +1,83 @@ + + + +basic_stream_socket::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload3.html new file mode 100644 index 0000000..d8961bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/non_blocking/overload3.html @@ -0,0 +1,75 @@ + + + +basic_stream_socket::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Sets the non-blocking mode of the socket. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the socket's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open.html new file mode 100644 index 0000000..59f88ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open.html @@ -0,0 +1,49 @@ + + + +basic_stream_socket::open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the + socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+  » more...
+
+void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open/overload1.html new file mode 100644 index 0000000..e5aade5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open/overload1.html @@ -0,0 +1,81 @@ + + + +basic_stream_socket::open (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol = protocol_type());
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying protocol parameters to be used. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+socket.open(asio::ip::tcp::v4());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open/overload2.html new file mode 100644 index 0000000..4644b42 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/open/overload2.html @@ -0,0 +1,78 @@ + + + +basic_stream_socket::open (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Open the socket using the specified protocol. +

+
void open(
+    const protocol_type & protocol,
+    asio::error_code & ec);
+
+

+ This function opens the socket so that it will use the specified protocol. +

+
+ + Parameters +
+
+

+
+
protocol
+

+ An object specifying which protocol is to be used. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+asio::error_code ec;
+socket.open(asio::ip::tcp::v4(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_.html new file mode 100644 index 0000000..ee9aa5e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_.html @@ -0,0 +1,56 @@ + + + +basic_stream_socket::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_stream_socket + from another. +

+
basic_stream_socket & operator=(
+    basic_stream_socket && other);
+  » more...
+
+

+ Move-assign a basic_stream_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_stream_socket & > operator=(
+    basic_stream_socket< Protocol1, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_/overload1.html new file mode 100644 index 0000000..7eac848 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_stream_socket::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_stream_socket from another. +

+
basic_stream_socket & operator=(
+    basic_stream_socket && other);
+
+

+ This assignment operator moves a stream socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_/overload2.html new file mode 100644 index 0000000..93b2a46 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +basic_stream_socket::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_stream_socket from a socket + of another protocol type. +

+
template<
+    typename Protocol1,
+    typename Executor1>
+constraint_t< is_convertible< Protocol1, Protocol >::value &&is_convertible< Executor1, Executor >::value, basic_stream_socket & > operator=(
+    basic_stream_socket< Protocol1, Executor1 > && other);
+
+

+ This assignment operator moves a stream socket from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_stream_socket object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_socket(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/out_of_band_inline.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/out_of_band_inline.html new file mode 100644 index 0000000..2408d97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/out_of_band_inline.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::out_of_band_inline + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for putting received out-of-band data inline. +

+
typedef implementation_defined out_of_band_inline;
+
+

+ Implements the SOL_SOCKET/SO_OOBINLINE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option;
+socket.get_option(option);
+bool value = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/protocol_type.html new file mode 100644 index 0000000..1819ead --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/protocol_type.html @@ -0,0 +1,52 @@ + + + +basic_stream_socket::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some.html new file mode 100644 index 0000000..9c2f5fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some.html @@ -0,0 +1,53 @@ + + + +basic_stream_socket::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some/overload1.html new file mode 100644 index 0000000..8e2e1af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some/overload1.html @@ -0,0 +1,108 @@ + + + +basic_stream_socket::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to read data from the stream socket. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
socket.read_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some/overload2.html new file mode 100644 index 0000000..ff35365 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/read_some/overload2.html @@ -0,0 +1,85 @@ + + + +basic_stream_socket::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to read data from the stream socket. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive.html new file mode 100644 index 0000000..9a5facc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive.html @@ -0,0 +1,64 @@ + + + +basic_stream_socket::receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Receive + some data on the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags);
+  » more...
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload1.html new file mode 100644 index 0000000..bb0226b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload1.html @@ -0,0 +1,108 @@ + + + +basic_stream_socket::receive (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to receive data on the stream socket. The function + call will block until one or more bytes of data has been received successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The receive operation may not receive all of the requested number of + bytes. Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.receive(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload2.html new file mode 100644 index 0000000..9dccb80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload2.html @@ -0,0 +1,113 @@ + + + +basic_stream_socket::receive (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on the socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags);
+
+

+ This function is used to receive data on the stream socket. The function + call will block until one or more bytes of data has been received successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The receive operation may not receive all of the requested number of + bytes. Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To receive into a single data buffer use the buffer function as follows: +

+
socket.receive(asio::buffer(data, size), 0);
+
+

+ See the buffer + documentation for information on receiving into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload3.html new file mode 100644 index 0000000..c1d1f9a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive/overload3.html @@ -0,0 +1,90 @@ + + + +basic_stream_socket::receive (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Receive some data on a connected socket. +

+
template<
+    typename MutableBufferSequence>
+std::size_t receive(
+    const MutableBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to receive data on the stream socket. The function + call will block until one or more bytes of data has been received successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be received. +

+
flags
+

+ Flags specifying how the receive call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes received. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The receive operation may not receive all of the requested number of + bytes. Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive_buffer_size.html new file mode 100644 index 0000000..1b30541 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::receive_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive buffer size of a socket. +

+
typedef implementation_defined receive_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_RCVBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive_low_watermark.html new file mode 100644 index 0000000..9f0644f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/receive_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::receive_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the receive low watermark. +

+
typedef implementation_defined receive_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_RCVLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release.html new file mode 100644 index 0000000..6032e5a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native socket. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release/overload1.html new file mode 100644 index 0000000..56e4959 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release/overload1.html @@ -0,0 +1,72 @@ + + + +basic_stream_socket::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release/overload2.html new file mode 100644 index 0000000..928b68a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/release/overload2.html @@ -0,0 +1,73 @@ + + + +basic_stream_socket::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Release ownership of the underlying native socket. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the asio::error::operation_aborted + error. Ownership of the native socket is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint.html new file mode 100644 index 0000000..a92c530 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint.html @@ -0,0 +1,47 @@ + + + +basic_stream_socket::remote_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+  » more...
+
+endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint/overload1.html new file mode 100644 index 0000000..0dfc2d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint/overload1.html @@ -0,0 +1,76 @@ + + + +basic_stream_socket::remote_endpoint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint() const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint/overload2.html new file mode 100644 index 0000000..bde3ebc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/remote_endpoint/overload2.html @@ -0,0 +1,83 @@ + + + +basic_stream_socket::remote_endpoint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Get the remote endpoint of the socket. +

+
endpoint_type remote_endpoint(
+    asio::error_code & ec) const;
+
+

+ This function is used to obtain the remote endpoint of the socket. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ An object that represents the remote endpoint of the socket. Returns + a default-constructed endpoint object if an error occurred. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/reuse_address.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/reuse_address.html new file mode 100644 index 0000000..26232a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/reuse_address.html @@ -0,0 +1,80 @@ + + + +basic_stream_socket::reuse_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from 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. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send.html new file mode 100644 index 0000000..2a046ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send.html @@ -0,0 +1,61 @@ + + + +basic_stream_socket::send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Send some + data on the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload1.html new file mode 100644 index 0000000..44962b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload1.html @@ -0,0 +1,107 @@ + + + +basic_stream_socket::send (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to send data on the stream socket. The function + call will block until one or more bytes of the data has been sent successfully, + or an until error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The send operation may not transmit all of the data to the peer. Consider + using the write + function if you need to ensure that all data is written before the blocking + operation completes. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.send(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload2.html new file mode 100644 index 0000000..458938c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload2.html @@ -0,0 +1,112 @@ + + + +basic_stream_socket::send (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags);
+
+

+ This function is used to send data on the stream socket. The function + call will block until one or more bytes of the data has been sent successfully, + or an until error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The send operation may not transmit all of the data to the peer. Consider + using the write + function if you need to ensure that all data is written before the blocking + operation completes. +

+
+ + Example +
+

+ To send a single data buffer use the buffer function as follows: +

+
socket.send(asio::buffer(data, size), 0);
+
+

+ See the buffer + documentation for information on sending multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload3.html new file mode 100644 index 0000000..30e6fda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send/overload3.html @@ -0,0 +1,90 @@ + + + +basic_stream_socket::send (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Send some data on the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t send(
+    const ConstBufferSequence & buffers,
+    socket_base::message_flags flags,
+    asio::error_code & ec);
+
+

+ This function is used to send data on the stream socket. The function + call will block until one or more bytes of the data has been sent successfully, + or an until error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be sent on the socket. +

+
flags
+

+ Flags specifying how the send call is to be made. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes sent. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The send operation may not transmit all of the data to the peer. Consider + using the write + function if you need to ensure that all data is written before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send_buffer_size.html new file mode 100644 index 0000000..f969d72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send_buffer_size.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::send_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send buffer size of a socket. +

+
typedef implementation_defined send_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_SNDBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send_low_watermark.html new file mode 100644 index 0000000..8e0e9f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/send_low_watermark.html @@ -0,0 +1,79 @@ + + + +basic_stream_socket::send_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Socket + option for the send low watermark. +

+
typedef implementation_defined send_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_SNDLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option.html new file mode 100644 index 0000000..82fd49d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option.html @@ -0,0 +1,53 @@ + + + +basic_stream_socket::set_option + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+  » more...
+
+template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option/overload1.html new file mode 100644 index 0000000..8f7acf9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option/overload1.html @@ -0,0 +1,88 @@ + + + +basic_stream_socket::set_option (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+socket.set_option(option);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option/overload2.html new file mode 100644 index 0000000..9387a59 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/set_option/overload2.html @@ -0,0 +1,85 @@ + + + +basic_stream_socket::set_option (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Set an option on the socket. +

+
template<
+    typename SettableSocketOption>
+void set_option(
+    const SettableSocketOption & option,
+    asio::error_code & ec);
+
+

+ This function is used to set an option on the socket. +

+
+ + Parameters +
+
+

+
+
option
+

+ The new option value to be set on the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Setting the IPPROTO_TCP/TCP_NODELAY option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+asio::error_code ec;
+socket.set_option(option, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown.html new file mode 100644 index 0000000..e3d345f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown.html @@ -0,0 +1,49 @@ + + + +basic_stream_socket::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+  » more...
+
+void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown/overload1.html new file mode 100644 index 0000000..b66f4fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown/overload1.html @@ -0,0 +1,86 @@ + + + +basic_stream_socket::shutdown (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.shutdown(asio::ip::tcp::socket::shutdown_send);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown/overload2.html new file mode 100644 index 0000000..494ef9d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown/overload2.html @@ -0,0 +1,83 @@ + + + +basic_stream_socket::shutdown (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Disable sends or receives on the socket. +

+
void shutdown(
+    shutdown_type what,
+    asio::error_code & ec);
+
+

+ This function is used to disable send operations, receive operations, + or both. +

+
+ + Parameters +
+
+

+
+
what
+

+ Determines what types of operation will no longer be allowed. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Shutting down the send side of the socket: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.shutdown(asio::ip::tcp::socket::shutdown_send, ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown_type.html new file mode 100644 index 0000000..b7d975e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/shutdown_type.html @@ -0,0 +1,71 @@ + + + +basic_stream_socket::shutdown_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Different + ways a socket may be shutdown. +

+
enum shutdown_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
shutdown_receive
+

+ Shutdown the receive side of the socket. +

+
shutdown_send
+

+ Shutdown the send side of the socket. +

+
shutdown_both
+

+ Shutdown both send and receive on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait.html new file mode 100644 index 0000000..7144f03 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait.html @@ -0,0 +1,50 @@ + + + +basic_stream_socket::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait for + the socket to become ready to read, ready to write, or to have pending + error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait/overload1.html new file mode 100644 index 0000000..9809b25 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait/overload1.html @@ -0,0 +1,74 @@ + + + +basic_stream_socket::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+socket.wait(asio::ip::tcp::socket::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait/overload2.html new file mode 100644 index 0000000..26eb449 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait/overload2.html @@ -0,0 +1,80 @@ + + + +basic_stream_socket::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Wait for the socket to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for a socket to enter + a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired socket state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for a socket to become readable. +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::error_code ec;
+socket.wait(asio::ip::tcp::socket::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait_type.html new file mode 100644 index 0000000..563e58f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/wait_type.html @@ -0,0 +1,74 @@ + + + +basic_stream_socket::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from socket_base. +

+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a socket to become ready to read. +

+
wait_write
+

+ Wait for a socket to become ready to write. +

+
wait_error
+

+ Wait for a socket to have error conditions pending. +

+
+
+

+ For use with basic_socket::wait() and basic_socket::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some.html new file mode 100644 index 0000000..be00db6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some.html @@ -0,0 +1,53 @@ + + + +basic_stream_socket::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some/overload1.html new file mode 100644 index 0000000..59aecc5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some/overload1.html @@ -0,0 +1,107 @@ + + + +basic_stream_socket::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write data to the stream socket. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the socket. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
socket.write_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some/overload2.html new file mode 100644 index 0000000..afd38f8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket/write_some/overload2.html @@ -0,0 +1,84 @@ + + + +basic_stream_socket::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the socket. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write data to the stream socket. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the socket. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket__rebind_executor.html new file mode 100644 index 0000000..2d1ef7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_stream_socket::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the socket type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The socket type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket__rebind_executor/other.html new file mode 100644 index 0000000..72d28dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_stream_socket__rebind_executor/other.html @@ -0,0 +1,915 @@ + + + +basic_stream_socket::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + socket type when rebound to the specified executor. +

+
typedef basic_stream_socket< Protocol, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_stream_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_stream_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_socket from another.
—
+ Move-assign a basic_stream_socket from a socket of another protocol + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the socket. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the socket. +

+
+

+ ~basic_stream_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_stream_socket + class template provides asynchronous and blocking stream-oriented socket + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single socket object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/basic_stream_socket.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf.html new file mode 100644 index 0000000..8e110f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf.html @@ -0,0 +1,368 @@ + + + +basic_streambuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Automatically resizable buffer class based on std::streambuf. +

+
template<
+    typename Allocator = std::allocator<char>>
+class basic_streambuf :
+  public std::streambuf,
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffers_type +

+ 		+

+ The type used to represent the input sequence as a list of buffers. +

+
+

+ mutable_buffers_type +

+ 		+

+ The type used to represent the output sequence as a list of buffers. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_streambuf [constructor] +

+ 		+

+ Construct a basic_streambuf object. +

+
+

+ capacity +

+ 		+

+ Get the current capacity of the basic_streambuf. +

+
+

+ commit +

+ 		+

+ Move characters from the output sequence to the input sequence. +

+
+

+ consume +

+ 		+

+ Remove characters from the input sequence. +

+
+

+ data +

+ 		+

+ Get a list of buffers that represents the input sequence. +

+
+

+ max_size +

+ 		+

+ Get the maximum size of the basic_streambuf. +

+
+

+ prepare +

+ 		+

+ Get a list of buffers that represents the output sequence, with + the given size. +

+
+

+ size +

+ 		+

+ Get the size of the input sequence. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ overflow +

+ 		+

+ Override std::streambuf behaviour. +

+
+

+ reserve +

+ 		+
+

+ 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: +

+
    +
  • + 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 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. +

+
+ + Examples +
+

+ Writing directly from an streambuf to a socket: +

+
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: +

+
asio::streambuf b;
+
+// reserve 512 bytes in output sequence
+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;
+
+
+ + Requirements +
+

+ Header: asio/basic_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/basic_streambuf.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/basic_streambuf.html new file mode 100644 index 0000000..c84346f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/basic_streambuf.html @@ -0,0 +1,49 @@ + + + +basic_streambuf::basic_streambuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_streambuf + object. +

+
basic_streambuf(
+    std::size_t maximum_size = (std::numeric_limits< std::size_t >::max)(),
+    const Allocator & allocator = Allocator());
+
+

+ Constructs a streambuf with the specified maximum size. The initial size + of the streambuf's input sequence is 0. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/capacity.html new file mode 100644 index 0000000..8dcee96 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/capacity.html @@ -0,0 +1,50 @@ + + + +basic_streambuf::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the current + capacity of the basic_streambuf. +

+
std::size_t capacity() const;
+
+
+ + Return Value +
+

+ The current total capacity of the streambuf, i.e. for both the input sequence + and output sequence. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/commit.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/commit.html new file mode 100644 index 0000000..e824a0b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/commit.html @@ -0,0 +1,64 @@ + + + +basic_streambuf::commit + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move characters + from the output sequence to the input sequence. +

+
void commit(
+    std::size_t n);
+
+

+ Appends n characters from + the start of the output sequence to the input sequence. The beginning of + the output sequence is advanced by n + characters. +

+

+ Requires a preceding call prepare(x) + where x >= + n, and no intervening operations + that modify the input or output sequence. +

+
+ + Remarks +
+

+ If n is greater than the + size of the output sequence, the entire output sequence is moved to the + input sequence and no error is issued. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/const_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/const_buffers_type.html new file mode 100644 index 0000000..3baa0c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/const_buffers_type.html @@ -0,0 +1,52 @@ + + + +basic_streambuf::const_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent the input sequence as a list of buffers. +

+
typedef implementation_defined const_buffers_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/consume.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/consume.html new file mode 100644 index 0000000..6b342a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/consume.html @@ -0,0 +1,56 @@ + + + +basic_streambuf::consume + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Remove characters + from the input sequence. +

+
void consume(
+    std::size_t n);
+
+

+ Removes n characters from + the beginning of the input sequence. +

+
+ + Remarks +
+

+ If n is greater than the + size of the input sequence, the entire input sequence is consumed and no + error is issued. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/data.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/data.html new file mode 100644 index 0000000..69f7652 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/data.html @@ -0,0 +1,60 @@ + + + +basic_streambuf::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a list of buffers + that represents the input sequence. +

+
const_buffers_type data() const;
+
+
+ + Return + Value +
+

+ An object of type const_buffers_type + that satisfies ConstBufferSequence requirements, representing all character + arrays in the input sequence. +

+
+ + Remarks +
+

+ The returned object is invalidated by any basic_streambuf + member function that modifies the input sequence or output sequence. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/max_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/max_size.html new file mode 100644 index 0000000..28f1c32 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/max_size.html @@ -0,0 +1,50 @@ + + + +basic_streambuf::max_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the maximum + size of the basic_streambuf. +

+
std::size_t max_size() const;
+
+
+ + Return Value +
+

+ The allowed maximum of the sum of the sizes of the input sequence and output + sequence. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/mutable_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/mutable_buffers_type.html new file mode 100644 index 0000000..4ccd602 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/mutable_buffers_type.html @@ -0,0 +1,52 @@ + + + +basic_streambuf::mutable_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent the output sequence as a list of buffers. +

+
typedef implementation_defined mutable_buffers_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/overflow.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/overflow.html new file mode 100644 index 0000000..30cc9ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/overflow.html @@ -0,0 +1,47 @@ + + + +basic_streambuf::overflow + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Override + std::streambuf behaviour. +

+
int_type overflow(
+    int_type c);
+
+

+ Behaves according to the specification of std::streambuf::overflow(), with the specialisation that std::length_error is thrown if appending the + character to the input sequence would require the condition size() > max_size() to be true. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/prepare.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/prepare.html new file mode 100644 index 0000000..f0151f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/prepare.html @@ -0,0 +1,80 @@ + + + +basic_streambuf::prepare + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a list + of buffers that represents the output sequence, with the given size. +

+
mutable_buffers_type prepare(
+    std::size_t n);
+
+

+ Ensures that the output sequence can accommodate n + characters, reallocating character array objects as necessary. +

+
+ + Return Value +
+

+ An object of type mutable_buffers_type + that satisfies MutableBufferSequence requirements, representing character + array objects at the start of the output sequence such that the sum of + the buffer sizes is n. +

+
+ + Exceptions +
+
+

+
+
std::length_error
+

+ If size() + + n + > max_size(). +

+
+
+
+ + Remarks +
+

+ The returned object is invalidated by any basic_streambuf + member function that modifies the input sequence or output sequence. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/reserve.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/reserve.html new file mode 100644 index 0000000..e0e27da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/reserve.html @@ -0,0 +1,41 @@ + + + +basic_streambuf::reserve + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void reserve(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/size.html new file mode 100644 index 0000000..cfe849a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/size.html @@ -0,0 +1,60 @@ + + + +basic_streambuf::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the size of the + input sequence. +

+
std::size_t size() const;
+
+
+ + Return + Value +
+

+ The size of the input sequence. The value is equal to that calculated for + s in the following code: +

+
size_t s = 0;
+const_buffers_type bufs = data();
+const_buffers_type::const_iterator i = bufs.begin();
+while (i != bufs.end())
+{
+  const_buffer buf(*i++);
+  s += buf.size();
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/underflow.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/underflow.html new file mode 100644 index 0000000..dc4f5fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf/underflow.html @@ -0,0 +1,45 @@ + + + +basic_streambuf::underflow + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Override + std::streambuf behaviour. +

+
int_type underflow();
+
+

+ Behaves according to the specification of std::streambuf::underflow(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref.html new file mode 100644 index 0000000..7cfab06 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref.html @@ -0,0 +1,228 @@ + + + +basic_streambuf_ref + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts basic_streambuf + to the dynamic buffer sequence type requirements. +

+
template<
+    typename Allocator = std::allocator<char>>
+class basic_streambuf_ref
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffers_type +

+ 		+

+ The type used to represent the input sequence as a list of buffers. +

+
+

+ mutable_buffers_type +

+ 		+

+ The type used to represent the output sequence as a list of buffers. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_streambuf_ref [constructor] +

+ 		+

+ Construct a basic_streambuf_ref for the given basic_streambuf object. +
—
Copy construct a basic_streambuf_ref.
—
+ Move construct a basic_streambuf_ref. +

+
+

+ capacity +

+ 		+

+ Get the current capacity of the dynamic buffer. +

+
+

+ commit +

+ 		+

+ Move bytes from the output sequence to the input sequence. +

+
+

+ consume +

+ 		+

+ Remove characters from the input sequence. +

+
+

+ data +

+ 		+

+ Get a list of buffers that represents the input sequence. +

+
+

+ max_size +

+ 		+

+ Get the maximum size of the dynamic buffer. +

+
+

+ prepare +

+ 		+

+ Get a list of buffers that represents the output sequence, with + the given size. +

+
+

+ size +

+ 		+

+ Get the size of the input sequence. +

+
+
+ + Requirements +
+

+ Header: asio/basic_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref.html new file mode 100644 index 0000000..ea9381e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref.html @@ -0,0 +1,59 @@ + + + +basic_streambuf_ref::basic_streambuf_ref + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_streambuf_ref + for the given basic_streambuf object. +

+
explicit basic_streambuf_ref(
+    basic_streambuf< Allocator > & sb);
+  » more...
+
+

+ Copy construct a basic_streambuf_ref. +

+
basic_streambuf_ref(
+    const basic_streambuf_ref & other);
+  » more...
+
+

+ Move construct a basic_streambuf_ref. +

+
basic_streambuf_ref(
+    basic_streambuf_ref && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload1.html new file mode 100644 index 0000000..67dc8a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload1.html @@ -0,0 +1,44 @@ + + + +basic_streambuf_ref::basic_streambuf_ref (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_streambuf_ref for the + given basic_streambuf + object. +

+
basic_streambuf_ref(
+    basic_streambuf< Allocator > & sb);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload2.html new file mode 100644 index 0000000..e8b3f28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload2.html @@ -0,0 +1,42 @@ + + + +basic_streambuf_ref::basic_streambuf_ref (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy construct a basic_streambuf_ref. +

+
basic_streambuf_ref(
+    const basic_streambuf_ref & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload3.html new file mode 100644 index 0000000..6690097 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/basic_streambuf_ref/overload3.html @@ -0,0 +1,42 @@ + + + +basic_streambuf_ref::basic_streambuf_ref (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct a basic_streambuf_ref. +

+
basic_streambuf_ref(
+    basic_streambuf_ref && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/capacity.html new file mode 100644 index 0000000..2d69092 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/capacity.html @@ -0,0 +1,42 @@ + + + +basic_streambuf_ref::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the current capacity of the dynamic buffer. +

+
std::size_t capacity() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/commit.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/commit.html new file mode 100644 index 0000000..8618756 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/commit.html @@ -0,0 +1,43 @@ + + + +basic_streambuf_ref::commit + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move + bytes from the output sequence to the input sequence. +

+
void commit(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/const_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/const_buffers_type.html new file mode 100644 index 0000000..8beba21 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/const_buffers_type.html @@ -0,0 +1,363 @@ + + + +basic_streambuf_ref::const_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent the input sequence as a list of buffers. +

+
typedef basic_streambuf< Allocator >::const_buffers_type const_buffers_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffers_type +

+ 		+

+ The type used to represent the input sequence as a list of buffers. +

+
+

+ mutable_buffers_type +

+ 		+

+ The type used to represent the output sequence as a list of buffers. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_streambuf [constructor] +

+ 		+

+ Construct a basic_streambuf object. +

+
+

+ capacity +

+ 		+

+ Get the current capacity of the basic_streambuf. +

+
+

+ commit +

+ 		+

+ Move characters from the output sequence to the input sequence. +

+
+

+ consume +

+ 		+

+ Remove characters from the input sequence. +

+
+

+ data +

+ 		+

+ Get a list of buffers that represents the input sequence. +

+
+

+ max_size +

+ 		+

+ Get the maximum size of the basic_streambuf. +

+
+

+ prepare +

+ 		+

+ Get a list of buffers that represents the output sequence, with + the given size. +

+
+

+ size +

+ 		+

+ Get the size of the input sequence. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ overflow +

+ 		+

+ Override std::streambuf behaviour. +

+
+

+ reserve +

+ 		+
+

+ 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: +

+
    +
  • + 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 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. +

+
+ + Examples +
+

+ Writing directly from an streambuf to a socket: +

+
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: +

+
asio::streambuf b;
+
+// reserve 512 bytes in output sequence
+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;
+
+
+ + Requirements +
+

+ Header: asio/basic_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/consume.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/consume.html new file mode 100644 index 0000000..918bc6b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/consume.html @@ -0,0 +1,43 @@ + + + +basic_streambuf_ref::consume + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Remove + characters from the input sequence. +

+
void consume(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/data.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/data.html new file mode 100644 index 0000000..4198af3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/data.html @@ -0,0 +1,42 @@ + + + +basic_streambuf_ref::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a list + of buffers that represents the input sequence. +

+
const_buffers_type data() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/max_size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/max_size.html new file mode 100644 index 0000000..ed19de3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/max_size.html @@ -0,0 +1,42 @@ + + + +basic_streambuf_ref::max_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the maximum size of the dynamic buffer. +

+
std::size_t max_size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/mutable_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/mutable_buffers_type.html new file mode 100644 index 0000000..ba2ac37 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/mutable_buffers_type.html @@ -0,0 +1,363 @@ + + + +basic_streambuf_ref::mutable_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent the output sequence as a list of buffers. +

+
typedef basic_streambuf< Allocator >::mutable_buffers_type mutable_buffers_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffers_type +

+ 		+

+ The type used to represent the input sequence as a list of buffers. +

+
+

+ mutable_buffers_type +

+ 		+

+ The type used to represent the output sequence as a list of buffers. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_streambuf [constructor] +

+ 		+

+ Construct a basic_streambuf object. +

+
+

+ capacity +

+ 		+

+ Get the current capacity of the basic_streambuf. +

+
+

+ commit +

+ 		+

+ Move characters from the output sequence to the input sequence. +

+
+

+ consume +

+ 		+

+ Remove characters from the input sequence. +

+
+

+ data +

+ 		+

+ Get a list of buffers that represents the input sequence. +

+
+

+ max_size +

+ 		+

+ Get the maximum size of the basic_streambuf. +

+
+

+ prepare +

+ 		+

+ Get a list of buffers that represents the output sequence, with + the given size. +

+
+

+ size +

+ 		+

+ Get the size of the input sequence. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ overflow +

+ 		+

+ Override std::streambuf behaviour. +

+
+

+ reserve +

+ 		+
+

+ 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: +

+
    +
  • + 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 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. +

+
+ + Examples +
+

+ Writing directly from an streambuf to a socket: +

+
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: +

+
asio::streambuf b;
+
+// reserve 512 bytes in output sequence
+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;
+
+
+ + Requirements +
+

+ Header: asio/basic_streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/prepare.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/prepare.html new file mode 100644 index 0000000..28270a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/prepare.html @@ -0,0 +1,43 @@ + + + +basic_streambuf_ref::prepare + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a list of buffers that represents the output sequence, with the given size. +

+
mutable_buffers_type prepare(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/size.html b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/size.html new file mode 100644 index 0000000..aa5a6d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_streambuf_ref/size.html @@ -0,0 +1,42 @@ + + + +basic_streambuf_ref::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the size + of the input sequence. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor.html new file mode 100644 index 0000000..19c42d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor.html @@ -0,0 +1,279 @@ + + + +basic_system_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An executor that uses arbitrary threads. +

+
template<
+    typename Blocking,
+    typename Relationship,
+    typename Allocator>
+class basic_system_executor
+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_system_executor [constructor] +

+ 		+

+ Default constructor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Execution function. +

+
+

+ on_work_finished +

+ 		+

+ Inform the executor that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the executor that it has some outstanding work to do. +

+
+

+ post +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ query +

+ 		+

+ Query the current value of the allocator property.
—
+ Query the occupancy (recommended number of work items) for the + system context. +

+
+

+ query [static] +

+ 		+

+ Query the current value of the mapping property.
—
+ Query the current value of the context property.
—
+ Query the current value of the blocking property.
—
+ Query the current value of the relationship property. +

+
+

+ require +

+ 		+

+ Obtain an executor with the blocking.possibly property.
+ —
Obtain an executor with the blocking.always property.
+ —
Obtain an executor with the blocking.never property.
+ —
Obtain an executor with the relationship.continuation property. +
—
Obtain an executor with the relationship.fork property. +
—
Obtain an executor with the specified allocator property. +
—
Obtain an executor with the default allocator property. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+

+ The system executor represents an execution context where functions are permitted + to run on arbitrary threads. When the blocking.never property is established, + the system executor will schedule the function to run on an unspecified system + thread pool. When either blocking.possibly or blocking.always is established, + the executor invokes the function immediately. +

+
+ + Requirements +
+

+ Header: asio/system_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/basic_system_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/basic_system_executor.html new file mode 100644 index 0000000..29e2ee4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/basic_system_executor.html @@ -0,0 +1,42 @@ + + + +basic_system_executor::basic_system_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
basic_system_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/context.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/context.html new file mode 100644 index 0000000..fcca09a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/context.html @@ -0,0 +1,42 @@ + + + +basic_system_executor::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the underlying execution context. +

+
system_context & context() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/defer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/defer.html new file mode 100644 index 0000000..c6b2a57 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/defer.html @@ -0,0 +1,76 @@ + + + +basic_system_executor::defer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the system executor to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void defer(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object will never be executed inside this function. + Instead, it will be scheduled to run on an unspecified system thread pool. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/dispatch.html new file mode 100644 index 0000000..4f40bf6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/dispatch.html @@ -0,0 +1,75 @@ + + + +basic_system_executor::dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the system executor to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void dispatch(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object will always be executed inside this function. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/execute.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/execute.html new file mode 100644 index 0000000..fb96b65 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/execute.html @@ -0,0 +1,45 @@ + + + +basic_system_executor::execute + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Execution + function. +

+
template<
+    typename Function>
+void execute(
+    Function && f) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/on_work_finished.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/on_work_finished.html new file mode 100644 index 0000000..62c01f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/on_work_finished.html @@ -0,0 +1,45 @@ + + + +basic_system_executor::on_work_finished + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the executor that some work is no longer outstanding. +

+
void on_work_finished() const;
+
+

+ For the system executor, this is a no-op. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/on_work_started.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/on_work_started.html new file mode 100644 index 0000000..25e8e1c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/on_work_started.html @@ -0,0 +1,45 @@ + + + +basic_system_executor::on_work_started + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the executor that it has some outstanding work to do. +

+
void on_work_started() const;
+
+

+ For the system executor, this is a no-op. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/operator_eq__eq_.html new file mode 100644 index 0000000..30bd703 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/operator_eq__eq_.html @@ -0,0 +1,57 @@ + + + +basic_system_executor::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two executors for equality. +

+
bool operator==(
+    const basic_system_executor & ,
+    const basic_system_executor & );
+
+

+ Two executors are equal if they refer to the same underlying io_context. +

+
+ + Requirements +
+

+ Header: asio/system_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/operator_not__eq_.html new file mode 100644 index 0000000..46dd7be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/operator_not__eq_.html @@ -0,0 +1,57 @@ + + + +basic_system_executor::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two executors for inequality. +

+
bool operator!=(
+    const basic_system_executor & ,
+    const basic_system_executor & );
+
+

+ Two executors are equal if they refer to the same underlying io_context. +

+
+ + Requirements +
+

+ Header: asio/system_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/post.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/post.html new file mode 100644 index 0000000..5496879 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/post.html @@ -0,0 +1,76 @@ + + + +basic_system_executor::post + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the system executor to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void post(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object will never be executed inside this function. + Instead, it will be scheduled to run on an unspecified system thread pool. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query.html new file mode 100644 index 0000000..2f0e32f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query.html @@ -0,0 +1,58 @@ + + + +basic_system_executor::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Query + the current value of the allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr Allocator query(
+    execution::allocator_t< OtherAllocator > ) const;
+  » more...
+
+constexpr Allocator query(
+    execution::allocator_t< void > ) const;
+  » more...
+
+

+ Query the occupancy (recommended number of work items) for the system context. +

+
std::size_t query(
+    execution::occupancy_t ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload1.html new file mode 100644 index 0000000..795d0e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload1.html @@ -0,0 +1,57 @@ + + + +basic_system_executor::query (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr Allocator query(
+    execution::allocator_t< OtherAllocator > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
asio::system_executor ex;
+auto alloc = asio::query(ex,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload2.html new file mode 100644 index 0000000..05c1b4f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload2.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::query (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the allocator + property. +

+
constexpr Allocator query(
+    execution::allocator_t< void > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
asio::system_executor ex;
+auto alloc = asio::query(ex,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload3.html new file mode 100644 index 0000000..33277bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query/overload3.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::query (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the occupancy (recommended number of work items) for the system + context. +

+
std::size_t query(
+    execution::occupancy_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
asio::system_executor ex;
+std::size_t occupancy = asio::query(
+    ex, asio::execution::occupancy);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static.html new file mode 100644 index 0000000..4eedb92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static.html @@ -0,0 +1,69 @@ + + + +basic_system_executor::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Query + the current value of the mapping + property. +

+
static constexpr execution::mapping_t query(
+    execution::mapping_t );
+  » more...
+
+

+ Query the current value of the context + property. +

+
static system_context & query(
+    execution::context_t );
+  » more...
+
+

+ Query the current value of the blocking + property. +

+
static constexpr execution::blocking_t query(
+    execution::blocking_t );
+  » more...
+
+

+ Query the current value of the relationship + property. +

+
static constexpr execution::relationship_t query(
+    execution::relationship_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload1.html new file mode 100644 index 0000000..d53a37f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload1.html @@ -0,0 +1,56 @@ + + + +basic_system_executor::query (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the mapping + property. +

+
static constexpr execution::mapping_t query(
+    execution::mapping_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
asio::system_executor ex;
+if (asio::query(ex, asio::execution::mapping)
+      == asio::execution::mapping.thread)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload2.html new file mode 100644 index 0000000..b3a48e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload2.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::query (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the context + property. +

+
static system_context & query(
+    execution::context_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
asio::system_executor ex;
+asio::system_context& pool = asio::query(
+    ex, asio::execution::context);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload3.html new file mode 100644 index 0000000..7c0c055 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload3.html @@ -0,0 +1,56 @@ + + + +basic_system_executor::query (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the blocking + property. +

+
static constexpr execution::blocking_t query(
+    execution::blocking_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
asio::system_executor ex;
+if (asio::query(ex, asio::execution::blocking)
+      == asio::execution::blocking.always)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload4.html new file mode 100644 index 0000000..c7ab6d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/query__static/overload4.html @@ -0,0 +1,56 @@ + + + +basic_system_executor::query (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the relationship + property. +

+
static constexpr execution::relationship_t query(
+    execution::relationship_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
asio::system_executor ex;
+if (asio::query(ex, asio::execution::relationship)
+      == asio::execution::relationship.continuation)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require.html new file mode 100644 index 0000000..2f18a55 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require.html @@ -0,0 +1,95 @@ + + + +basic_system_executor::require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an executor with the blocking.possibly + property. +

+
basic_system_executor< execution::blocking_t::possibly_t, Relationship, Allocator > require(
+    execution::blocking_t::possibly_t ) const;
+  » more...
+
+

+ Obtain an executor with the blocking.always + property. +

+
basic_system_executor< execution::blocking_t::always_t, Relationship, Allocator > require(
+    execution::blocking_t::always_t ) const;
+  » more...
+
+

+ Obtain an executor with the blocking.never + property. +

+
basic_system_executor< execution::blocking_t::never_t, Relationship, Allocator > require(
+    execution::blocking_t::never_t ) const;
+  » more...
+
+

+ Obtain an executor with the relationship.continuation + property. +

+
basic_system_executor< Blocking, execution::relationship_t::continuation_t, Allocator > require(
+    execution::relationship_t::continuation_t ) const;
+  » more...
+
+

+ Obtain an executor with the relationship.fork + property. +

+
basic_system_executor< Blocking, execution::relationship_t::fork_t, Allocator > require(
+    execution::relationship_t::fork_t ) const;
+  » more...
+
+

+ Obtain an executor with the specified allocator + property. +

+
template<
+    typename OtherAllocator>
+basic_system_executor< Blocking, Relationship, OtherAllocator > require(
+    execution::allocator_t< OtherAllocator > a) const;
+  » more...
+
+

+ Obtain an executor with the default allocator + property. +

+
basic_system_executor< Blocking, Relationship, std::allocator< void > > require(
+    execution::allocator_t< void > ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload1.html new file mode 100644 index 0000000..164e318 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload1.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::require (1 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.possibly + property. +

+
basic_system_executor< execution::blocking_t::possibly_t, Relationship, Allocator > require(
+    execution::blocking_t::possibly_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
asio::system_executor ex1;
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload2.html new file mode 100644 index 0000000..5e19e90 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload2.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::require (2 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.always + property. +

+
basic_system_executor< execution::blocking_t::always_t, Relationship, Allocator > require(
+    execution::blocking_t::always_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
asio::system_executor ex1;
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.always);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload3.html new file mode 100644 index 0000000..6886f1c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload3.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::require (3 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.never + property. +

+
basic_system_executor< execution::blocking_t::never_t, Relationship, Allocator > require(
+    execution::blocking_t::never_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
asio::system_executor ex1;
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.never);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload4.html new file mode 100644 index 0000000..c523ee1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload4.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::require (4 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the relationship.continuation + property. +

+
basic_system_executor< Blocking, execution::relationship_t::continuation_t, Allocator > require(
+    execution::relationship_t::continuation_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
asio::system_executor ex1;
+auto ex2 = asio::require(ex1,
+    asio::execution::relationship.continuation);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload5.html new file mode 100644 index 0000000..10dca86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload5.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::require (5 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the relationship.fork + property. +

+
basic_system_executor< Blocking, execution::relationship_t::fork_t, Allocator > require(
+    execution::relationship_t::fork_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
asio::system_executor ex1;
+auto ex2 = asio::require(ex1,
+    asio::execution::relationship.fork);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload6.html new file mode 100644 index 0000000..2d92381 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload6.html @@ -0,0 +1,57 @@ + + + +basic_system_executor::require (6 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the specified allocator + property. +

+
template<
+    typename OtherAllocator>
+basic_system_executor< Blocking, Relationship, OtherAllocator > require(
+    execution::allocator_t< OtherAllocator > a) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
asio::system_executor ex1;
+auto ex2 = asio::require(ex1,
+    asio::execution::allocator(my_allocator));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload7.html new file mode 100644 index 0000000..cc801bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_system_executor/require/overload7.html @@ -0,0 +1,55 @@ + + + +basic_system_executor::require (7 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the default allocator + property. +

+
basic_system_executor< Blocking, Relationship, std::allocator< void > > require(
+    execution::allocator_t< void > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
asio::system_executor ex1;
+auto ex2 = asio::require(ex1,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer.html new file mode 100644 index 0000000..e66acad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer.html @@ -0,0 +1,425 @@ + + + +basic_waitable_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides waitable timer functionality. +

+
template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor>
+class basic_waitable_timer
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type of the clock. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_point +

+ 		+

+ The time point type of the clock. +

+
+

+ traits_type +

+ 		+

+ The wait traits type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_waitable_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a particular + expiry time relative to now.
—
Move-construct a basic_waitable_timer + from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_after +

+ 		+

+ Set the timer's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the timer's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the timer's expiry time as an absolute time. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_waitable_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_waitable_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ 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 one of the steady_timer, system_timer or high_resolution_timer typedefs. +

+
+ + Remarks +
+

+ This waitable timer functionality is for use with the C++11 standard library's + <chrono> facility, or with the Boost.Chrono library. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait (C++11): +

+
// Construct a timer without setting an expiry time.
+asio::steady_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_after(std::chrono::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait (C++11): +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::steady_timer timer(my_context,
+    std::chrono::steady_clock::now() + std::chrono::seconds(60));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + 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: +

+
void on_some_event()
+{
+  if (my_timer.expires_after(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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The asio::basic_waitable_timer::expires_after() + 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/_basic_waitable_timer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/_basic_waitable_timer.html new file mode 100644 index 0000000..87d6911 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/_basic_waitable_timer.html @@ -0,0 +1,46 @@ + + + +basic_waitable_timer::~basic_waitable_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the timer. +

+
~basic_waitable_timer();
+
+

+ This function destroys the timer, cancelling any outstanding asynchronous + wait operations associated with the timer as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/async_wait.html new file mode 100644 index 0000000..3e676a6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/async_wait.html @@ -0,0 +1,122 @@ + + + +basic_waitable_timer::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous wait on the timer. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function may be used to initiate an asynchronous wait against the + timer. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+

+ For each call to async_wait(), the completion handler will be called + exactly once. The completion handler will be called when: +

+
    +
  • + The timer has expired. +
    • +
  • + The timer was cancelled, in which case the handler is passed the error + code asio::error::operation_aborted. +
    • +
+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the timer expires. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer.html new file mode 100644 index 0000000..8f8182f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer.html @@ -0,0 +1,96 @@ + + + +basic_waitable_timer::basic_waitable_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
explicit basic_waitable_timer(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_waitable_timer(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Constructor to set a particular expiry time as an absolute time. +

+
basic_waitable_timer(
+    const executor_type & ex,
+    const time_point & expiry_time);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_waitable_timer(
+    ExecutionContext & context,
+    const time_point & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Constructor to set a particular expiry time relative to now. +

+
basic_waitable_timer(
+    const executor_type & ex,
+    const duration & expiry_time);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_waitable_timer(
+    ExecutionContext & context,
+    const duration & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_waitable_timer from another. +

+
basic_waitable_timer(
+    basic_waitable_timer && other);
+  » more...
+
+template<
+    typename Executor1>
+basic_waitable_timer(
+    basic_waitable_timer< Clock, WaitTraits, Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload1.html new file mode 100644 index 0000000..fc2bef1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload1.html @@ -0,0 +1,63 @@ + + + +basic_waitable_timer::basic_waitable_timer (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
basic_waitable_timer(
+    const executor_type & ex);
+
+

+ This constructor creates a timer without setting an expiry time. The + expires_at() + or expires_after() + functions must be called to set an expiry time before the timer can be + waited on. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the timer will use, by default, to dispatch + handlers for any asynchronous operations performed on the timer. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload2.html new file mode 100644 index 0000000..a74ff7a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload2.html @@ -0,0 +1,67 @@ + + + +basic_waitable_timer::basic_waitable_timer (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename ExecutionContext>
+basic_waitable_timer(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a timer without setting an expiry time. The + expires_at() + or expires_after() + functions must be called to set an expiry time before the timer can be + waited on. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the timer + will use, by default, to dispatch handlers for any asynchronous + operations performed on the timer. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload3.html new file mode 100644 index 0000000..d0b8e42 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload3.html @@ -0,0 +1,66 @@ + + + +basic_waitable_timer::basic_waitable_timer (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time as an absolute time. +

+
basic_waitable_timer(
+    const executor_type & ex,
+    const time_point & expiry_time);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor object that the timer will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload4.html new file mode 100644 index 0000000..49ce7f8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload4.html @@ -0,0 +1,69 @@ + + + +basic_waitable_timer::basic_waitable_timer (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time as an absolute time. +

+
template<
+    typename ExecutionContext>
+basic_waitable_timer(
+    ExecutionContext & context,
+    const time_point & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the timer + will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload5.html new file mode 100644 index 0000000..e0d5d2f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload5.html @@ -0,0 +1,64 @@ + + + +basic_waitable_timer::basic_waitable_timer (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time relative to now. +

+
basic_waitable_timer(
+    const executor_type & ex,
+    const duration & expiry_time);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the timer will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload6.html new file mode 100644 index 0000000..1309d65 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload6.html @@ -0,0 +1,68 @@ + + + +basic_waitable_timer::basic_waitable_timer (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor to set a particular expiry time relative to now. +

+
template<
+    typename ExecutionContext>
+basic_waitable_timer(
+    ExecutionContext & context,
+    const duration & expiry_time,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a timer and sets the expiry time. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the timer + will use, by default, 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. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload7.html new file mode 100644 index 0000000..0c0b823 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload7.html @@ -0,0 +1,68 @@ + + + +basic_waitable_timer::basic_waitable_timer (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_waitable_timer from another. +

+
basic_waitable_timer(
+    basic_waitable_timer && other);
+
+

+ This constructor moves a timer from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_waitable_timer object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_waitable_timer(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload8.html new file mode 100644 index 0000000..357adf8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/basic_waitable_timer/overload8.html @@ -0,0 +1,71 @@ + + + +basic_waitable_timer::basic_waitable_timer (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_waitable_timer from another. +

+
template<
+    typename Executor1>
+basic_waitable_timer(
+    basic_waitable_timer< Clock, WaitTraits, Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a timer from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_waitable_timer object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_waitable_timer(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/cancel.html new file mode 100644 index 0000000..6808ef5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/cancel.html @@ -0,0 +1,91 @@ + + + +basic_waitable_timer::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + any asynchronous operations that are waiting on the timer. +

+
std::size_t cancel();
+
+

+ 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 asio::error::operation_aborted error code. +

+

+ Cancelling the timer does not change the expiry time. +

+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/cancel_one.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/cancel_one.html new file mode 100644 index 0000000..380d4cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/cancel_one.html @@ -0,0 +1,93 @@ + + + +basic_waitable_timer::cancel_one + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancels + one asynchronous operation that is waiting on the timer. +

+
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 asio::error::operation_aborted + error code. +

+

+ Cancelling the timer does not change the expiry time. +

+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. That is, either + 0 or 1. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +
    • +
+

+ These handlers can no longer be cancelled, and therefore are passed an + error code that indicates the successful completion of the wait operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/clock_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/clock_type.html new file mode 100644 index 0000000..953c570 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/clock_type.html @@ -0,0 +1,52 @@ + + + +basic_waitable_timer::clock_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + clock type. +

+
typedef Clock clock_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/duration.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/duration.html new file mode 100644 index 0000000..6933062 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/duration.html @@ -0,0 +1,52 @@ + + + +basic_waitable_timer::duration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + duration type of the clock. +

+
typedef clock_type::duration duration;
+
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/executor_type.html new file mode 100644 index 0000000..69e98b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_waitable_timer::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expires_after.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expires_after.html new file mode 100644 index 0000000..706ae8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expires_after.html @@ -0,0 +1,102 @@ + + + +basic_waitable_timer::expires_after + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the timer's expiry time relative to now. +

+
std::size_t expires_after(
+    const duration & expiry_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 asio::error::operation_aborted error code. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ If the timer has already expired when expires_after() 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expires_at.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expires_at.html new file mode 100644 index 0000000..9eeb47b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expires_at.html @@ -0,0 +1,102 @@ + + + +basic_waitable_timer::expires_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the timer's expiry time as an absolute time. +

+
std::size_t expires_at(
+    const time_point & expiry_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 asio::error::operation_aborted error code. +

+
+ + Parameters +
+
+

+
+
expiry_time
+

+ The expiry time to be used for the timer. +

+
+
+
+ + Return + Value +
+

+ The number of asynchronous operations that were cancelled. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expiry.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expiry.html new file mode 100644 index 0000000..1c5fa59 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/expiry.html @@ -0,0 +1,46 @@ + + + +basic_waitable_timer::expiry + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the timer's expiry time as an absolute time. +

+
time_point expiry() const;
+
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/get_executor.html new file mode 100644 index 0000000..47218d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_waitable_timer::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_.html new file mode 100644 index 0000000..9b0127c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_.html @@ -0,0 +1,51 @@ + + + +basic_waitable_timer::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_waitable_timer + from another. +

+
basic_waitable_timer & operator=(
+    basic_waitable_timer && other);
+  » more...
+
+template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_waitable_timer & > operator=(
+    basic_waitable_timer< Clock, WaitTraits, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_/overload1.html new file mode 100644 index 0000000..e248059 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_/overload1.html @@ -0,0 +1,69 @@ + + + +basic_waitable_timer::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_waitable_timer from another. +

+
basic_waitable_timer & operator=(
+    basic_waitable_timer && other);
+
+

+ This assignment operator moves a timer from one object to another. Cancels + any outstanding asynchronous operations associated with the target object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_waitable_timer object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_waitable_timer(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_/overload2.html new file mode 100644 index 0000000..1b12bff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +basic_waitable_timer::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_waitable_timer from another. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_waitable_timer & > operator=(
+    basic_waitable_timer< Clock, WaitTraits, Executor1 > && other);
+
+

+ This assignment operator moves a timer from one object to another. Cancels + any outstanding asynchronous operations associated with the target object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_waitable_timer object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_waitable_timer(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/time_point.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/time_point.html new file mode 100644 index 0000000..8c116dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/time_point.html @@ -0,0 +1,52 @@ + + + +basic_waitable_timer::time_point + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + time point type of the clock. +

+
typedef clock_type::time_point time_point;
+
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/traits_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/traits_type.html new file mode 100644 index 0000000..c4b7720 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/traits_type.html @@ -0,0 +1,52 @@ + + + +basic_waitable_timer::traits_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + wait traits type. +

+
typedef WaitTraits traits_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait.html new file mode 100644 index 0000000..2592a7a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait.html @@ -0,0 +1,47 @@ + + + +basic_waitable_timer::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + a blocking wait on the timer. +

+
void wait();
+  » more...
+
+void wait(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait/overload1.html new file mode 100644 index 0000000..2f0f5a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait/overload1.html @@ -0,0 +1,58 @@ + + + +basic_waitable_timer::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform a blocking wait on the timer. +

+
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. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait/overload2.html new file mode 100644 index 0000000..c1fb7bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer/wait/overload2.html @@ -0,0 +1,59 @@ + + + +basic_waitable_timer::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform a blocking wait on the timer. +

+
void wait(
+    asio::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. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer__rebind_executor.html new file mode 100644 index 0000000..29db0eb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_waitable_timer::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the timer type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The timer type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer__rebind_executor/other.html new file mode 100644 index 0000000..4498b9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_waitable_timer__rebind_executor/other.html @@ -0,0 +1,423 @@ + + + +basic_waitable_timer::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + timer type when rebound to the specified executor. +

+
typedef basic_waitable_timer< Clock, WaitTraits, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type of the clock. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_point +

+ 		+

+ The time point type of the clock. +

+
+

+ traits_type +

+ 		+

+ The wait traits type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_waitable_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a + particular expiry time relative to now.
—
Move-construct + a basic_waitable_timer from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_after +

+ 		+

+ Set the timer's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the timer's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the timer's expiry time as an absolute time. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_waitable_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_waitable_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ 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 one of the steady_timer, system_timer or high_resolution_timer typedefs. +

+
+ + Remarks +
+

+ This waitable timer functionality is for use with the C++11 standard library's + <chrono> facility, or with the Boost.Chrono + library. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait (C++11): +

+
// Construct a timer without setting an expiry time.
+asio::steady_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_after(std::chrono::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait (C++11): +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::steady_timer timer(my_context,
+    std::chrono::steady_clock::now() + std::chrono::seconds(60));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + 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: +

+
void on_some_event()
+{
+  if (my_timer.expires_after(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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The asio::basic_waitable_timer::expires_after() + 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+
+ + Requirements +
+

+ Header: asio/basic_waitable_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe.html new file mode 100644 index 0000000..1209475 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe.html @@ -0,0 +1,329 @@ + + + +basic_writable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides pipe functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_writable_pipe
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_writable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_writable_pipe [constructor] +

+ 		+

+ Construct a basic_writable_pipe without opening it.
—
+ Construct a basic_writable_pipe on an existing native pipe.
+ —
Move-construct a basic_writable_pipe from another.
+ —
Move-construct a basic_writable_pipe from a pipe of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_writable_pipe from another.
—
Move-assign + a basic_writable_pipe from a pipe of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ write_some +

+ 		+

+ Write some data to the pipe. +

+
+

+ ~basic_writable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_writable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_writable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/_basic_writable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/_basic_writable_pipe.html new file mode 100644 index 0000000..26d1986 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/_basic_writable_pipe.html @@ -0,0 +1,46 @@ + + + +basic_writable_pipe::~basic_writable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the pipe. +

+
~basic_writable_pipe();
+
+

+ This function destroys the pipe, cancelling any outstanding asynchronous + wait operations associated with the pipe as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign.html new file mode 100644 index 0000000..a4093ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign.html @@ -0,0 +1,49 @@ + + + +basic_writable_pipe::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native pipe to the pipe. +

+
void assign(
+    const native_handle_type & native_pipe);
+  » more...
+
+void assign(
+    const native_handle_type & native_pipe,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign/overload1.html new file mode 100644 index 0000000..fdf6fcb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign/overload1.html @@ -0,0 +1,42 @@ + + + +basic_writable_pipe::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native pipe to the pipe. +

+
void assign(
+    const native_handle_type & native_pipe);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign/overload2.html new file mode 100644 index 0000000..60d34fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/assign/overload2.html @@ -0,0 +1,43 @@ + + + +basic_writable_pipe::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native pipe to the pipe. +

+
void assign(
+    const native_handle_type & native_pipe,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/async_write_some.html new file mode 100644 index 0000000..598f603 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/async_write_some.html @@ -0,0 +1,123 @@ + + + +basic_writable_pipe::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the pipe. It is an + initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the pipe. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
pipe.async_write_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe.html new file mode 100644 index 0000000..e35e2de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe.html @@ -0,0 +1,87 @@ + + + +basic_writable_pipe::basic_writable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a basic_writable_pipe + without opening it. +

+
explicit basic_writable_pipe(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_writable_pipe(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a basic_writable_pipe on an existing + native pipe. +

+
basic_writable_pipe(
+    const executor_type & ex,
+    const native_handle_type & native_pipe);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_writable_pipe(
+    ExecutionContext & context,
+    const native_handle_type & native_pipe,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a basic_writable_pipe from another. +

+
basic_writable_pipe(
+    basic_writable_pipe && other);
+  » more...
+
+

+ Move-construct a basic_writable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+basic_writable_pipe(
+    basic_writable_pipe< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload1.html new file mode 100644 index 0000000..43cfe7d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload1.html @@ -0,0 +1,60 @@ + + + +basic_writable_pipe::basic_writable_pipe (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_writable_pipe without + opening it. +

+
basic_writable_pipe(
+    const executor_type & ex);
+
+

+ This constructor creates a pipe without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the pipe will use, by default, to dispatch + handlers for any asynchronous operations performed on the pipe. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload2.html new file mode 100644 index 0000000..aad4efd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload2.html @@ -0,0 +1,64 @@ + + + +basic_writable_pipe::basic_writable_pipe (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_writable_pipe without + opening it. +

+
template<
+    typename ExecutionContext>
+basic_writable_pipe(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a pipe without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the pipe + will use, by default, to dispatch handlers for any asynchronous + operations performed on the pipe. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload3.html new file mode 100644 index 0000000..ac08dc6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload3.html @@ -0,0 +1,78 @@ + + + +basic_writable_pipe::basic_writable_pipe (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_writable_pipe on an existing + native pipe. +

+
basic_writable_pipe(
+    const executor_type & ex,
+    const native_handle_type & native_pipe);
+
+

+ This constructor creates a pipe object to hold an existing native pipe. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the pipe will use, by default, to dispatch + handlers for any asynchronous operations performed on the pipe. +

+
native_pipe
+

+ A native pipe. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload4.html new file mode 100644 index 0000000..1e3b272 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload4.html @@ -0,0 +1,82 @@ + + + +basic_writable_pipe::basic_writable_pipe (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a basic_writable_pipe on an existing + native pipe. +

+
template<
+    typename ExecutionContext>
+basic_writable_pipe(
+    ExecutionContext & context,
+    const native_handle_type & native_pipe,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a pipe object to hold an existing native pipe. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the pipe + will use, by default, to dispatch handlers for any asynchronous + operations performed on the pipe. +

+
native_pipe
+

+ A native pipe. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload5.html new file mode 100644 index 0000000..528820c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload5.html @@ -0,0 +1,68 @@ + + + +basic_writable_pipe::basic_writable_pipe (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_writable_pipe from another. +

+
basic_writable_pipe(
+    basic_writable_pipe && other);
+
+

+ This constructor moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_writable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_writable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload6.html new file mode 100644 index 0000000..1d32431 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/basic_writable_pipe/overload6.html @@ -0,0 +1,72 @@ + + + +basic_writable_pipe::basic_writable_pipe (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a basic_writable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+basic_writable_pipe(
+    basic_writable_pipe< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_writable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_writable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel.html new file mode 100644 index 0000000..cc1ac1e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel.html @@ -0,0 +1,47 @@ + + + +basic_writable_pipe::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the pipe. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel/overload1.html new file mode 100644 index 0000000..50c8944 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel/overload1.html @@ -0,0 +1,59 @@ + + + +basic_writable_pipe::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the pipe. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous write operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel/overload2.html new file mode 100644 index 0000000..79d2c01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/cancel/overload2.html @@ -0,0 +1,60 @@ + + + +basic_writable_pipe::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the pipe. +

+
void cancel(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous write operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close.html new file mode 100644 index 0000000..2d46db7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close.html @@ -0,0 +1,47 @@ + + + +basic_writable_pipe::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the + pipe. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close/overload1.html new file mode 100644 index 0000000..3bbf89b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close/overload1.html @@ -0,0 +1,58 @@ + + + +basic_writable_pipe::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the pipe. +

+
void close();
+
+

+ This function is used to close the pipe. Any asynchronous write operations + will be cancelled immediately, and will complete with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close/overload2.html new file mode 100644 index 0000000..8e776fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/close/overload2.html @@ -0,0 +1,59 @@ + + + +basic_writable_pipe::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the pipe. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the pipe. Any asynchronous write operations + will be cancelled immediately, and will complete with the asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/executor_type.html new file mode 100644 index 0000000..8aa294f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_writable_pipe::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_writable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/get_executor.html new file mode 100644 index 0000000..5d23a7b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_writable_pipe::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/is_open.html new file mode 100644 index 0000000..edabf15 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/is_open.html @@ -0,0 +1,42 @@ + + + +basic_writable_pipe::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the pipe is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer.html new file mode 100644 index 0000000..551d038 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer.html @@ -0,0 +1,49 @@ + + + +basic_writable_pipe::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer/overload1.html new file mode 100644 index 0000000..ed24d81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer/overload1.html @@ -0,0 +1,55 @@ + + + +basic_writable_pipe::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 basic_writable_pipe cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer/overload2.html new file mode 100644 index 0000000..d9f5de8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer/overload2.html @@ -0,0 +1,55 @@ + + + +basic_writable_pipe::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a basic_writable_pipe cannot contain + any further layers, it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer_type.html new file mode 100644 index 0000000..f2753d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/lowest_layer_type.html @@ -0,0 +1,328 @@ + + + +basic_writable_pipe::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + basic_writable_pipe + is always the lowest layer. +

+
typedef basic_writable_pipe lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_writable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_writable_pipe [constructor] +

+ 		+

+ Construct a basic_writable_pipe without opening it.
—
+ Construct a basic_writable_pipe on an existing native pipe. +
—
Move-construct a basic_writable_pipe from another. +
—
Move-construct a basic_writable_pipe from a pipe + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_writable_pipe from another.
—
+ Move-assign a basic_writable_pipe from a pipe of another executor + type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ write_some +

+ 		+

+ Write some data to the pipe. +

+
+

+ ~basic_writable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_writable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_writable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/native_handle.html new file mode 100644 index 0000000..a7930c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/native_handle.html @@ -0,0 +1,47 @@ + + + +basic_writable_pipe::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the native pipe representation. +

+
native_handle_type native_handle();
+
+

+ This function may be used to obtain the underlying representation of the + pipe. This is intended to allow access to native pipe functionality that + is not otherwise provided. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/native_handle_type.html new file mode 100644 index 0000000..039c336 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/native_handle_type.html @@ -0,0 +1,52 @@ + + + +basic_writable_pipe::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a pipe. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/basic_writable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_.html new file mode 100644 index 0000000..8a134ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_.html @@ -0,0 +1,55 @@ + + + +basic_writable_pipe::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a basic_writable_pipe + from another. +

+
basic_writable_pipe & operator=(
+    basic_writable_pipe && other);
+  » more...
+
+

+ Move-assign a basic_writable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_writable_pipe & > operator=(
+    basic_writable_pipe< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_/overload1.html new file mode 100644 index 0000000..53b76bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +basic_writable_pipe::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_writable_pipe from another. +

+
basic_writable_pipe & operator=(
+    basic_writable_pipe && other);
+
+

+ This assignment operator moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_writable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_writable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_/overload2.html new file mode 100644 index 0000000..af59b9a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +basic_writable_pipe::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a basic_writable_pipe from a pipe + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_writable_pipe & > operator=(
+    basic_writable_pipe< Executor1 > && other);
+
+

+ This assignment operator moves a pipe from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other basic_writable_pipe object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_writable_pipe(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release.html new file mode 100644 index 0000000..16bae3b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release.html @@ -0,0 +1,47 @@ + + + +basic_writable_pipe::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native pipe. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release/overload1.html new file mode 100644 index 0000000..48b0a29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release/overload1.html @@ -0,0 +1,69 @@ + + + +basic_writable_pipe::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native pipe. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous write operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. Ownership + of the native pipe is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release/overload2.html new file mode 100644 index 0000000..a32d59b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/release/overload2.html @@ -0,0 +1,70 @@ + + + +basic_writable_pipe::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native pipe. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous write operations to + finish immediately, and the handlers for cancelled operations will be + passed the asio::error::operation_aborted error. Ownership + of the native pipe is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some.html new file mode 100644 index 0000000..e4c0f18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some.html @@ -0,0 +1,53 @@ + + + +basic_writable_pipe::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the pipe. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some/overload1.html new file mode 100644 index 0000000..c0272e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some/overload1.html @@ -0,0 +1,107 @@ + + + +basic_writable_pipe::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the pipe. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write data to the pipe. The function call will + block until one or more bytes of the data has been written successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the pipe. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
pipe.write_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some/overload2.html new file mode 100644 index 0000000..34dfbfe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe/write_some/overload2.html @@ -0,0 +1,84 @@ + + + +basic_writable_pipe::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the pipe. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write data to the pipe. The function call will + block until one or more bytes of the data has been written successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the pipe. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe__rebind_executor.html new file mode 100644 index 0000000..7d85433 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe__rebind_executor.html @@ -0,0 +1,89 @@ + + + +basic_writable_pipe::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the pipe type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The pipe type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/basic_writable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe__rebind_executor/other.html new file mode 100644 index 0000000..088c668 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_writable_pipe__rebind_executor/other.html @@ -0,0 +1,327 @@ + + + +basic_writable_pipe::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + pipe type when rebound to the specified executor. +

+
typedef basic_writable_pipe< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_writable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_writable_pipe [constructor] +

+ 		+

+ Construct a basic_writable_pipe without opening it.
—
+ Construct a basic_writable_pipe on an existing native pipe. +
—
Move-construct a basic_writable_pipe from another. +
—
Move-construct a basic_writable_pipe from a pipe + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_writable_pipe from another.
—
+ Move-assign a basic_writable_pipe from a pipe of another executor + type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ write_some +

+ 		+

+ Write some data to the pipe. +

+
+

+ ~basic_writable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_writable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/basic_writable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context.html new file mode 100644 index 0000000..ac89fd1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context.html @@ -0,0 +1,246 @@ + + + +basic_yield_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + that represents the currently executing coroutine. +

+
template<
+    typename Executor>
+class basic_yield_context
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancellation_slot_type +

+ 		+

+ The cancellation slot type associated with the yield context. +

+
+

+ executor_type +

+ 		+

+ The executor type associated with the yield context. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_yield_context [constructor] +

+ 		+

+ Construct a yield context from another yield context type. +

+
+

+ cancelled +

+ 		+

+ Determine whether the current coroutine has been cancelled. +

+
+

+ get_cancellation_slot +

+ 		+

+ Get the cancellation slot associated with the coroutine. +

+
+

+ get_cancellation_state +

+ 		+

+ Get the cancellation state associated with the coroutine. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the yield context. +

+
+

+ operator[] +

+ 		+

+ Return a yield context that sets the specified error_code. +

+
+

+ reset_cancellation_state +

+ 		+

+ Reset the cancellation state associated with the coroutine. +

+
+

+ throw_if_cancelled +

+ 		+

+ Determine whether the coroutine throws if trying to suspend when + it has been cancelled.
—
Set whether the coroutine + throws if trying to suspend when it has been cancelled. +

+
+

+ The basic_yield_context + class is a completion token type that is used to represent the currently + executing stackful coroutine. A basic_yield_context object may be + passed as a completion token to an asynchronous operation. For example: +

+
template <typename Executor>
+void my_coroutine(basic_yield_context<Executor> yield)
+{
+  ...
+  std::size_t n = my_socket.async_read_some(buffer, yield);
+  ...
+}
+
+

+ The initiating function (async_read_some in the above example) suspends the + current coroutine. The coroutine is resumed when the asynchronous operation + completes, and the result of the operation is returned. +

+
+ + Requirements +
+

+ Header: asio/spawn.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/basic_yield_context.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/basic_yield_context.html new file mode 100644 index 0000000..bd5ec3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/basic_yield_context.html @@ -0,0 +1,49 @@ + + + +basic_yield_context::basic_yield_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a yield context from another yield context type. +

+
template<
+    typename OtherExecutor>
+basic_yield_context(
+    const basic_yield_context< OtherExecutor > & other,
+    constraint_t< is_convertible< OtherExecutor, Executor >::value >  = 0);
+
+

+ Requires that OtherExecutor be convertible to Executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/cancellation_slot_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/cancellation_slot_type.html new file mode 100644 index 0000000..6384d1a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/cancellation_slot_type.html @@ -0,0 +1,198 @@ + + + +basic_yield_context::cancellation_slot_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + cancellation slot type associated with the yield context. +

+
typedef cancellation_slot cancellation_slot_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Installs a handler into the slot. +

+
+

+ cancellation_slot [constructor] +

+ 		+

+ Creates a slot that is not connected to any cancellation signal. +

+
+

+ clear +

+ 		+

+ Clears the slot. +

+
+

+ emplace +

+ 		+

+ Installs a handler into the slot, constructing the new object + directly. +

+
+

+ has_handler +

+ 		+

+ Returns whether the slot is connected and has an installed handler. +

+
+

+ is_connected +

+ 		+

+ Returns whether the slot is connected to a signal. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two slots for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two slots for equality. +

+
+
+ + Requirements +
+

+ Header: asio/spawn.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/cancelled.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/cancelled.html new file mode 100644 index 0000000..c318600 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/cancelled.html @@ -0,0 +1,42 @@ + + + +basic_yield_context::cancelled + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the current coroutine has been cancelled. +

+
cancellation_type_t cancelled() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/executor_type.html new file mode 100644 index 0000000..feb048d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/executor_type.html @@ -0,0 +1,52 @@ + + + +basic_yield_context::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + executor type associated with the yield context. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/spawn.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_cancellation_slot.html new file mode 100644 index 0000000..311d59b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_cancellation_slot.html @@ -0,0 +1,42 @@ + + + +basic_yield_context::get_cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the cancellation slot associated with the coroutine. +

+
cancellation_slot_type get_cancellation_slot() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_cancellation_state.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_cancellation_state.html new file mode 100644 index 0000000..73d670b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_cancellation_state.html @@ -0,0 +1,42 @@ + + + +basic_yield_context::get_cancellation_state + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the cancellation state associated with the coroutine. +

+
cancellation_state get_cancellation_state() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_executor.html new file mode 100644 index 0000000..9bf3f24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/get_executor.html @@ -0,0 +1,42 @@ + + + +basic_yield_context::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the yield context. +

+
executor_type get_executor() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/operator_lb__rb_.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/operator_lb__rb_.html new file mode 100644 index 0000000..8b13a45 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/operator_lb__rb_.html @@ -0,0 +1,61 @@ + + + +basic_yield_context::operator[] + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Return + a yield context that sets the specified error_code. +

+
basic_yield_context operator[](
+    asio::error_code & ec) const;
+
+

+ By default, when a yield context is used with an asynchronous operation, + a non-success error_code is converted to system_error and thrown. This + operator may be used to specify an error_code object that should instead + be set with the asynchronous operation's result. For example: +

+
template <typename Executor>
+void my_coroutine(basic_yield_context<Executor> yield)
+{
+  ...
+  std::size_t n = my_socket.async_read_some(buffer, yield[ec]);
+  if (ec)
+  {
+    // An error occurred.
+  }
+  ...
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state.html new file mode 100644 index 0000000..d2176ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state.html @@ -0,0 +1,57 @@ + + + +basic_yield_context::reset_cancellation_state + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Reset + the cancellation state associated with the coroutine. +

+
void reset_cancellation_state() const;
+  » more...
+
+template<
+    typename Filter>
+void reset_cancellation_state(
+    Filter && filter) const;
+  » more...
+
+template<
+    typename InFilter,
+    typename OutFilter>
+void reset_cancellation_state(
+    InFilter && in_filter,
+    OutFilter && out_filter) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload1.html new file mode 100644 index 0000000..5aa8965 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload1.html @@ -0,0 +1,47 @@ + + + +basic_yield_context::reset_cancellation_state (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Reset the cancellation state associated with the coroutine. +

+
void reset_cancellation_state() const;
+
+

+ Let P be the cancellation + slot associated with the current coroutine's spawn completion handler. Assigns + a new cancellation_state object S, constructed as S(P), into the current coroutine's cancellation + state object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload2.html new file mode 100644 index 0000000..4e0f7fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload2.html @@ -0,0 +1,50 @@ + + + +basic_yield_context::reset_cancellation_state (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Reset the cancellation state associated with the coroutine. +

+
template<
+    typename Filter>
+void reset_cancellation_state(
+    Filter && filter) const;
+
+

+ Let P be the cancellation + slot associated with the current coroutine's spawn completion handler. Assigns + a new cancellation_state object S, constructed as S(P, std::forward<Filter>(filter)), into the current coroutine's cancellation + state object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload3.html new file mode 100644 index 0000000..3322c7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/reset_cancellation_state/overload3.html @@ -0,0 +1,52 @@ + + + +basic_yield_context::reset_cancellation_state (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Reset the cancellation state associated with the coroutine. +

+
template<
+    typename InFilter,
+    typename OutFilter>
+void reset_cancellation_state(
+    InFilter && in_filter,
+    OutFilter && out_filter) const;
+
+

+ Let P be the cancellation + slot associated with the current coroutine's spawn completion handler. Assigns + a new cancellation_state object S, constructed as S(P, std::forward<InFilter>(in_filter), std::forward<OutFilter>(out_filter)), into the current coroutine's cancellation + state object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled.html new file mode 100644 index 0000000..48b792c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled.html @@ -0,0 +1,51 @@ + + + +basic_yield_context::throw_if_cancelled + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the coroutine throws if trying to suspend when it has been cancelled. +

+
bool throw_if_cancelled() const;
+  » more...
+
+

+ Set whether the coroutine throws if trying to suspend when it has been + cancelled. +

+
void throw_if_cancelled(
+    bool value) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled/overload1.html new file mode 100644 index 0000000..38d9264 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled/overload1.html @@ -0,0 +1,42 @@ + + + +basic_yield_context::throw_if_cancelled (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine whether the coroutine throws if trying to suspend when it has + been cancelled. +

+
bool throw_if_cancelled() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled/overload2.html new file mode 100644 index 0000000..940e3cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/basic_yield_context/throw_if_cancelled/overload2.html @@ -0,0 +1,43 @@ + + + +basic_yield_context::throw_if_cancelled (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set whether the coroutine throws if trying to suspend when it has been + cancelled. +

+
void throw_if_cancelled(
+    bool value) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/bind_allocator.html new file mode 100644 index 0000000..c18d0ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_allocator.html @@ -0,0 +1,69 @@ + + + +bind_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a partial completion token that associates an allocator. +

+
template<
+    typename Allocator>
+partial_allocator_binder< Allocator > bind_allocator(
+    const Allocator & ex);
+  » more...
+
+

+ Associate an object of type T + with an allocator of type Allocator. +

+
template<
+    typename Allocator,
+    typename T>
+allocator_binder< decay_t< T >, Allocator > bind_allocator(
+    const Allocator & s,
+    T && t);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_allocator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/bind_allocator/overload1.html new file mode 100644 index 0000000..e7123fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_allocator/overload1.html @@ -0,0 +1,44 @@ + + + +bind_allocator (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token that associates an allocator. +

+
template<
+    typename Allocator>
+partial_allocator_binder< Allocator > bind_allocator(
+    const Allocator & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_allocator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/bind_allocator/overload2.html new file mode 100644 index 0000000..f14c607 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_allocator/overload2.html @@ -0,0 +1,47 @@ + + + +bind_allocator (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Associate an object of type T + with an allocator of type Allocator. +

+
template<
+    typename Allocator,
+    typename T>
+allocator_binder< decay_t< T >, Allocator > bind_allocator(
+    const Allocator & s,
+    T && t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot.html new file mode 100644 index 0000000..474a3c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot.html @@ -0,0 +1,69 @@ + + + +bind_cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a partial completion token that associates a cancellation slot. +

+
template<
+    typename CancellationSlot>
+partial_cancellation_slot_binder< CancellationSlot > bind_cancellation_slot(
+    const CancellationSlot & ex);
+  » more...
+
+

+ Associate an object of type T + with a cancellation slot of type CancellationSlot. +

+
template<
+    typename CancellationSlot,
+    typename T>
+cancellation_slot_binder< decay_t< T >, CancellationSlot > bind_cancellation_slot(
+    const CancellationSlot & s,
+    T && t);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot/overload1.html new file mode 100644 index 0000000..768534e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot/overload1.html @@ -0,0 +1,44 @@ + + + +bind_cancellation_slot (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token that associates a cancellation slot. +

+
template<
+    typename CancellationSlot>
+partial_cancellation_slot_binder< CancellationSlot > bind_cancellation_slot(
+    const CancellationSlot & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot/overload2.html new file mode 100644 index 0000000..df42735 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_cancellation_slot/overload2.html @@ -0,0 +1,47 @@ + + + +bind_cancellation_slot (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Associate an object of type T + with a cancellation slot of type CancellationSlot. +

+
template<
+    typename CancellationSlot,
+    typename T>
+cancellation_slot_binder< decay_t< T >, CancellationSlot > bind_cancellation_slot(
+    const CancellationSlot & s,
+    T && t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/bind_executor.html new file mode 100644 index 0000000..6f27be1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_executor.html @@ -0,0 +1,95 @@ + + + +bind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a partial completion token that associates an executor. +

+
template<
+    typename Executor>
+partial_executor_binder< Executor > bind_executor(
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ Associate an object of type T + with an executor of type Executor. +

+
template<
+    typename Executor,
+    typename T>
+executor_binder< decay_t< T >, Executor > bind_executor(
+    const Executor & ex,
+    T && t,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ Create a partial completion token that associates an execution context's + executor. +

+
template<
+    typename ExecutionContext>
+partial_executor_binder< typename ExecutionContext::executor_type > bind_executor(
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Associate an object of type T + with an execution context's executor. +

+
template<
+    typename ExecutionContext,
+    typename T>
+executor_binder< decay_t< T >, typename ExecutionContext::executor_type > bind_executor(
+    ExecutionContext & ctx,
+    T && t,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload1.html new file mode 100644 index 0000000..b99c39c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload1.html @@ -0,0 +1,45 @@ + + + +bind_executor (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token that associates an executor. +

+
template<
+    typename Executor>
+partial_executor_binder< Executor > bind_executor(
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload2.html new file mode 100644 index 0000000..48a15fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload2.html @@ -0,0 +1,48 @@ + + + +bind_executor (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Associate an object of type T + with an executor of type Executor. +

+
template<
+    typename Executor,
+    typename T>
+executor_binder< decay_t< T >, Executor > bind_executor(
+    const Executor & ex,
+    T && t,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload3.html new file mode 100644 index 0000000..aa4a228 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload3.html @@ -0,0 +1,46 @@ + + + +bind_executor (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token that associates an execution context's + executor. +

+
template<
+    typename ExecutionContext>
+partial_executor_binder< typename ExecutionContext::executor_type > bind_executor(
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload4.html new file mode 100644 index 0000000..7363bc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_executor/overload4.html @@ -0,0 +1,48 @@ + + + +bind_executor (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Associate an object of type T + with an execution context's executor. +

+
template<
+    typename ExecutionContext,
+    typename T>
+executor_binder< decay_t< T >, typename ExecutionContext::executor_type > bind_executor(
+    ExecutionContext & ctx,
+    T && t,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor.html b/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor.html new file mode 100644 index 0000000..eebddf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor.html @@ -0,0 +1,69 @@ + + + +bind_immediate_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a partial completion token that associates an executor. +

+
template<
+    typename Executor>
+partial_immediate_executor_binder< Executor > bind_immediate_executor(
+    const Executor & ex);
+  » more...
+
+

+ Associate an object of type T + with a immediate executor of type Executor. +

+
template<
+    typename Executor,
+    typename T>
+immediate_executor_binder< decay_t< T >, Executor > bind_immediate_executor(
+    const Executor & e,
+    T && t);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor/overload1.html new file mode 100644 index 0000000..414ce81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor/overload1.html @@ -0,0 +1,44 @@ + + + +bind_immediate_executor (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token that associates an executor. +

+
template<
+    typename Executor>
+partial_immediate_executor_binder< Executor > bind_immediate_executor(
+    const Executor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor/overload2.html new file mode 100644 index 0000000..1d18ed9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/bind_immediate_executor/overload2.html @@ -0,0 +1,47 @@ + + + +bind_immediate_executor (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Associate an object of type T + with a immediate executor of type Executor. +

+
template<
+    typename Executor,
+    typename T>
+immediate_executor_binder< decay_t< T >, Executor > bind_immediate_executor(
+    const Executor & e,
+    T && t);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer.html b/Packages/asio-1.36.0/doc/asio/reference/buffer.html new file mode 100644 index 0000000..bf550cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer.html @@ -0,0 +1,665 @@ + + + +buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+buffer +

+

+ +

+

+ The 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. +

+

+ Create a new modifiable buffer from an existing buffer. +

+
mutable_buffer buffer(
+    const mutable_buffer & b);
+  » more...
+
+mutable_buffer buffer(
+    const mutable_buffer & b,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer from an existing buffer. +

+
const_buffer buffer(
+    const const_buffer & b);
+  » more...
+
+const_buffer buffer(
+    const const_buffer & b,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new modifiable buffer that represents the given memory range. +

+
mutable_buffer buffer(
+    void * data,
+    std::size_t size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given memory range. +

+
const_buffer buffer(
+    const void * data,
+    std::size_t size_in_bytes);
+  » more...
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    PodType((&data)[N]);
+  » more...
+
+template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    PodType((&data)[N],
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    const PodType((&data)[N]);
+  » more...
+
+template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    const PodType((&data)[N],
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    boost::array< PodType, N > & data);
+  » more...
+
+template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    boost::array< PodType, N > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    boost::array< const PodType, N > & data);
+  » more...
+
+template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    boost::array< const PodType, N > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    std::array< PodType, N > & data);
+  » more...
+
+template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    std::array< PodType, N > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    std::array< const PodType, N > & data);
+  » more...
+
+template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    std::array< const PodType, N > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new modifiable buffer that represents the given POD vector. +

+
template<
+    typename PodType,
+    typename Allocator>
+mutable_buffer buffer(
+    std::vector< PodType, Allocator > & data);
+  » more...
+
+template<
+    typename PodType,
+    typename Allocator>
+mutable_buffer buffer(
+    std::vector< PodType, Allocator > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given POD vector. +

+
template<
+    typename PodType,
+    typename Allocator>
+const_buffer buffer(
+    const std::vector< PodType, Allocator > & data);
+  » more...
+
+template<
+    typename PodType,
+    typename Allocator>
+const_buffer buffer(
+    const std::vector< PodType, Allocator > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+mutable_buffer buffer(
+    std::basic_string< Elem, Traits, Allocator > & data);
+  » more...
+
+template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+mutable_buffer buffer(
+    std::basic_string< Elem, Traits, Allocator > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+const_buffer buffer(
+    const std::basic_string< Elem, Traits, Allocator > & data);
+  » more...
+
+template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+const_buffer buffer(
+    const std::basic_string< Elem, Traits, Allocator > & data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given string_view. +

+
template<
+    typename Elem,
+    typename Traits>
+const_buffer buffer(
+    basic_string_view< Elem, Traits > data);
+  » more...
+
+

+ Create a new non-modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits>
+const_buffer buffer(
+    basic_string_view< Elem, Traits > data,
+    std::size_t max_size_in_bytes);
+  » more...
+
+

+ Create a new modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+mutable_buffer buffer(
+    T & data,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+template<
+    typename T>
+mutable_buffer buffer(
+    T & data,
+    std::size_t max_size_in_bytes,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Create a new non-modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+const_buffer buffer(
+    T & data,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+template<
+    typename T>
+const_buffer buffer(
+    T & data,
+    std::size_t max_size_in_bytes,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+template<
+    typename T>
+const_buffer buffer(
+    const T & data,
+    constraint_t< is_contiguous_iterator< typename T::const_iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+template<
+    typename T>
+const_buffer buffer(
+    const T & data,
+    std::size_t max_size_in_bytes,
+    constraint_t< is_contiguous_iterator< typename T::const_iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Create a new modifiable buffer from a span. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+mutable_buffer buffer(
+    const Span< T, Extent > & span,
+    constraint_t< !is_const< T >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+mutable_buffer buffer(
+    const Span< T, Extent > & span,
+    std::size_t max_size_in_bytes,
+    constraint_t< !is_const< T >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Create a new non-modifiable buffer from a span. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+const_buffer buffer(
+    const Span< const T, Extent > & span,
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+const_buffer buffer(
+    const Span< const T, Extent > & span,
+    std::size_t max_size_in_bytes,
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Obtain a buffer representing the entire registered buffer. +

+
mutable_registered_buffer buffer(
+    const mutable_registered_buffer & b);
+  » more...
+
+const_registered_buffer buffer(
+    const const_registered_buffer & b);
+  » more...
+
+

+ Obtain a buffer representing part of a registered buffer. +

+
mutable_registered_buffer buffer(
+    const mutable_registered_buffer & b,
+    std::size_t n);
+  » more...
+
+const_registered_buffer buffer(
+    const const_registered_buffer & b,
+    std::size_t n);
+  » more...
+
+

+ 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 mutable_buffer and const_buffer, respectively. To mirror + C++'s conversion rules, a mutable_buffer is implicitly convertible + to a const_buffer, + and the opposite conversion is not permitted. +

+

+ The simplest use case involves reading or writing a single buffer of a specified + size: +

+
sock.send(asio::buffer(data, size));
+
+

+ In the above example, the return value of 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: +

+
char d1[128];
+size_t bytes_transferred = sock.receive(asio::buffer(d1));
+
+std::vector<char> d2(128);
+bytes_transferred = sock.receive(asio::buffer(d2));
+
+std::array<char, 128> d3;
+bytes_transferred = sock.receive(asio::buffer(d3));
+
+boost::array<char, 128> d4;
+bytes_transferred = sock.receive(asio::buffer(d4));
+
+

+ 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::mutable_buffer b1 = ...;
+std::size_t s1 = b1.size();
+unsigned char* p1 = static_cast<unsigned char*>(b1.data());
+
+asio::const_buffer b2 = ...;
+std::size_t s2 = b2.size();
+const void* p2 = b2.data();
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+

+ For convenience, a buffer_size function is provided + that works with both buffers and 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. +

+
+ + Buffer + Copying +
+

+ The buffer_copy + function may be used to copy raw bytes between individual buffers and buffer + sequences. +

+

+ In particular, when used with the buffer_size function, the buffer_copy + function can be used to linearise a sequence of buffers. For example: +

+
vector<const_buffer> buffers = ...;
+
+vector<unsigned char> data(asio::buffer_size(buffers));
+asio::buffer_copy(asio::buffer(data), buffers);
+
+

+ Note that buffer_copy + is implemented in terms of memcpy, + and consequently it cannot be used to copy between overlapping memory regions. +

+
+ + Buffer + Invalidation +
+

+ 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 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 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 + Arithmetic +
+

+ Buffer objects may be manipulated using simple arithmetic in a safe way which + helps prevent buffer overruns. Consider an array initialised as follows: +

+
boost::array<char, 6> a = { 'a', 'b', 'c', 'd', 'e' };
+
+

+ A buffer object b1 created + using: +

+
b1 = asio::buffer(a);
+
+

+ represents the entire array, { 'a', 'b', 'c', + 'd', 'e' }. An optional + second argument to the buffer function may be used to limit + the size, in bytes, of the buffer: +

+
b2 = asio::buffer(a, 3);
+
+

+ 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. +

+

+ An offset may be applied to an existing buffer to create a new one: +

+
b3 = b1 + 2;
+
+

+ 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: +

+
b4 = asio::buffer(b1 + 1, 3);
+
+

+ so that b4 will refer to + the bytes { 'b', 'c', + 'd' }. +

+
+ + Buffers and + Scatter-Gather I/O +
+

+ 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: +

+
char d1[128];
+std::vector<char> d2(128);
+boost::array<char, 128> d3;
+
+boost::array<mutable_buffer, 3> bufs1 = {
+  asio::buffer(d1),
+  asio::buffer(d2),
+  asio::buffer(d3) };
+bytes_transferred = sock.receive(bufs1);
+
+std::vector<const_buffer> bufs2;
+bufs2.push_back(asio::buffer(d1));
+bufs2.push_back(asio::buffer(d2));
+bufs2.push_back(asio::buffer(d3));
+bytes_transferred = sock.send(bufs2);
+
+
+ + Buffer + Literals +
+

+ The _buf literal suffix, + defined in namespace asio::buffer_literals, + may be used to create const_buffer + objects from string, binary integer, and hexadecimal integer literals. For + example: +

+
using namespace asio::buffer_literals;
+
+asio::const_buffer b1 = "hello"_buf;
+asio::const_buffer b2 = 0xdeadbeef_buf;
+asio::const_buffer b3 = 0x0123456789abcdef0123456789abcdef_buf;
+asio::const_buffer b4 = 0b1010101011001100_buf;
+
+

+ Note that the memory associated with a buffer literal is valid for the lifetime + of the program. This means that the buffer can be safely used with asynchronous + operations. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload1.html new file mode 100644 index 0000000..dab7ab2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload1.html @@ -0,0 +1,49 @@ + + + +buffer (1 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer from an existing buffer. +

+
mutable_buffer buffer(
+    const mutable_buffer & b);
+
+
+ + Return + Value +
+

+ mutable_buffer(b). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload10.html new file mode 100644 index 0000000..308eb5c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload10.html @@ -0,0 +1,59 @@ + + + +buffer (10 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    const PodType((&data)[N],
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   static_cast<const void*>(data),
+   min(N * sizeof(PodType), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload11.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload11.html new file mode 100644 index 0000000..b9becf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload11.html @@ -0,0 +1,58 @@ + + + +buffer (11 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    boost::array< PodType, N > & data);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.data(),
+   data.size() * sizeof(PodType));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload12.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload12.html new file mode 100644 index 0000000..ef225f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload12.html @@ -0,0 +1,59 @@ + + + +buffer (12 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    boost::array< PodType, N > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.data(),
+   min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload13.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload13.html new file mode 100644 index 0000000..5835fb7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload13.html @@ -0,0 +1,58 @@ + + + +buffer (13 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    boost::array< const PodType, N > & data);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.data(),
+   data.size() * sizeof(PodType));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload14.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload14.html new file mode 100644 index 0000000..b6e0c99 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload14.html @@ -0,0 +1,59 @@ + + + +buffer (14 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    boost::array< const PodType, N > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.data(),
+   min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload15.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload15.html new file mode 100644 index 0000000..16c2088 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload15.html @@ -0,0 +1,58 @@ + + + +buffer (15 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    std::array< PodType, N > & data);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.data(),
+   data.size() * sizeof(PodType));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload16.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload16.html new file mode 100644 index 0000000..3cbd40c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload16.html @@ -0,0 +1,59 @@ + + + +buffer (16 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    std::array< PodType, N > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.data(),
+   min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload17.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload17.html new file mode 100644 index 0000000..0bf12d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload17.html @@ -0,0 +1,58 @@ + + + +buffer (17 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    std::array< const PodType, N > & data);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.data(),
+   data.size() * sizeof(PodType));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload18.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload18.html new file mode 100644 index 0000000..33b78be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload18.html @@ -0,0 +1,59 @@ + + + +buffer (18 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    std::array< const PodType, N > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.data(),
+   min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload19.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload19.html new file mode 100644 index 0000000..c3766af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload19.html @@ -0,0 +1,66 @@ + + + +buffer (19 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD vector. +

+
template<
+    typename PodType,
+    typename Allocator>
+mutable_buffer buffer(
+    std::vector< PodType, Allocator > & data);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.size() ? &data[0] : 0,
+   data.size() * sizeof(PodType));
+
+
+ + Remarks +
+

+ The buffer is invalidated by any vector operation that would also invalidate + iterators. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload2.html new file mode 100644 index 0000000..7076c72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload2.html @@ -0,0 +1,55 @@ + + + +buffer (2 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer from an existing buffer. +

+
mutable_buffer buffer(
+    const mutable_buffer & b,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   b.data(),
+   min(b.size(), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload20.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload20.html new file mode 100644 index 0000000..8286cd6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload20.html @@ -0,0 +1,67 @@ + + + +buffer (20 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD vector. +

+
template<
+    typename PodType,
+    typename Allocator>
+mutable_buffer buffer(
+    std::vector< PodType, Allocator > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.size() ? &data[0] : 0,
+   min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+
+ + Remarks +
+

+ The buffer is invalidated by any vector operation that would also invalidate + iterators. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload21.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload21.html new file mode 100644 index 0000000..269b526 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload21.html @@ -0,0 +1,66 @@ + + + +buffer (21 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD vector. +

+
template<
+    typename PodType,
+    typename Allocator>
+const_buffer buffer(
+    const std::vector< PodType, Allocator > & data);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.size() ? &data[0] : 0,
+   data.size() * sizeof(PodType));
+
+
+ + Remarks +
+

+ The buffer is invalidated by any vector operation that would also invalidate + iterators. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload22.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload22.html new file mode 100644 index 0000000..ac04514 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload22.html @@ -0,0 +1,67 @@ + + + +buffer (22 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD vector. +

+
template<
+    typename PodType,
+    typename Allocator>
+const_buffer buffer(
+    const std::vector< PodType, Allocator > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.size() ? &data[0] : 0,
+   min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+
+ + Remarks +
+

+ The buffer is invalidated by any vector operation that would also invalidate + iterators. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload23.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload23.html new file mode 100644 index 0000000..d3f82a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload23.html @@ -0,0 +1,63 @@ + + + +buffer (23 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+mutable_buffer buffer(
+    std::basic_string< Elem, Traits, Allocator > & data);
+
+
+ + Return + Value +
+

+ mutable_buffer(data.size() ? &data[0] : + 0, data.size() * sizeof(Elem)). +

+
+ + Remarks +
+

+ The buffer is invalidated by any non-const operation called on the given + string object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload24.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload24.html new file mode 100644 index 0000000..9f0a8d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload24.html @@ -0,0 +1,68 @@ + + + +buffer (24 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+mutable_buffer buffer(
+    std::basic_string< Elem, Traits, Allocator > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.size() ? &data[0] : 0,
+   min(data.size() * sizeof(Elem), max_size_in_bytes));
+
+
+ + Remarks +
+

+ The buffer is invalidated by any non-const operation called on the given + string object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload25.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload25.html new file mode 100644 index 0000000..6d341fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload25.html @@ -0,0 +1,62 @@ + + + +buffer (25 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+const_buffer buffer(
+    const std::basic_string< Elem, Traits, Allocator > & data);
+
+
+ + Return + Value +
+

+ const_buffer(data.data(), data.size() * sizeof(Elem)). +

+
+ + Remarks +
+

+ The buffer is invalidated by any non-const operation called on the given + string object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload26.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload26.html new file mode 100644 index 0000000..3476f8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload26.html @@ -0,0 +1,68 @@ + + + +buffer (26 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+const_buffer buffer(
+    const std::basic_string< Elem, Traits, Allocator > & data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.data(),
+   min(data.size() * sizeof(Elem), max_size_in_bytes));
+
+
+ + Remarks +
+

+ The buffer is invalidated by any non-const operation called on the given + string object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload27.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload27.html new file mode 100644 index 0000000..1ca5600 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload27.html @@ -0,0 +1,54 @@ + + + +buffer (27 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given string_view. +

+
template<
+    typename Elem,
+    typename Traits>
+const_buffer buffer(
+    basic_string_view< Elem, Traits > data);
+
+
+ + Return + Value +
+

+ mutable_buffer(data.size() ? &data[0] : + 0, data.size() * sizeof(Elem)). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload28.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload28.html new file mode 100644 index 0000000..a46407c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload28.html @@ -0,0 +1,59 @@ + + + +buffer (28 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits>
+const_buffer buffer(
+    basic_string_view< Elem, Traits > data,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.size() ? &data[0] : 0,
+   min(data.size() * sizeof(Elem), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload29.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload29.html new file mode 100644 index 0000000..9937397 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload29.html @@ -0,0 +1,61 @@ + + + +buffer (29 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+mutable_buffer buffer(
+    T & data,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.size() ? &data[0] : 0,
+   data.size() * sizeof(typename T::value_type));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload3.html new file mode 100644 index 0000000..41603fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload3.html @@ -0,0 +1,49 @@ + + + +buffer (3 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from an existing buffer. +

+
const_buffer buffer(
+    const const_buffer & b);
+
+
+ + Return + Value +
+

+ const_buffer(b). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload30.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload30.html new file mode 100644 index 0000000..16dab18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload30.html @@ -0,0 +1,64 @@ + + + +buffer (30 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+mutable_buffer buffer(
+    T & data,
+    std::size_t max_size_in_bytes,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   data.size() ? &data[0] : 0,
+   min(
+     data.size() * sizeof(typename T::value_type),
+     max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload31.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload31.html new file mode 100644 index 0000000..b7558b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload31.html @@ -0,0 +1,61 @@ + + + +buffer (31 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+const_buffer buffer(
+    T & data,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.size() ? &data[0] : 0,
+   data.size() * sizeof(typename T::value_type));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload32.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload32.html new file mode 100644 index 0000000..4e06ae0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload32.html @@ -0,0 +1,64 @@ + + + +buffer (32 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+const_buffer buffer(
+    T & data,
+    std::size_t max_size_in_bytes,
+    constraint_t< is_contiguous_iterator< typename T::iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_const< remove_reference_t< typename std::iterator_traits< typename T::iterator >::reference > >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.size() ? &data[0] : 0,
+   min(
+     data.size() * sizeof(typename T::value_type),
+     max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload33.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload33.html new file mode 100644 index 0000000..3688067 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload33.html @@ -0,0 +1,60 @@ + + + +buffer (33 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+const_buffer buffer(
+    const T & data,
+    constraint_t< is_contiguous_iterator< typename T::const_iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.size() ? &data[0] : 0,
+   data.size() * sizeof(typename T::value_type));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload34.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload34.html new file mode 100644 index 0000000..438234d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload34.html @@ -0,0 +1,63 @@ + + + +buffer (34 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from a contiguous container. +

+
template<
+    typename T>
+const_buffer buffer(
+    const T & data,
+    std::size_t max_size_in_bytes,
+    constraint_t< is_contiguous_iterator< typename T::const_iterator >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, const_buffer >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< !is_convertible< T, mutable_buffer >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   data.size() ? &data[0] : 0,
+   min(
+     data.size() * sizeof(typename T::value_type),
+     max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload35.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload35.html new file mode 100644 index 0000000..24e7368 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload35.html @@ -0,0 +1,57 @@ + + + +buffer (35 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer from a span. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+mutable_buffer buffer(
+    const Span< T, Extent > & span,
+    constraint_t< !is_const< T >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ mutable_buffer(span). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload36.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload36.html new file mode 100644 index 0000000..5529644 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload36.html @@ -0,0 +1,64 @@ + + + +buffer (36 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer from a span. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+mutable_buffer buffer(
+    const Span< T, Extent > & span,
+    std::size_t max_size_in_bytes,
+    constraint_t< !is_const< T >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer b(span);
+mutable_buffer(
+    b.data(),
+    min(b.size(), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload37.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload37.html new file mode 100644 index 0000000..10ce7b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload37.html @@ -0,0 +1,56 @@ + + + +buffer (37 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from a span. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+const_buffer buffer(
+    const Span< const T, Extent > & span,
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ const_buffer(span). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload38.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload38.html new file mode 100644 index 0000000..41d9d8d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload38.html @@ -0,0 +1,63 @@ + + + +buffer (38 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from a span. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+const_buffer buffer(
+    const Span< const T, Extent > & span,
+    std::size_t max_size_in_bytes,
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer b1(b);
+const_buffer(
+    b1.data(),
+    min(b1.size(), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload39.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload39.html new file mode 100644 index 0000000..bb6bbfd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload39.html @@ -0,0 +1,42 @@ + + + +buffer (39 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a buffer representing the entire registered buffer. +

+
mutable_registered_buffer buffer(
+    const mutable_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload4.html new file mode 100644 index 0000000..3e3ec4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload4.html @@ -0,0 +1,55 @@ + + + +buffer (4 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer from an existing buffer. +

+
const_buffer buffer(
+    const const_buffer & b,
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   b.data(),
+   min(b.size(), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload40.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload40.html new file mode 100644 index 0000000..6be94b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload40.html @@ -0,0 +1,42 @@ + + + +buffer (40 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a buffer representing the entire registered buffer. +

+
const_registered_buffer buffer(
+    const const_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload41.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload41.html new file mode 100644 index 0000000..72687dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload41.html @@ -0,0 +1,43 @@ + + + +buffer (41 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a buffer representing part of a registered buffer. +

+
mutable_registered_buffer buffer(
+    const mutable_registered_buffer & b,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload42.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload42.html new file mode 100644 index 0000000..a5d587e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload42.html @@ -0,0 +1,43 @@ + + + +buffer (42 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a buffer representing part of a registered buffer. +

+
const_registered_buffer buffer(
+    const const_registered_buffer & b,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload5.html new file mode 100644 index 0000000..dcbd38b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload5.html @@ -0,0 +1,50 @@ + + + +buffer (5 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given memory range. +

+
mutable_buffer buffer(
+    void * data,
+    std::size_t size_in_bytes);
+
+
+ + Return + Value +
+

+ mutable_buffer(data, size_in_bytes). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload6.html new file mode 100644 index 0000000..ef156cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload6.html @@ -0,0 +1,50 @@ + + + +buffer (6 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given memory range. +

+
const_buffer buffer(
+    const void * data,
+    std::size_t size_in_bytes);
+
+
+ + Return + Value +
+

+ const_buffer(data, size_in_bytes). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload7.html new file mode 100644 index 0000000..1546fb0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload7.html @@ -0,0 +1,57 @@ + + + +buffer (7 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    PodType((&data)[N]);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   static_cast<void*>(data),
+   N * sizeof(PodType));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload8.html new file mode 100644 index 0000000..fee57d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload8.html @@ -0,0 +1,58 @@ + + + +buffer (8 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+mutable_buffer buffer(
+    PodType((&data)[N],
+    std::size_t max_size_in_bytes);
+
+
+ + Return + Value +
+

+ A mutable_buffer + value equivalent to: +

+
mutable_buffer(
+   static_cast<void*>(data),
+   min(N * sizeof(PodType), max_size_in_bytes));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload9.html new file mode 100644 index 0000000..f7b45b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer/overload9.html @@ -0,0 +1,57 @@ + + + +buffer (9 of 42 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that represents the given POD array. +

+
template<
+    typename PodType,
+    std::size_t N>
+const_buffer buffer(
+    const PodType((&data)[N]);
+
+
+ + Return + Value +
+

+ A const_buffer + value equivalent to: +

+
const_buffer(
+   static_cast<const void*>(data),
+   N * sizeof(PodType));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_copy.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_copy.html new file mode 100644 index 0000000..9906e8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_copy.html @@ -0,0 +1,113 @@ + + + +buffer_copy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The buffer_copy + function is used to copy bytes from a source buffer (or buffer sequence) + to a target buffer (or buffer sequence). +

+

+ Copies bytes from a source buffer sequence to a target buffer sequence. +

+
template<
+    typename MutableBufferSequence,
+    typename ConstBufferSequence>
+std::size_t buffer_copy(
+    const MutableBufferSequence & target,
+    const ConstBufferSequence & source);
+  » more...
+
+

+ Copies a limited number of bytes from a source buffer sequence to a target + buffer sequence. +

+
template<
+    typename MutableBufferSequence,
+    typename ConstBufferSequence>
+std::size_t buffer_copy(
+    const MutableBufferSequence & target,
+    const ConstBufferSequence & source,
+    std::size_t max_bytes_to_copy);
+  » more...
+
+

+ The buffer_copy function + is available in two forms: +

+
    +
  • + A 2-argument form: buffer_copy(target, source) +
    • +
  • + 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) +
    • +
  • + buffer_size(source) +
    • +
  • + If specified, max_bytes_to_copy. +
    • +
+

+ This prevents buffer overflow, regardless of the buffer sizes used in the + copy operation. +

+

+ Note that buffer_copy + is implemented in terms of memcpy, + and consequently it cannot be used to copy between overlapping memory regions. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_copy/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_copy/overload1.html new file mode 100644 index 0000000..4fa10f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_copy/overload1.html @@ -0,0 +1,92 @@ + + + +buffer_copy (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copies bytes from a source buffer sequence to a target buffer sequence. +

+
template<
+    typename MutableBufferSequence,
+    typename ConstBufferSequence>
+std::size_t buffer_copy(
+    const MutableBufferSequence & target,
+    const ConstBufferSequence & source);
+
+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes copied. +

+
+ + Remarks +
+

+ The number of bytes copied is the lesser of: +

+
    +
  • + buffer_size(target) +
    • +
  • + buffer_size(source) +
    • +
+

+ This function is implemented in terms of memcpy, + and consequently it cannot be used to copy between overlapping memory regions. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_copy/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_copy/overload2.html new file mode 100644 index 0000000..32d1567 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_copy/overload2.html @@ -0,0 +1,101 @@ + + + +buffer_copy (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copies a limited number of bytes from a source buffer sequence to a target + buffer sequence. +

+
template<
+    typename MutableBufferSequence,
+    typename ConstBufferSequence>
+std::size_t buffer_copy(
+    const MutableBufferSequence & target,
+    const ConstBufferSequence & source,
+    std::size_t max_bytes_to_copy);
+
+
+ + Parameters +
+
+

+
+
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. +

+
max_bytes_to_copy
+

+ The maximum number of bytes to be copied. +

+
+
+
+ + Return + Value +
+

+ The number of bytes copied. +

+
+ + Remarks +
+

+ The number of bytes copied is the lesser of: +

+
    +
  • + buffer_size(target) +
    • +
  • + buffer_size(source) +
    • +
  • + max_bytes_to_copy +
    • +
+

+ This function is implemented in terms of memcpy, + and consequently it cannot be used to copy between overlapping memory regions. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf.html new file mode 100644 index 0000000..2f5909c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf.html @@ -0,0 +1,66 @@ + + + +buffer_literals::operator""_buf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Literal operator for creating const_buffer objects from string + literals. +

+
const_buffer operator""_buf(
+    const char * data,
+    std::size_t n);
+  » more...
+
+

+ Literal operator for creating const_buffer objects from unbounded + binary or hexadecimal integer literals. +

+
template<
+    char... Chars>
+const_buffer operator""_buf();
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf/overload1.html new file mode 100644 index 0000000..be1764f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf/overload1.html @@ -0,0 +1,44 @@ + + + +buffer_literals::operator""_buf (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Literal operator for creating const_buffer objects from string + literals. +

+
const_buffer operator""_buf(
+    const char * data,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf/overload2.html new file mode 100644 index 0000000..359a518 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_literals__operator_quot__quot__buf/overload2.html @@ -0,0 +1,44 @@ + + + +buffer_literals::operator""_buf (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Literal operator for creating const_buffer objects from unbounded + binary or hexadecimal integer literals. +

+
template<
+    char... Chars>
+const_buffer operator""_buf();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration.html new file mode 100644 index 0000000..5803600 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration.html @@ -0,0 +1,268 @@ + + + +buffer_registration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Automatically registers and unregistered buffers with an execution context. +

+
template<
+    typename MutableBufferSequence,
+    typename Allocator = std::allocator<void>>
+class buffer_registration
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type used for allocating storage for the buffers + container. +

+
+

+ const_iterator +

+ 		+

+ The type of a const iterator over the registered buffers. +

+
+

+ iterator +

+ 		+

+ The type of an iterator over the registered buffers. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ at +

+ 		+

+ Get the buffer at the specified index. +

+
+

+ begin +

+ 		+

+ Get the begin iterator for the sequence of registered buffers. +

+
+

+ buffer_registration [constructor] +

+ 		+

+ Register buffers with an executor's execution context.
— +
Register buffers with an execution context.
—
+ Move constructor. +

+
+

+ cbegin +

+ 		+

+ Get the begin iterator for the sequence of registered buffers. +

+
+

+ cend +

+ 		+

+ Get the end iterator for the sequence of registered buffers. +

+
+

+ end +

+ 		+

+ Get the end iterator for the sequence of registered buffers. +

+
+

+ operator= +

+ 		+

+ Move assignment. +

+
+

+ operator[] +

+ 		+

+ Get the buffer at the specified index. +

+
+

+ size +

+ 		+

+ Get the number of registered buffers. +

+
+

+ ~buffer_registration [destructor] +

+ 		+

+ Unregisters the buffers. +

+
+

+ For portability, applications should assume that only one registration is + permitted per execution context. +

+
+ + Requirements +
+

+ Header: asio/buffer_registration.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/_buffer_registration.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/_buffer_registration.html new file mode 100644 index 0000000..4c2bb9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/_buffer_registration.html @@ -0,0 +1,42 @@ + + + +buffer_registration::~buffer_registration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Unregisters + the buffers. +

+
~buffer_registration();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/allocator_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/allocator_type.html new file mode 100644 index 0000000..4e8bfc6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/allocator_type.html @@ -0,0 +1,52 @@ + + + +buffer_registration::allocator_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + allocator type used for allocating storage for the buffers container. +

+
typedef Allocator allocator_type;
+
+
+ + Requirements +
+

+ Header: asio/buffer_registration.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/at.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/at.html new file mode 100644 index 0000000..40d1d93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/at.html @@ -0,0 +1,43 @@ + + + +buffer_registration::at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the buffer + at the specified index. +

+
const mutable_registered_buffer & at(
+    std::size_t i);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/begin.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/begin.html new file mode 100644 index 0000000..a2d9fa5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/begin.html @@ -0,0 +1,42 @@ + + + +buffer_registration::begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + begin iterator for the sequence of registered buffers. +

+
const_iterator begin() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration.html new file mode 100644 index 0000000..0e37b39 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration.html @@ -0,0 +1,68 @@ + + + +buffer_registration::buffer_registration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Register + buffers with an executor's execution context. +

+
template<
+    typename Executor>
+buffer_registration(
+    const Executor & ex,
+    const MutableBufferSequence & buffer_sequence,
+    const allocator_type & alloc = allocator_type(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ Register buffers with an execution context. +

+
template<
+    typename ExecutionContext>
+buffer_registration(
+    ExecutionContext & ctx,
+    const MutableBufferSequence & buffer_sequence,
+    const allocator_type & alloc = allocator_type(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move constructor. +

+
buffer_registration(
+    buffer_registration && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload1.html new file mode 100644 index 0000000..3a4ea8e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload1.html @@ -0,0 +1,47 @@ + + + +buffer_registration::buffer_registration (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Register buffers with an executor's execution context. +

+
template<
+    typename Executor>
+buffer_registration(
+    const Executor & ex,
+    const MutableBufferSequence & buffer_sequence,
+    const allocator_type & alloc = allocator_type(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload2.html new file mode 100644 index 0000000..3139534 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload2.html @@ -0,0 +1,47 @@ + + + +buffer_registration::buffer_registration (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Register buffers with an execution context. +

+
template<
+    typename ExecutionContext>
+buffer_registration(
+    ExecutionContext & ctx,
+    const MutableBufferSequence & buffer_sequence,
+    const allocator_type & alloc = allocator_type(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload3.html new file mode 100644 index 0000000..a297259 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/buffer_registration/overload3.html @@ -0,0 +1,42 @@ + + + +buffer_registration::buffer_registration (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
buffer_registration(
+    buffer_registration && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/cbegin.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/cbegin.html new file mode 100644 index 0000000..652132c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/cbegin.html @@ -0,0 +1,42 @@ + + + +buffer_registration::cbegin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + begin iterator for the sequence of registered buffers. +

+
const_iterator cbegin() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/cend.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/cend.html new file mode 100644 index 0000000..d29717f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/cend.html @@ -0,0 +1,42 @@ + + + +buffer_registration::cend + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the end + iterator for the sequence of registered buffers. +

+
const_iterator cend() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/const_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/const_iterator.html new file mode 100644 index 0000000..9675251 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/const_iterator.html @@ -0,0 +1,52 @@ + + + +buffer_registration::const_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of a const iterator over the registered buffers. +

+
typedef unspecified const_iterator;
+
+
+ + Requirements +
+

+ Header: asio/buffer_registration.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/end.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/end.html new file mode 100644 index 0000000..a8a5303 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/end.html @@ -0,0 +1,42 @@ + + + +buffer_registration::end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the end + iterator for the sequence of registered buffers. +

+
const_iterator end() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/iterator.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/iterator.html new file mode 100644 index 0000000..f213940 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/iterator.html @@ -0,0 +1,52 @@ + + + +buffer_registration::iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of an iterator over the registered buffers. +

+
typedef unspecified iterator;
+
+
+ + Requirements +
+

+ Header: asio/buffer_registration.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/operator_eq_.html new file mode 100644 index 0000000..455b2ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/operator_eq_.html @@ -0,0 +1,43 @@ + + + +buffer_registration::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move + assignment. +

+
buffer_registration & operator=(
+    buffer_registration && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/operator_lb__rb_.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/operator_lb__rb_.html new file mode 100644 index 0000000..a8d6c6b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/operator_lb__rb_.html @@ -0,0 +1,43 @@ + + + +buffer_registration::operator[] + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the buffer at the specified index. +

+
const mutable_registered_buffer & operator[](
+    std::size_t i);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/size.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/size.html new file mode 100644 index 0000000..e7d4233 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_registration/size.html @@ -0,0 +1,42 @@ + + + +buffer_registration::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the number + of registered buffers. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin.html new file mode 100644 index 0000000..c967cff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin.html @@ -0,0 +1,109 @@ + + + +buffer_sequence_begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The buffer_sequence_begin + function returns an iterator pointing to the first element in a buffer sequence. +

+

+ Get an iterator to the first element in a buffer sequence. +

+
template<
+    typename MutableBuffer>
+const mutable_buffer * buffer_sequence_begin(
+    const MutableBuffer & b,
+    constraint_t< is_convertible< const MutableBuffer *, const mutable_buffer * >::value >  = 0);
+  » more...
+
+template<
+    typename ConstBuffer>
+const const_buffer * buffer_sequence_begin(
+    const ConstBuffer & b,
+    constraint_t< is_convertible< const ConstBuffer *, const const_buffer * >::value >  = 0);
+  » more...
+
+template<
+    typename ConvertibleToBuffer>
+const ConvertibleToBuffer * buffer_sequence_begin(
+    const ConvertibleToBuffer & b,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const const_buffer * >::value >  = 0,
+    constraint_t< is_convertible< ConvertibleToBuffer, mutable_buffer >::value||is_convertible< ConvertibleToBuffer, const_buffer >::value >  = 0);
+  » more...
+
+template<
+    typename C>
+auto buffer_sequence_begin(
+    C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+  » more...
+
+template<
+    typename C>
+auto buffer_sequence_begin(
+    const C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+  » more...
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
const mutable_buffer * buffer_sequence_begin(
+    const mutable_registered_buffer & b);
+  » more...
+
+const const_buffer * buffer_sequence_begin(
+    const const_registered_buffer & b);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload1.html new file mode 100644 index 0000000..d68c7f8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload1.html @@ -0,0 +1,45 @@ + + + +buffer_sequence_begin (1 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
template<
+    typename MutableBuffer>
+const mutable_buffer * buffer_sequence_begin(
+    const MutableBuffer & b,
+    constraint_t< is_convertible< const MutableBuffer *, const mutable_buffer * >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload2.html new file mode 100644 index 0000000..1e0caa1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload2.html @@ -0,0 +1,45 @@ + + + +buffer_sequence_begin (2 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
template<
+    typename ConstBuffer>
+const const_buffer * buffer_sequence_begin(
+    const ConstBuffer & b,
+    constraint_t< is_convertible< const ConstBuffer *, const const_buffer * >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload3.html new file mode 100644 index 0000000..dcb05e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload3.html @@ -0,0 +1,47 @@ + + + +buffer_sequence_begin (3 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
template<
+    typename ConvertibleToBuffer>
+const ConvertibleToBuffer * buffer_sequence_begin(
+    const ConvertibleToBuffer & b,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const const_buffer * >::value >  = 0,
+    constraint_t< is_convertible< ConvertibleToBuffer, mutable_buffer >::value||is_convertible< ConvertibleToBuffer, const_buffer >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload4.html new file mode 100644 index 0000000..c15fb9f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload4.html @@ -0,0 +1,48 @@ + + + +buffer_sequence_begin (4 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
template<
+    typename C>
+auto buffer_sequence_begin(
+    C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload5.html new file mode 100644 index 0000000..63a9b1e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload5.html @@ -0,0 +1,48 @@ + + + +buffer_sequence_begin (5 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
template<
+    typename C>
+auto buffer_sequence_begin(
+    const C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload6.html new file mode 100644 index 0000000..7de00bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload6.html @@ -0,0 +1,42 @@ + + + +buffer_sequence_begin (6 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
const mutable_buffer * buffer_sequence_begin(
+    const mutable_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload7.html new file mode 100644 index 0000000..50df2a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_begin/overload7.html @@ -0,0 +1,42 @@ + + + +buffer_sequence_begin (7 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to the first element in a buffer sequence. +

+
const const_buffer * buffer_sequence_begin(
+    const const_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end.html new file mode 100644 index 0000000..31a0c63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end.html @@ -0,0 +1,110 @@ + + + +buffer_sequence_end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The buffer_sequence_end + function returns an iterator pointing to one past the end element in a buffer + sequence. +

+

+ Get an iterator to one past the end element in a buffer sequence. +

+
template<
+    typename MutableBuffer>
+const mutable_buffer * buffer_sequence_end(
+    const MutableBuffer & b,
+    constraint_t< is_convertible< const MutableBuffer *, const mutable_buffer * >::value >  = 0);
+  » more...
+
+template<
+    typename ConstBuffer>
+const const_buffer * buffer_sequence_end(
+    const ConstBuffer & b,
+    constraint_t< is_convertible< const ConstBuffer *, const const_buffer * >::value >  = 0);
+  » more...
+
+template<
+    typename ConvertibleToBuffer>
+const ConvertibleToBuffer * buffer_sequence_end(
+    const ConvertibleToBuffer & b,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const const_buffer * >::value >  = 0,
+    constraint_t< is_convertible< ConvertibleToBuffer, mutable_buffer >::value||is_convertible< ConvertibleToBuffer, const_buffer >::value >  = 0);
+  » more...
+
+template<
+    typename C>
+auto buffer_sequence_end(
+    C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+  » more...
+
+template<
+    typename C>
+auto buffer_sequence_end(
+    const C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+  » more...
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
const mutable_buffer * buffer_sequence_end(
+    const mutable_registered_buffer & b);
+  » more...
+
+const const_buffer * buffer_sequence_end(
+    const const_registered_buffer & b);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload1.html new file mode 100644 index 0000000..e2ba952 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload1.html @@ -0,0 +1,45 @@ + + + +buffer_sequence_end (1 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
template<
+    typename MutableBuffer>
+const mutable_buffer * buffer_sequence_end(
+    const MutableBuffer & b,
+    constraint_t< is_convertible< const MutableBuffer *, const mutable_buffer * >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload2.html new file mode 100644 index 0000000..aee8282 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload2.html @@ -0,0 +1,45 @@ + + + +buffer_sequence_end (2 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
template<
+    typename ConstBuffer>
+const const_buffer * buffer_sequence_end(
+    const ConstBuffer & b,
+    constraint_t< is_convertible< const ConstBuffer *, const const_buffer * >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload3.html new file mode 100644 index 0000000..9fe1459 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload3.html @@ -0,0 +1,47 @@ + + + +buffer_sequence_end (3 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
template<
+    typename ConvertibleToBuffer>
+const ConvertibleToBuffer * buffer_sequence_end(
+    const ConvertibleToBuffer & b,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const ConvertibleToBuffer *, const const_buffer * >::value >  = 0,
+    constraint_t< is_convertible< ConvertibleToBuffer, mutable_buffer >::value||is_convertible< ConvertibleToBuffer, const_buffer >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload4.html new file mode 100644 index 0000000..32448fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload4.html @@ -0,0 +1,48 @@ + + + +buffer_sequence_end (4 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
template<
+    typename C>
+auto buffer_sequence_end(
+    C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload5.html new file mode 100644 index 0000000..7e78275 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload5.html @@ -0,0 +1,48 @@ + + + +buffer_sequence_end (5 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
template<
+    typename C>
+auto buffer_sequence_end(
+    const C & c,
+    constraint_t< !is_convertible< const C *, const mutable_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< const C *, const const_buffer * >::value >  = 0,
+    constraint_t< !is_convertible< C, mutable_buffer >::value >  = 0,
+    constraint_t< !is_convertible< C, const_buffer >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload6.html new file mode 100644 index 0000000..12faa35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload6.html @@ -0,0 +1,42 @@ + + + +buffer_sequence_end (6 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
const mutable_buffer * buffer_sequence_end(
+    const mutable_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload7.html new file mode 100644 index 0000000..cf71817 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_sequence_end/overload7.html @@ -0,0 +1,42 @@ + + + +buffer_sequence_end (7 of 7 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get an iterator to one past the end element in a buffer sequence. +

+
const const_buffer * buffer_sequence_end(
+    const const_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/buffer_size.html new file mode 100644 index 0000000..544efb8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffer_size.html @@ -0,0 +1,77 @@ + + + +buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Get the total number of bytes in a buffer sequence. +

+
template<
+    typename BufferSequence>
+std::size_t buffer_size(
+    const BufferSequence & b);
+
+

+ The buffer_size function + determines the total size of all buffers in the buffer sequence, as if computed + as follows: +

+
size_t total_size = 0;
+auto i = asio::buffer_sequence_begin(buffers);
+auto end = asio::buffer_sequence_end(buffers);
+for (; i != end; ++i)
+{
+  const_buffer b(*i);
+  total_size += b.size();
+}
+return total_size;
+
+

+ The BufferSequence template + parameter may meet either of the ConstBufferSequence + or MutableBufferSequence + type requirements. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream.html new file mode 100644 index 0000000..2d6832f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream.html @@ -0,0 +1,363 @@ + + + +buffered_read_stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adds buffering to the read-related operations of a stream. +

+
template<
+    typename Stream>
+class buffered_read_stream :
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ The type of the lowest layer. +

+
+

+ next_layer_type +

+ 		+

+ The type of the next layer. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_fill +

+ 		+

+ Start an asynchronous fill. +

+
+

+ 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. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. The data being written must be valid + for the lifetime of the asynchronous operation. +

+
+

+ buffered_read_stream [constructor] +

+ 		+

+ Construct, passing the specified argument to initialise the next + layer. +

+
+

+ close +

+ 		+

+ Close the stream. +

+
+

+ 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. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ in_avail +

+ 		+

+ Determine the amount of data that may be read without blocking. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ next_layer +

+ 		+

+ Get a reference to the next layer. +

+
+

+ 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. +

+
+

+ 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. +

+
+

+ 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. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_buffer_size [static] +

+ 		+

+ The default buffer size. +

+
+

+ The buffered_read_stream + class template can be used to add buffering to the synchronous and asynchronous + read operations of a stream. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/buffered_read_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_fill.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_fill.html new file mode 100644 index 0000000..719cedd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_fill.html @@ -0,0 +1,52 @@ + + + +buffered_read_stream::async_fill + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous fill. +

+
template<
+    typename ReadHandler = default_completion_token_t<executor_type>>
+DEDUCED async_fill(
+    ReadHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_read_some.html new file mode 100644 index 0000000..5f31830 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_read_some.html @@ -0,0 +1,55 @@ + + + +buffered_read_stream::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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 MutableBufferSequence,
+    typename ReadHandler = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_write_some.html new file mode 100644 index 0000000..397b552 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/async_write_some.html @@ -0,0 +1,55 @@ + + + +buffered_read_stream::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. The data being written must be valid for the lifetime + of the asynchronous operation. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteHandler = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream.html new file mode 100644 index 0000000..834a119 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream.html @@ -0,0 +1,53 @@ + + + +buffered_read_stream::buffered_read_stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct, + passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+explicit buffered_read_stream(
+    Arg && a);
+  » more...
+
+template<
+    typename Arg>
+buffered_read_stream(
+    Arg && a,
+    std::size_t buffer_size);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream/overload1.html new file mode 100644 index 0000000..9196414 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream/overload1.html @@ -0,0 +1,44 @@ + + + +buffered_read_stream::buffered_read_stream (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct, passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+buffered_read_stream(
+    Arg && a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream/overload2.html new file mode 100644 index 0000000..b1a4dd5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/buffered_read_stream/overload2.html @@ -0,0 +1,45 @@ + + + +buffered_read_stream::buffered_read_stream (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct, passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+buffered_read_stream(
+    Arg && a,
+    std::size_t buffer_size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close.html new file mode 100644 index 0000000..9cade52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close.html @@ -0,0 +1,47 @@ + + + +buffered_read_stream::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the stream. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close/overload1.html new file mode 100644 index 0000000..9a4aca7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_read_stream::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the stream. +

+
void close();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close/overload2.html new file mode 100644 index 0000000..9deb150 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/close/overload2.html @@ -0,0 +1,42 @@ + + + +buffered_read_stream::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the stream. +

+
void close(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/default_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/default_buffer_size.html new file mode 100644 index 0000000..d46fb34 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/default_buffer_size.html @@ -0,0 +1,42 @@ + + + +buffered_read_stream::default_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + default buffer size. +

+
static const std::size_t default_buffer_size = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/executor_type.html new file mode 100644 index 0000000..4790579 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/executor_type.html @@ -0,0 +1,52 @@ + + + +buffered_read_stream::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef lowest_layer_type::executor_type executor_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_read_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill.html new file mode 100644 index 0000000..8fc9f4f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill.html @@ -0,0 +1,52 @@ + + + +buffered_read_stream::fill + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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();
+  » more...
+
+

+ 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(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill/overload1.html new file mode 100644 index 0000000..6925748 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill/overload1.html @@ -0,0 +1,42 @@ + + + +buffered_read_stream::fill (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill/overload2.html new file mode 100644 index 0000000..a40adee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/fill/overload2.html @@ -0,0 +1,43 @@ + + + +buffered_read_stream::fill (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/get_executor.html new file mode 100644 index 0000000..8f1333d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/get_executor.html @@ -0,0 +1,42 @@ + + + +buffered_read_stream::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail.html new file mode 100644 index 0000000..8358415 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail.html @@ -0,0 +1,47 @@ + + + +buffered_read_stream::in_avail + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the amount of data that may be read without blocking. +

+
std::size_t in_avail();
+  » more...
+
+std::size_t in_avail(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail/overload1.html new file mode 100644 index 0000000..0e44120 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_read_stream::in_avail (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the amount of data that may be read without blocking. +

+
std::size_t in_avail();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail/overload2.html new file mode 100644 index 0000000..b87de2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/in_avail/overload2.html @@ -0,0 +1,42 @@ + + + +buffered_read_stream::in_avail (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the amount of data that may be read without blocking. +

+
std::size_t in_avail(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer.html new file mode 100644 index 0000000..6cbb5dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer.html @@ -0,0 +1,49 @@ + + + +buffered_read_stream::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer/overload1.html new file mode 100644 index 0000000..8ade52e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_read_stream::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer/overload2.html new file mode 100644 index 0000000..f99c51d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer/overload2.html @@ -0,0 +1,41 @@ + + + +buffered_read_stream::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer_type.html new file mode 100644 index 0000000..797e35a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/lowest_layer_type.html @@ -0,0 +1,52 @@ + + + +buffered_read_stream::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the lowest layer. +

+
typedef next_layer_type::lowest_layer_type lowest_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_read_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/next_layer.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/next_layer.html new file mode 100644 index 0000000..68348e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/next_layer.html @@ -0,0 +1,42 @@ + + + +buffered_read_stream::next_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the next layer. +

+
next_layer_type & next_layer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/next_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/next_layer_type.html new file mode 100644 index 0000000..1e333d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/next_layer_type.html @@ -0,0 +1,52 @@ + + + +buffered_read_stream::next_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the next layer. +

+
typedef remove_reference_t< Stream > next_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_read_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek.html new file mode 100644 index 0000000..de7aba1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek.html @@ -0,0 +1,58 @@ + + + +buffered_read_stream::peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Peek at + the incoming data on the stream. Returns the number of bytes read. Throws + an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers);
+  » more...
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes read, + or 0 if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek/overload1.html new file mode 100644 index 0000000..ae1de8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_read_stream::peek (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes + read. Throws an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek/overload2.html new file mode 100644 index 0000000..cdac953 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/peek/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_read_stream::peek (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes + read, or 0 if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some.html new file mode 100644 index 0000000..30d22f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some.html @@ -0,0 +1,58 @@ + + + +buffered_read_stream::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the stream. Returns the number of bytes read. Throws an + exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+

+ Read some data from the stream. Returns the number of bytes read or 0 if + an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some/overload1.html new file mode 100644 index 0000000..1954d12 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_read_stream::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. Returns the number of bytes read. Throws + an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some/overload2.html new file mode 100644 index 0000000..b50610c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/read_some/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_read_stream::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. Returns the number of bytes read or 0 + if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some.html new file mode 100644 index 0000000..2f0baf7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some.html @@ -0,0 +1,58 @@ + + + +buffered_read_stream::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + the given data to the stream. Returns the number of bytes written. Throws + an exception on failure. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+

+ Write the given data to the stream. Returns the number of bytes written, + or 0 if an error occurred. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some/overload1.html new file mode 100644 index 0000000..fc156ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_read_stream::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write the given data to the stream. Returns the number of bytes written. + Throws an exception on failure. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some/overload2.html new file mode 100644 index 0000000..b25a349 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_read_stream/write_some/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_read_stream::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write the given data to the stream. Returns the number of bytes written, + or 0 if an error occurred. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream.html new file mode 100644 index 0000000..e11889e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream.html @@ -0,0 +1,358 @@ + + + +buffered_stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adds buffering to the read- and write-related operations of a stream. +

+
template<
+    typename Stream>
+class buffered_stream :
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ The type of the lowest layer. +

+
+

+ next_layer_type +

+ 		+

+ The type of the next layer. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_fill +

+ 		+

+ Start an asynchronous fill. +

+
+

+ async_flush +

+ 		+

+ Start an asynchronous flush. +

+
+

+ 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. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. The data being written must be valid + for the lifetime of the asynchronous operation. +

+
+

+ buffered_stream [constructor] +

+ 		+

+ Construct, passing the specified argument to initialise the next + layer. +

+
+

+ close +

+ 		+

+ Close the stream. +

+
+

+ 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. +

+
+

+ 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. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ in_avail +

+ 		+

+ Determine the amount of data that may be read without blocking. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ next_layer +

+ 		+

+ Get a reference to the next layer. +

+
+

+ 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. +

+
+

+ 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. +

+
+

+ 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. +

+
+

+ The buffered_stream + class template can be used to add buffering to the synchronous and asynchronous + read and write operations of a stream. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/buffered_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_fill.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_fill.html new file mode 100644 index 0000000..b37ab5f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_fill.html @@ -0,0 +1,52 @@ + + + +buffered_stream::async_fill + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous fill. +

+
template<
+    typename ReadHandler = default_completion_token_t<executor_type>>
+DEDUCED async_fill(
+    ReadHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_flush.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_flush.html new file mode 100644 index 0000000..b2f170c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_flush.html @@ -0,0 +1,52 @@ + + + +buffered_stream::async_flush + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous flush. +

+
template<
+    typename WriteHandler = default_completion_token_t<executor_type>>
+DEDUCED async_flush(
+    WriteHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_read_some.html new file mode 100644 index 0000000..23bb4c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_read_some.html @@ -0,0 +1,55 @@ + + + +buffered_stream::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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 MutableBufferSequence,
+    typename ReadHandler = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_write_some.html new file mode 100644 index 0000000..2b39af6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/async_write_some.html @@ -0,0 +1,55 @@ + + + +buffered_stream::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. The data being written must be valid for the lifetime + of the asynchronous operation. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteHandler = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream.html new file mode 100644 index 0000000..07f6469 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream.html @@ -0,0 +1,54 @@ + + + +buffered_stream::buffered_stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct, + passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+explicit buffered_stream(
+    Arg && a);
+  » more...
+
+template<
+    typename Arg>
+explicit buffered_stream(
+    Arg && a,
+    std::size_t read_buffer_size,
+    std::size_t write_buffer_size);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream/overload1.html new file mode 100644 index 0000000..17e32fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream/overload1.html @@ -0,0 +1,44 @@ + + + +buffered_stream::buffered_stream (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct, passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+buffered_stream(
+    Arg && a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream/overload2.html new file mode 100644 index 0000000..6e0cdb6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/buffered_stream/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_stream::buffered_stream (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct, passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+buffered_stream(
+    Arg && a,
+    std::size_t read_buffer_size,
+    std::size_t write_buffer_size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close.html new file mode 100644 index 0000000..3e0a5be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close.html @@ -0,0 +1,46 @@ + + + +buffered_stream::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close the stream. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close/overload1.html new file mode 100644 index 0000000..4be64ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_stream::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the stream. +

+
void close();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close/overload2.html new file mode 100644 index 0000000..cd5faf9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/close/overload2.html @@ -0,0 +1,42 @@ + + + +buffered_stream::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the stream. +

+
void close(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/executor_type.html new file mode 100644 index 0000000..3a4aaab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/executor_type.html @@ -0,0 +1,52 @@ + + + +buffered_stream::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef lowest_layer_type::executor_type executor_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill.html new file mode 100644 index 0000000..3239ffa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill.html @@ -0,0 +1,52 @@ + + + +buffered_stream::fill + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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();
+  » more...
+
+

+ 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(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill/overload1.html new file mode 100644 index 0000000..6da8558 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill/overload1.html @@ -0,0 +1,42 @@ + + + +buffered_stream::fill (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill/overload2.html new file mode 100644 index 0000000..bcf4892 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/fill/overload2.html @@ -0,0 +1,43 @@ + + + +buffered_stream::fill (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush.html new file mode 100644 index 0000000..0abd26f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush.html @@ -0,0 +1,53 @@ + + + +buffered_stream::flush + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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 flush();
+  » 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. +

+
std::size_t flush(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush/overload1.html new file mode 100644 index 0000000..1c606d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush/overload1.html @@ -0,0 +1,43 @@ + + + +buffered_stream::flush (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 flush();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush/overload2.html new file mode 100644 index 0000000..72c036d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/flush/overload2.html @@ -0,0 +1,44 @@ + + + +buffered_stream::flush (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/get_executor.html new file mode 100644 index 0000000..240d0c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/get_executor.html @@ -0,0 +1,42 @@ + + + +buffered_stream::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail.html new file mode 100644 index 0000000..6781f5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail.html @@ -0,0 +1,47 @@ + + + +buffered_stream::in_avail + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the amount of data that may be read without blocking. +

+
std::size_t in_avail();
+  » more...
+
+std::size_t in_avail(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail/overload1.html new file mode 100644 index 0000000..e18f66d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_stream::in_avail (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the amount of data that may be read without blocking. +

+
std::size_t in_avail();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail/overload2.html new file mode 100644 index 0000000..3a657f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/in_avail/overload2.html @@ -0,0 +1,42 @@ + + + +buffered_stream::in_avail (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the amount of data that may be read without blocking. +

+
std::size_t in_avail(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer.html new file mode 100644 index 0000000..a360ef0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer.html @@ -0,0 +1,49 @@ + + + +buffered_stream::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer/overload1.html new file mode 100644 index 0000000..ddcea3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_stream::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer/overload2.html new file mode 100644 index 0000000..5da52de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer/overload2.html @@ -0,0 +1,41 @@ + + + +buffered_stream::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer_type.html new file mode 100644 index 0000000..a45bd8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/lowest_layer_type.html @@ -0,0 +1,52 @@ + + + +buffered_stream::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the lowest layer. +

+
typedef next_layer_type::lowest_layer_type lowest_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/next_layer.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/next_layer.html new file mode 100644 index 0000000..e1f780e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/next_layer.html @@ -0,0 +1,42 @@ + + + +buffered_stream::next_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a + reference to the next layer. +

+
next_layer_type & next_layer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/next_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/next_layer_type.html new file mode 100644 index 0000000..2a13795 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/next_layer_type.html @@ -0,0 +1,52 @@ + + + +buffered_stream::next_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the next layer. +

+
typedef remove_reference_t< Stream > next_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek.html new file mode 100644 index 0000000..3e539ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek.html @@ -0,0 +1,58 @@ + + + +buffered_stream::peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Peek at the incoming + data on the stream. Returns the number of bytes read. Throws an exception + on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers);
+  » more...
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes read, + or 0 if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek/overload1.html new file mode 100644 index 0000000..8405628 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_stream::peek (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes + read. Throws an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek/overload2.html new file mode 100644 index 0000000..c081d63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/peek/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_stream::peek (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes + read, or 0 if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some.html new file mode 100644 index 0000000..a21689e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some.html @@ -0,0 +1,58 @@ + + + +buffered_stream::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read some + data from the stream. Returns the number of bytes read. Throws an exception + on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+

+ Read some data from the stream. Returns the number of bytes read or 0 if + an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some/overload1.html new file mode 100644 index 0000000..2d8e043 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_stream::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. Returns the number of bytes read. Throws + an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some/overload2.html new file mode 100644 index 0000000..1bd1890 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/read_some/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_stream::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. Returns the number of bytes read or 0 + if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some.html new file mode 100644 index 0000000..99e06d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some.html @@ -0,0 +1,58 @@ + + + +buffered_stream::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + the given data to the stream. Returns the number of bytes written. Throws + an exception on failure. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+

+ Write the given data to the stream. Returns the number of bytes written, + or 0 if an error occurred. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some/overload1.html new file mode 100644 index 0000000..a0b7a6a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_stream::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write the given data to the stream. Returns the number of bytes written. + Throws an exception on failure. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some/overload2.html new file mode 100644 index 0000000..88ad698 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_stream/write_some/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_stream::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write the given data to the stream. Returns the number of bytes written, + or 0 if an error occurred. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream.html new file mode 100644 index 0000000..e9f0e02 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream.html @@ -0,0 +1,364 @@ + + + +buffered_write_stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adds buffering to the write-related operations of a stream. +

+
template<
+    typename Stream>
+class buffered_write_stream :
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ The type of the lowest layer. +

+
+

+ next_layer_type +

+ 		+

+ The type of the next layer. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_flush +

+ 		+

+ Start an asynchronous flush. +

+
+

+ 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. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. The data being written must be valid + for the lifetime of the asynchronous operation. +

+
+

+ buffered_write_stream [constructor] +

+ 		+

+ Construct, passing the specified argument to initialise the next + layer. +

+
+

+ close +

+ 		+

+ Close the stream. +

+
+

+ 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. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ in_avail +

+ 		+

+ Determine the amount of data that may be read without blocking. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ next_layer +

+ 		+

+ Get a reference to the next layer. +

+
+

+ 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. +

+
+

+ 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. +

+
+

+ 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. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_buffer_size [static] +

+ 		+

+ The default buffer size. +

+
+

+ The buffered_write_stream + class template can be used to add buffering to the synchronous and asynchronous + write operations of a stream. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/buffered_write_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_flush.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_flush.html new file mode 100644 index 0000000..54b8552 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_flush.html @@ -0,0 +1,52 @@ + + + +buffered_write_stream::async_flush + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous flush. +

+
template<
+    typename WriteHandler = default_completion_token_t<executor_type>>
+DEDUCED async_flush(
+    WriteHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_read_some.html new file mode 100644 index 0000000..80a4032 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_read_some.html @@ -0,0 +1,55 @@ + + + +buffered_write_stream::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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 MutableBufferSequence,
+    typename ReadHandler = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_write_some.html new file mode 100644 index 0000000..a52862b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/async_write_some.html @@ -0,0 +1,55 @@ + + + +buffered_write_stream::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. The data being written must be valid for the lifetime + of the asynchronous operation. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteHandler = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteHandler && handler = default_completion_token_t< executor_type >());
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream.html new file mode 100644 index 0000000..635840b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream.html @@ -0,0 +1,53 @@ + + + +buffered_write_stream::buffered_write_stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct, + passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+explicit buffered_write_stream(
+    Arg && a);
+  » more...
+
+template<
+    typename Arg>
+buffered_write_stream(
+    Arg && a,
+    std::size_t buffer_size);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream/overload1.html new file mode 100644 index 0000000..b205560 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream/overload1.html @@ -0,0 +1,44 @@ + + + +buffered_write_stream::buffered_write_stream (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct, passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+buffered_write_stream(
+    Arg && a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream/overload2.html new file mode 100644 index 0000000..8c9cbb4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/buffered_write_stream/overload2.html @@ -0,0 +1,45 @@ + + + +buffered_write_stream::buffered_write_stream (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct, passing the specified argument to initialise the next layer. +

+
template<
+    typename Arg>
+buffered_write_stream(
+    Arg && a,
+    std::size_t buffer_size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close.html new file mode 100644 index 0000000..8df8b4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close.html @@ -0,0 +1,47 @@ + + + +buffered_write_stream::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the stream. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close/overload1.html new file mode 100644 index 0000000..039cade --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_write_stream::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the stream. +

+
void close();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close/overload2.html new file mode 100644 index 0000000..67bc6ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/close/overload2.html @@ -0,0 +1,42 @@ + + + +buffered_write_stream::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the stream. +

+
void close(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/default_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/default_buffer_size.html new file mode 100644 index 0000000..64cf326 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/default_buffer_size.html @@ -0,0 +1,42 @@ + + + +buffered_write_stream::default_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + default buffer size. +

+
static const std::size_t default_buffer_size = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/executor_type.html new file mode 100644 index 0000000..0c39238 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/executor_type.html @@ -0,0 +1,52 @@ + + + +buffered_write_stream::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef lowest_layer_type::executor_type executor_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_write_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush.html new file mode 100644 index 0000000..c80873e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush.html @@ -0,0 +1,54 @@ + + + +buffered_write_stream::flush + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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 flush();
+  » 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. +

+
std::size_t flush(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush/overload1.html new file mode 100644 index 0000000..5e9b8ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush/overload1.html @@ -0,0 +1,43 @@ + + + +buffered_write_stream::flush (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 flush();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush/overload2.html new file mode 100644 index 0000000..f1f6898 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/flush/overload2.html @@ -0,0 +1,44 @@ + + + +buffered_write_stream::flush (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/get_executor.html new file mode 100644 index 0000000..aa51586 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/get_executor.html @@ -0,0 +1,42 @@ + + + +buffered_write_stream::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail.html new file mode 100644 index 0000000..d6df7a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail.html @@ -0,0 +1,47 @@ + + + +buffered_write_stream::in_avail + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the amount of data that may be read without blocking. +

+
std::size_t in_avail();
+  » more...
+
+std::size_t in_avail(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail/overload1.html new file mode 100644 index 0000000..670596d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_write_stream::in_avail (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the amount of data that may be read without blocking. +

+
std::size_t in_avail();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail/overload2.html new file mode 100644 index 0000000..854d4c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/in_avail/overload2.html @@ -0,0 +1,42 @@ + + + +buffered_write_stream::in_avail (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Determine the amount of data that may be read without blocking. +

+
std::size_t in_avail(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer.html new file mode 100644 index 0000000..1592c3e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer.html @@ -0,0 +1,49 @@ + + + +buffered_write_stream::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer/overload1.html new file mode 100644 index 0000000..9095b39 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer/overload1.html @@ -0,0 +1,41 @@ + + + +buffered_write_stream::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer/overload2.html new file mode 100644 index 0000000..6629164 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer/overload2.html @@ -0,0 +1,41 @@ + + + +buffered_write_stream::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer_type.html new file mode 100644 index 0000000..4301c45 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/lowest_layer_type.html @@ -0,0 +1,52 @@ + + + +buffered_write_stream::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the lowest layer. +

+
typedef next_layer_type::lowest_layer_type lowest_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_write_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/next_layer.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/next_layer.html new file mode 100644 index 0000000..1a27457 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/next_layer.html @@ -0,0 +1,42 @@ + + + +buffered_write_stream::next_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the next layer. +

+
next_layer_type & next_layer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/next_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/next_layer_type.html new file mode 100644 index 0000000..78d4048 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/next_layer_type.html @@ -0,0 +1,52 @@ + + + +buffered_write_stream::next_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the next layer. +

+
typedef remove_reference_t< Stream > next_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/buffered_write_stream.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek.html new file mode 100644 index 0000000..01bc766 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek.html @@ -0,0 +1,58 @@ + + + +buffered_write_stream::peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Peek + at the incoming data on the stream. Returns the number of bytes read. Throws + an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers);
+  » more...
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes read, + or 0 if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek/overload1.html new file mode 100644 index 0000000..a254a35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_write_stream::peek (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes + read. Throws an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek/overload2.html new file mode 100644 index 0000000..e3a188c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/peek/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_write_stream::peek (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Peek at the incoming data on the stream. Returns the number of bytes + read, or 0 if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t peek(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some.html new file mode 100644 index 0000000..4f1375c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some.html @@ -0,0 +1,58 @@ + + + +buffered_write_stream::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the stream. Returns the number of bytes read. Throws an + exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+

+ Read some data from the stream. Returns the number of bytes read or 0 if + an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some/overload1.html new file mode 100644 index 0000000..ffad93e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_write_stream::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. Returns the number of bytes read. Throws + an exception on failure. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some/overload2.html new file mode 100644 index 0000000..5b43abe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/read_some/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_write_stream::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. Returns the number of bytes read or 0 + if an error occurred. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some.html new file mode 100644 index 0000000..2494458 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some.html @@ -0,0 +1,58 @@ + + + +buffered_write_stream::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + the given data to the stream. Returns the number of bytes written. Throws + an exception on failure. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » 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. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some/overload1.html new file mode 100644 index 0000000..fa69e3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some/overload1.html @@ -0,0 +1,45 @@ + + + +buffered_write_stream::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write the given data to the stream. Returns the number of bytes written. + Throws an exception on failure. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some/overload2.html new file mode 100644 index 0000000..3b9362f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffered_write_stream/write_some/overload2.html @@ -0,0 +1,46 @@ + + + +buffered_write_stream::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_begin.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_begin.html new file mode 100644 index 0000000..f39cbae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_begin.html @@ -0,0 +1,56 @@ + + + +buffers_begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Construct an iterator representing the beginning of the buffers' data. +

+
template<
+    typename BufferSequence>
+buffers_iterator< BufferSequence > buffers_begin(
+    const BufferSequence & buffers);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_end.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_end.html new file mode 100644 index 0000000..ae8258a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_end.html @@ -0,0 +1,56 @@ + + + +buffers_end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Construct an iterator representing the end of the buffers' data. +

+
template<
+    typename BufferSequence>
+buffers_iterator< BufferSequence > buffers_end(
+    const BufferSequence & buffers);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator.html new file mode 100644 index 0000000..e909d05 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator.html @@ -0,0 +1,407 @@ + + + +buffers_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A random access iterator over the bytes in a buffer sequence. +

+
template<
+    typename BufferSequence,
+    typename ByteType = char>
+class buffers_iterator
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ The type used for the distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ The iterator category. +

+
+

+ pointer +

+ 		+

+ The type of the result of applying operator->() to the iterator. +

+
+

+ reference +

+ 		+

+ The type of the result of applying operator*() to the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the value pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ begin [static] +

+ 		+

+ Construct an iterator representing the beginning of the buffers' + data. +

+
+

+ buffers_iterator [constructor] +

+ 		+

+ Default constructor. Creates an iterator in an undefined state. +

+
+

+ end + [static] +

+ 		+

+ Construct an iterator representing the end of the buffers' data. +

+
+

+ operator* +

+ 		+

+ Dereference an iterator. +

+
+

+ operator++ +

+ 		+

+ Increment operator (prefix).
—
Increment operator (postfix). +

+
+

+ operator+= +

+ 		+

+ Addition operator. +

+
+

+ operator-- +

+ 		+

+ Decrement operator (prefix).
—
Decrement operator (postfix). +

+
+

+ operator-= +

+ 		+

+ Subtraction operator. +

+
+

+ operator-> +

+ 		+

+ Dereference an iterator. +

+
+

+ operator[] +

+ 		+

+ Access an individual element. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Test two iterators for inequality. +

+
+

+ operator+ +

+ 		+

+ Addition operator. +

+
+

+ operator- +

+ 		+

+ Subtraction operator. +

+
+

+ operator< +

+ 		+

+ Compare two iterators. +

+
+

+ operator<= +

+ 		+

+ Compare two iterators. +

+
+

+ operator== +

+ 		+

+ Test two iterators for equality. +

+
+

+ operator> +

+ 		+

+ Compare two iterators. +

+
+

+ operator>= +

+ 		+

+ Compare two iterators. +

+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/begin.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/begin.html new file mode 100644 index 0000000..efb8c77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/begin.html @@ -0,0 +1,43 @@ + + + +buffers_iterator::begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct an + iterator representing the beginning of the buffers' data. +

+
static buffers_iterator begin(
+    const BufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/buffers_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/buffers_iterator.html new file mode 100644 index 0000000..274521b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/buffers_iterator.html @@ -0,0 +1,42 @@ + + + +buffers_iterator::buffers_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. Creates an iterator in an undefined state. +

+
buffers_iterator();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/difference_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/difference_type.html new file mode 100644 index 0000000..d851fa2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/difference_type.html @@ -0,0 +1,52 @@ + + + +buffers_iterator::difference_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used for the distance between two iterators. +

+
typedef std::ptrdiff_t difference_type;
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/end.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/end.html new file mode 100644 index 0000000..c1a8209 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/end.html @@ -0,0 +1,43 @@ + + + +buffers_iterator::end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct an iterator + representing the end of the buffers' data. +

+
static buffers_iterator end(
+    const BufferSequence & buffers);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/iterator_category.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/iterator_category.html new file mode 100644 index 0000000..8d15df2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/iterator_category.html @@ -0,0 +1,52 @@ + + + +buffers_iterator::iterator_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + iterator category. +

+
typedef std::random_access_iterator_tag iterator_category;
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_arrow_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_arrow_.html new file mode 100644 index 0000000..02d365f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_arrow_.html @@ -0,0 +1,42 @@ + + + +buffers_iterator::operator-> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference + an iterator. +

+
pointer operator->() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_eq__eq_.html new file mode 100644 index 0000000..a8fe41c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +buffers_iterator::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + two iterators for equality. +

+
bool operator==(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_gt_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_gt_.html new file mode 100644 index 0000000..d6a9a50 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_gt_.html @@ -0,0 +1,54 @@ + + + +buffers_iterator::operator> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two iterators. +

+
bool operator>(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_gt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_gt__eq_.html new file mode 100644 index 0000000..35eebae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_gt__eq_.html @@ -0,0 +1,54 @@ + + + +buffers_iterator::operator>= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two iterators. +

+
bool operator>=(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lb__rb_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lb__rb_.html new file mode 100644 index 0000000..9b42564 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lb__rb_.html @@ -0,0 +1,43 @@ + + + +buffers_iterator::operator[] + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Access + an individual element. +

+
reference operator[](
+    std::ptrdiff_t difference) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lt_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lt_.html new file mode 100644 index 0000000..901fc2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lt_.html @@ -0,0 +1,54 @@ + + + +buffers_iterator::operator< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two iterators. +

+
bool operator<(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lt__eq_.html new file mode 100644 index 0000000..8ab2d82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_lt__eq_.html @@ -0,0 +1,54 @@ + + + +buffers_iterator::operator<= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two iterators. +

+
bool operator<=(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_.html new file mode 100644 index 0000000..331bea2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_.html @@ -0,0 +1,50 @@ + + + +buffers_iterator::operator- + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Subtraction + operator. +

+
buffers_iterator operator-(
+    const buffers_iterator & iter,
+    std::ptrdiff_t difference);
+  » more...
+
+std::ptrdiff_t operator-(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_/overload1.html new file mode 100644 index 0000000..0bc3aff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_/overload1.html @@ -0,0 +1,53 @@ + + + +buffers_iterator::operator- (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Subtraction operator. +

+
buffers_iterator operator-(
+    const buffers_iterator & iter,
+    std::ptrdiff_t difference);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_/overload2.html new file mode 100644 index 0000000..1b79749 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus_/overload2.html @@ -0,0 +1,53 @@ + + + +buffers_iterator::operator- (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Subtraction operator. +

+
std::ptrdiff_t operator-(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__eq_.html new file mode 100644 index 0000000..4c67eff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__eq_.html @@ -0,0 +1,43 @@ + + + +buffers_iterator::operator-= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Subtraction + operator. +

+
buffers_iterator & operator-=(
+    std::ptrdiff_t difference);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_.html new file mode 100644 index 0000000..750095e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_.html @@ -0,0 +1,50 @@ + + + +buffers_iterator::operator-- + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Decrement + operator (prefix). +

+
buffers_iterator & operator--();
+  » more...
+
+

+ Decrement operator (postfix). +

+
buffers_iterator operator--(
+    int );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_/overload1.html new file mode 100644 index 0000000..98c4a31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_/overload1.html @@ -0,0 +1,41 @@ + + + +buffers_iterator::operator-- (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Decrement operator (prefix). +

+
buffers_iterator & operator--();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_/overload2.html new file mode 100644 index 0000000..b6436fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_minus__minus_/overload2.html @@ -0,0 +1,42 @@ + + + +buffers_iterator::operator-- (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Decrement operator (postfix). +

+
buffers_iterator operator--(
+    int );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_not__eq_.html new file mode 100644 index 0000000..af98866 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +buffers_iterator::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + two iterators for inequality. +

+
bool operator!=(
+    const buffers_iterator & a,
+    const buffers_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_.html new file mode 100644 index 0000000..223bb52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_.html @@ -0,0 +1,50 @@ + + + +buffers_iterator::operator+ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Addition + operator. +

+
buffers_iterator operator+(
+    const buffers_iterator & iter,
+    std::ptrdiff_t difference);
+  » more...
+
+buffers_iterator operator+(
+    std::ptrdiff_t difference,
+    const buffers_iterator & iter);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_/overload1.html new file mode 100644 index 0000000..86b4082 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_/overload1.html @@ -0,0 +1,53 @@ + + + +buffers_iterator::operator+ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Addition operator. +

+
buffers_iterator operator+(
+    const buffers_iterator & iter,
+    std::ptrdiff_t difference);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_/overload2.html new file mode 100644 index 0000000..7395c2d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus_/overload2.html @@ -0,0 +1,53 @@ + + + +buffers_iterator::operator+ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Addition operator. +

+
buffers_iterator operator+(
+    std::ptrdiff_t difference,
+    const buffers_iterator & iter);
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__eq_.html new file mode 100644 index 0000000..a130d20 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__eq_.html @@ -0,0 +1,43 @@ + + + +buffers_iterator::operator+= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Addition + operator. +

+
buffers_iterator & operator+=(
+    std::ptrdiff_t difference);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_.html new file mode 100644 index 0000000..ff51943 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_.html @@ -0,0 +1,50 @@ + + + +buffers_iterator::operator++ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Increment + operator (prefix). +

+
buffers_iterator & operator++();
+  » more...
+
+

+ Increment operator (postfix). +

+
buffers_iterator operator++(
+    int );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_/overload1.html new file mode 100644 index 0000000..7cd195d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_/overload1.html @@ -0,0 +1,41 @@ + + + +buffers_iterator::operator++ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Increment operator (prefix). +

+
buffers_iterator & operator++();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_/overload2.html new file mode 100644 index 0000000..0e529d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_plus__plus_/overload2.html @@ -0,0 +1,42 @@ + + + +buffers_iterator::operator++ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Increment operator (postfix). +

+
buffers_iterator operator++(
+    int );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_star_.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_star_.html new file mode 100644 index 0000000..eb05edc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/operator_star_.html @@ -0,0 +1,42 @@ + + + +buffers_iterator::operator* + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference + an iterator. +

+
reference operator*() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/pointer.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/pointer.html new file mode 100644 index 0000000..a245e29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/pointer.html @@ -0,0 +1,57 @@ + + + +buffers_iterator::pointer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + of the result of applying operator->() to the iterator. +

+
typedef const_or_non_const_ByteType * pointer;
+
+

+ If the buffer sequence stores buffer objects that are convertible to mutable_buffer, + this is a pointer to a non-const ByteType. Otherwise, a pointer to a const + ByteType. +

+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/reference.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/reference.html new file mode 100644 index 0000000..12d00f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/reference.html @@ -0,0 +1,57 @@ + + + +buffers_iterator::reference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + of the result of applying operator*() to the iterator. +

+
typedef const_or_non_const_ByteType & reference;
+
+

+ If the buffer sequence stores buffer objects that are convertible to mutable_buffer, + this is a reference to a non-const ByteType. Otherwise, a reference to + a const ByteType. +

+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/value_type.html new file mode 100644 index 0000000..186d88a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/buffers_iterator/value_type.html @@ -0,0 +1,52 @@ + + + +buffers_iterator::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the value pointed to by the iterator. +

+
typedef ByteType value_type;
+
+
+ + Requirements +
+

+ Header: asio/buffers_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/can_prefer.html b/Packages/asio-1.36.0/doc/asio/reference/can_prefer.html new file mode 100644 index 0000000..58cb2b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/can_prefer.html @@ -0,0 +1,65 @@ + + + +can_prefer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a prefer + expression is well-formed. +

+
template<
+    typename T,
+    typename... Properties>
+struct can_prefer :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template can_prefer + is a trait that is derived from true_type + if the expression asio::prefer(std::declval<T>(), + std::declval<Properties>()...) + is well formed; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/prefer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/can_query.html b/Packages/asio-1.36.0/doc/asio/reference/can_query.html new file mode 100644 index 0000000..e08b329 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/can_query.html @@ -0,0 +1,65 @@ + + + +can_query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a query + expression is well-formed. +

+
template<
+    typename T,
+    typename Property>
+struct can_query :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template can_query + is a trait that is derived from true_type + if the expression asio::query(std::declval<T>(), + std::declval<Property>()) + is well formed; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/can_require.html b/Packages/asio-1.36.0/doc/asio/reference/can_require.html new file mode 100644 index 0000000..f336978 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/can_require.html @@ -0,0 +1,65 @@ + + + +can_require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a require + expression is well-formed. +

+
template<
+    typename T,
+    typename... Properties>
+struct can_require :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template can_require + is a trait that is derived from true_type + if the expression asio::require(std::declval<T>(), + std::declval<Properties>()...) + is well formed; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/require.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/can_require_concept.html b/Packages/asio-1.36.0/doc/asio/reference/can_require_concept.html new file mode 100644 index 0000000..9ce265c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/can_require_concept.html @@ -0,0 +1,65 @@ + + + +can_require_concept + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a require_concept + expression is well-formed. +

+
template<
+    typename T,
+    typename Property>
+struct can_require_concept :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template can_require_concept + is a trait that is derived from true_type + if the expression asio::require_concept(std::declval<T>(), + std::declval<Property>()) + is well formed; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/require_concept.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after.html new file mode 100644 index 0000000..5b29bf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after.html @@ -0,0 +1,123 @@ + + + +cancel_after + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a partial completion token adapter that cancels an operation if not + complete before the specified relative timeout has elapsed. +

+
template<
+    typename Rep,
+    typename Period>
+partial_cancel_after< chrono::steady_clock > cancel_after(
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+  » more...
+
+template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Rep,
+    typename Period>
+partial_cancel_after_timer< Clock, WaitTraits, Executor > cancel_after(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+  » more...
+
+

+ Adapt a completion + token to cancel an operation if not complete before the specified + relative timeout has elapsed. +

+
template<
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_t< decay_t< CompletionToken >, chrono::steady_clock > cancel_after(
+    const chrono::duration< Rep, Period > & timeout,
+    CompletionToken && completion_token);
+  » more...
+
+template<
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_t< decay_t< CompletionToken >, chrono::steady_clock > cancel_after(
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+  » more...
+
+template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > cancel_after(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::duration< Rep, Period > & timeout,
+    CompletionToken && completion_token);
+  » more...
+
+template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_timer< decay_t< CompletionToken >, chrono::steady_clock > cancel_after(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/cancel_after.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload1.html new file mode 100644 index 0000000..a42b909 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload1.html @@ -0,0 +1,58 @@ + + + +cancel_after (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token adapter that cancels an operation if + not complete before the specified relative timeout has elapsed. +

+
template<
+    typename Rep,
+    typename Period>
+partial_cancel_after< chrono::steady_clock > cancel_after(
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+ + Thread Safety +
+

+ When an asynchronous operation is used with cancel_after, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload2.html new file mode 100644 index 0000000..1c575d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload2.html @@ -0,0 +1,62 @@ + + + +cancel_after (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token adapter that cancels an operation if + not complete before the specified relative timeout has elapsed. +

+
template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Rep,
+    typename Period>
+partial_cancel_after_timer< Clock, WaitTraits, Executor > cancel_after(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+ + Thread Safety +
+

+ When an asynchronous operation is used with cancel_after, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload3.html new file mode 100644 index 0000000..c152736 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload3.html @@ -0,0 +1,60 @@ + + + +cancel_after (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete before the specified + relative timeout has elapsed. +

+
template<
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_t< decay_t< CompletionToken >, chrono::steady_clock > cancel_after(
+    const chrono::duration< Rep, Period > & timeout,
+    CompletionToken && completion_token);
+
+
+ + Thread Safety +
+

+ When an asynchronous operation is used with cancel_after, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload4.html new file mode 100644 index 0000000..756ae93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload4.html @@ -0,0 +1,61 @@ + + + +cancel_after (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete before the specified + relative timeout has elapsed. +

+
template<
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_t< decay_t< CompletionToken >, chrono::steady_clock > cancel_after(
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+
+
+ + Thread Safety +
+

+ When an asynchronous operation is used with cancel_after, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload5.html new file mode 100644 index 0000000..e123e30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload5.html @@ -0,0 +1,64 @@ + + + +cancel_after (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete before the specified + relative timeout has elapsed. +

+
template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > cancel_after(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::duration< Rep, Period > & timeout,
+    CompletionToken && completion_token);
+
+
+ + Thread Safety +
+

+ When an asynchronous operation is used with cancel_after, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload6.html new file mode 100644 index 0000000..a80c5b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after/overload6.html @@ -0,0 +1,65 @@ + + + +cancel_after (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete before the specified + relative timeout has elapsed. +

+
template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Rep,
+    typename Period,
+    typename CompletionToken>
+cancel_after_timer< decay_t< CompletionToken >, chrono::steady_clock > cancel_after(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::duration< Rep, Period > & timeout,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+
+
+ + Thread Safety +
+

+ When an asynchronous operation is used with cancel_after, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t.html new file mode 100644 index 0000000..2129231 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t.html @@ -0,0 +1,150 @@ + + + +cancel_after_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + adapter that cancels an operation after a timeout. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>>
+class cancel_after_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_after_t [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ timeout_ +

+ 		+
+

+ token_ +

+ 		+
+

+ The cancel_after_t + class is used to indicate that an asynchronous operation should be cancelled + if not complete before the specified duration has elapsed. +

+
+ + Requirements +
+

+ Header: asio/cancel_after.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/cancel_after_t.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/cancel_after_t.html new file mode 100644 index 0000000..5d9bef8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/cancel_after_t.html @@ -0,0 +1,46 @@ + + + +cancel_after_t::cancel_after_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T>
+cancel_after_t(
+    T && completion_token,
+    const typename Clock::duration & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/cancel_type_.html new file mode 100644 index 0000000..99c53bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/cancel_type_.html @@ -0,0 +1,40 @@ + + + +cancel_after_t::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/timeout_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/timeout_.html new file mode 100644 index 0000000..f58e859 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/timeout_.html @@ -0,0 +1,40 @@ + + + +cancel_after_t::timeout_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::duration timeout_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/token_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/token_.html new file mode 100644 index 0000000..c2b3c09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_t/token_.html @@ -0,0 +1,40 @@ + + + +cancel_after_t::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer.html new file mode 100644 index 0000000..34730e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer.html @@ -0,0 +1,160 @@ + + + +cancel_after_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + adapter that cancels an operation after a timeout. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>,
+    typename Executor = any_io_executor>
+class cancel_after_timer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_after_timer [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ timeout_ +

+ 		+
+

+ timer_ +

+ 		+
+

+ token_ +

+ 		+
+

+ The cancel_after_timer + class is used to indicate that an asynchronous operation should be cancelled + if not complete before the specified duration has elapsed. +

+
+ + Requirements +
+

+ Header: asio/cancel_after.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/cancel_after_timer.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/cancel_after_timer.html new file mode 100644 index 0000000..7ccd4cc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/cancel_after_timer.html @@ -0,0 +1,47 @@ + + + +cancel_after_timer::cancel_after_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T>
+cancel_after_timer(
+    T && completion_token,
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const typename Clock::duration & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/cancel_type_.html new file mode 100644 index 0000000..6f3090d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/cancel_type_.html @@ -0,0 +1,40 @@ + + + +cancel_after_timer::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/timeout_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/timeout_.html new file mode 100644 index 0000000..8c26f38 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/timeout_.html @@ -0,0 +1,40 @@ + + + +cancel_after_timer::timeout_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::duration timeout_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/timer_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/timer_.html new file mode 100644 index 0000000..5dd5a1c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/timer_.html @@ -0,0 +1,40 @@ + + + +cancel_after_timer::timer_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
basic_waitable_timer< Clock, WaitTraits, Executor > & timer_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/token_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/token_.html new file mode 100644 index 0000000..6cace4f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_after_timer/token_.html @@ -0,0 +1,40 @@ + + + +cancel_after_timer::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at.html new file mode 100644 index 0000000..1562dd8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at.html @@ -0,0 +1,120 @@ + + + +cancel_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a partial completion token adapter that cancels an operation if not + complete by the specified absolute time. +

+
template<
+    typename Clock,
+    typename Duration>
+partial_cancel_at< Clock > cancel_at(
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+  » more...
+
+template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Duration>
+partial_cancel_at_timer< Clock, WaitTraits, Executor > cancel_at(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+  » more...
+
+

+ Adapt a completion + token to cancel an operation if not complete by the specified absolute + time. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename Duration>
+cancel_at_t< decay_t< CompletionToken >, Clock > cancel_at(
+    const chrono::time_point< Clock, Duration > & expiry,
+    CompletionToken && completion_token);
+  » more...
+
+template<
+    typename CompletionToken,
+    typename Clock,
+    typename Duration>
+cancel_at_t< decay_t< CompletionToken >, Clock > cancel_at(
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+  » more...
+
+template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Duration>
+cancel_at_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > cancel_at(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::time_point< Clock, Duration > & expiry,
+    CompletionToken && completion_token);
+  » more...
+
+template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Duration>
+cancel_at_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > cancel_at(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/cancel_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload1.html new file mode 100644 index 0000000..d686d4d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload1.html @@ -0,0 +1,59 @@ + + + +cancel_at (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token adapter that cancels an operation if + not complete by the specified absolute time. +

+
template<
+    typename Clock,
+    typename Duration>
+partial_cancel_at< Clock > cancel_at(
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+ + Thread + Safety +
+

+ When an asynchronous operation is used with cancel_at, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload2.html new file mode 100644 index 0000000..da6610e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload2.html @@ -0,0 +1,62 @@ + + + +cancel_at (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token adapter that cancels an operation if + not complete by the specified absolute time. +

+
template<
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Duration>
+partial_cancel_at_timer< Clock, WaitTraits, Executor > cancel_at(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+ + Thread + Safety +
+

+ When an asynchronous operation is used with cancel_at, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload3.html new file mode 100644 index 0000000..784224b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload3.html @@ -0,0 +1,61 @@ + + + +cancel_at (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete by the specified absolute + time. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename Duration>
+cancel_at_t< decay_t< CompletionToken >, Clock > cancel_at(
+    const chrono::time_point< Clock, Duration > & expiry,
+    CompletionToken && completion_token);
+
+
+ + Thread + Safety +
+

+ When an asynchronous operation is used with cancel_at, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload4.html new file mode 100644 index 0000000..c46443b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload4.html @@ -0,0 +1,62 @@ + + + +cancel_at (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete by the specified absolute + time. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename Duration>
+cancel_at_t< decay_t< CompletionToken >, Clock > cancel_at(
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+
+
+ + Thread + Safety +
+

+ When an asynchronous operation is used with cancel_at, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload5.html new file mode 100644 index 0000000..56429f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload5.html @@ -0,0 +1,64 @@ + + + +cancel_at (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete by the specified absolute + time. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Duration>
+cancel_at_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > cancel_at(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::time_point< Clock, Duration > & expiry,
+    CompletionToken && completion_token);
+
+
+ + Thread + Safety +
+

+ When an asynchronous operation is used with cancel_at, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload6.html new file mode 100644 index 0000000..ea21b4e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at/overload6.html @@ -0,0 +1,65 @@ + + + +cancel_at (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to cancel an operation if not complete by the specified absolute + time. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits,
+    typename Executor,
+    typename Duration>
+cancel_at_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > cancel_at(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const chrono::time_point< Clock, Duration > & expiry,
+    cancellation_type_t cancel_type,
+    CompletionToken && completion_token);
+
+
+ + Thread + Safety +
+

+ When an asynchronous operation is used with cancel_at, a timer async_wait + operation is performed in parallel to the main operation. If this parallel + async_wait completes first, a cancellation request is emitted to cancel + the main operation. Consequently, the application must ensure that the + asynchronous operation is performed within an implicit or explicit strand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t.html new file mode 100644 index 0000000..caacf81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t.html @@ -0,0 +1,150 @@ + + + +cancel_at_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + adapter that cancels an operation at a given time. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>>
+class cancel_at_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_at_t [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ expiry_ +

+ 		+
+

+ token_ +

+ 		+
+

+ The cancel_at_t + class is used to indicate that an asynchronous operation should be cancelled + if not complete at the specified absolute time. +

+
+ + Requirements +
+

+ Header: asio/cancel_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/cancel_at_t.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/cancel_at_t.html new file mode 100644 index 0000000..8605f5c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/cancel_at_t.html @@ -0,0 +1,46 @@ + + + +cancel_at_t::cancel_at_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T>
+cancel_at_t(
+    T && completion_token,
+    const typename Clock::time_point & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/cancel_type_.html new file mode 100644 index 0000000..7fc5e5c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/cancel_type_.html @@ -0,0 +1,40 @@ + + + +cancel_at_t::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/expiry_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/expiry_.html new file mode 100644 index 0000000..816cd67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/expiry_.html @@ -0,0 +1,40 @@ + + + +cancel_at_t::expiry_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::time_point expiry_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/token_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/token_.html new file mode 100644 index 0000000..a636043 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_t/token_.html @@ -0,0 +1,40 @@ + + + +cancel_at_t::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer.html new file mode 100644 index 0000000..6a8fe59 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer.html @@ -0,0 +1,160 @@ + + + +cancel_at_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + adapter that cancels an operation at a given time. +

+
template<
+    typename CompletionToken,
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>,
+    typename Executor = any_io_executor>
+class cancel_at_timer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_at_timer [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ expiry_ +

+ 		+
+

+ timer_ +

+ 		+
+

+ token_ +

+ 		+
+

+ The cancel_at_timer + class is used to indicate that an asynchronous operation should be cancelled + if not complete at the specified absolute time. +

+
+ + Requirements +
+

+ Header: asio/cancel_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/cancel_at_timer.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/cancel_at_timer.html new file mode 100644 index 0000000..c34b209 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/cancel_at_timer.html @@ -0,0 +1,47 @@ + + + +cancel_at_timer::cancel_at_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T>
+cancel_at_timer(
+    T && completion_token,
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const typename Clock::time_point & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/cancel_type_.html new file mode 100644 index 0000000..74dc0fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/cancel_type_.html @@ -0,0 +1,40 @@ + + + +cancel_at_timer::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/expiry_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/expiry_.html new file mode 100644 index 0000000..c1a498d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/expiry_.html @@ -0,0 +1,40 @@ + + + +cancel_at_timer::expiry_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::time_point expiry_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/timer_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/timer_.html new file mode 100644 index 0000000..3bf1dc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/timer_.html @@ -0,0 +1,40 @@ + + + +cancel_at_timer::timer_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
basic_waitable_timer< Clock, WaitTraits, Executor > & timer_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/token_.html b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/token_.html new file mode 100644 index 0000000..f6d0ee8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancel_at_timer/token_.html @@ -0,0 +1,40 @@ + + + +cancel_at_timer::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_filter.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_filter.html new file mode 100644 index 0000000..44c4dc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_filter.html @@ -0,0 +1,90 @@ + + + +cancellation_filter + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A simple cancellation signal propagation filter. +

+
template<
+    cancellation_type_t Mask>
+struct cancellation_filter
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Returns type & Mask. +

+
+
+ + Requirements +
+

+ Header: asio/cancellation_state.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_filter/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_filter/operator_lp__rp_.html new file mode 100644 index 0000000..1e5e2aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_filter/operator_lp__rp_.html @@ -0,0 +1,44 @@ + + + +cancellation_filter::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns + type & + Mask. +

+
cancellation_type_t operator()(
+    cancellation_type_t type) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal.html new file mode 100644 index 0000000..dd891a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal.html @@ -0,0 +1,121 @@ + + + +cancellation_signal + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A cancellation signal with a single slot. +

+
class cancellation_signal
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancellation_signal [constructor] +

+ 		+
+

+ emit +

+ 		+

+ Emits the signal and causes invocation of the slot's handler, if + any. +

+
+

+ slot +

+ 		+

+ Returns the single slot associated with the signal. +

+
+

+ ~cancellation_signal [destructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/cancellation_signal.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/_cancellation_signal.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/_cancellation_signal.html new file mode 100644 index 0000000..6c33566 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/_cancellation_signal.html @@ -0,0 +1,40 @@ + + + +cancellation_signal::~cancellation_signal + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
~cancellation_signal();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/cancellation_signal.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/cancellation_signal.html new file mode 100644 index 0000000..c65981d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/cancellation_signal.html @@ -0,0 +1,40 @@ + + + +cancellation_signal::cancellation_signal + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr cancellation_signal();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/emit.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/emit.html new file mode 100644 index 0000000..b8b328a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/emit.html @@ -0,0 +1,43 @@ + + + +cancellation_signal::emit + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Emits the + signal and causes invocation of the slot's handler, if any. +

+
void emit(
+    cancellation_type_t type);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/slot.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/slot.html new file mode 100644 index 0000000..b8ad7d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_signal/slot.html @@ -0,0 +1,46 @@ + + + +cancellation_signal::slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns the + single slot associated with the signal. +

+
cancellation_slot slot();
+
+

+ The signal object must remain valid for as long the slot may be used. Destruction + of the signal invalidates the slot. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot.html new file mode 100644 index 0000000..9f8ea8f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot.html @@ -0,0 +1,198 @@ + + + +cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A slot associated with a cancellation signal. +

+
class cancellation_slot
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Installs a handler into the slot. +

+
+

+ cancellation_slot [constructor] +

+ 		+

+ Creates a slot that is not connected to any cancellation signal. +

+
+

+ clear +

+ 		+

+ Clears the slot. +

+
+

+ emplace +

+ 		+

+ Installs a handler into the slot, constructing the new object directly. +

+
+

+ has_handler +

+ 		+

+ Returns whether the slot is connected and has an installed handler. +

+
+

+ is_connected +

+ 		+

+ Returns whether the slot is connected to a signal. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two slots for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two slots for equality. +

+
+
+ + Requirements +
+

+ Header: asio/cancellation_signal.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/assign.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/assign.html new file mode 100644 index 0000000..669f3bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/assign.html @@ -0,0 +1,75 @@ + + + +cancellation_slot::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Installs + a handler into the slot. +

+
template<
+    typename CancellationHandler>
+decay_t< CancellationHandler > & assign(
+    CancellationHandler && handler);
+
+

+ Destroys any existing handler in the slot, then installs the new handler, + constructing it as a decay-copy of the supplied handler. +

+

+ The handler is a function object to be called when the signal is emitted. + The signature of the handler must be +

+
void handler(asio::cancellation_type_t);
+
+
+ + Parameters +
+
+

+
+
handler
+

+ The handler to be installed. +

+
+
+
+ + Return Value +
+

+ A reference to the newly installed handler. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/cancellation_slot.html new file mode 100644 index 0000000..f04d08b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/cancellation_slot.html @@ -0,0 +1,42 @@ + + + +cancellation_slot::cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Creates + a slot that is not connected to any cancellation signal. +

+
constexpr cancellation_slot();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/clear.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/clear.html new file mode 100644 index 0000000..c74fa8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/clear.html @@ -0,0 +1,45 @@ + + + +cancellation_slot::clear + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Clears the + slot. +

+
void clear();
+
+

+ Destroys any existing handler in the slot. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/emplace.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/emplace.html new file mode 100644 index 0000000..cfa6a3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/emplace.html @@ -0,0 +1,86 @@ + + + +cancellation_slot::emplace + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Installs + a handler into the slot, constructing the new object directly. +

+
template<
+    typename CancellationHandler,
+    typename... Args>
+CancellationHandler & emplace(
+    Args &&... args);
+
+

+ Destroys any existing handler in the slot, then installs the new handler, + constructing it with the supplied args. +

+

+ The handler is a function object to be called when the signal is emitted. + The signature of the handler must be +

+
void handler(asio::cancellation_type_t);
+
+
+ + Parameters +
+
+

+
+
args
+

+ Arguments to be passed to the CancellationHandler + object's constructor. +

+
+
+
+ + Return + Value +
+

+ A reference to the newly installed handler. +

+
+ + Remarks +
+

+ Handlers installed into the slot via emplace + are not required to be copy constructible or move constructible. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/has_handler.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/has_handler.html new file mode 100644 index 0000000..ebc3f29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/has_handler.html @@ -0,0 +1,42 @@ + + + +cancellation_slot::has_handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns + whether the slot is connected and has an installed handler. +

+
constexpr bool has_handler() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/is_connected.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/is_connected.html new file mode 100644 index 0000000..00baecc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/is_connected.html @@ -0,0 +1,42 @@ + + + +cancellation_slot::is_connected + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns + whether the slot is connected to a signal. +

+
constexpr bool is_connected() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/operator_eq__eq_.html new file mode 100644 index 0000000..5db4bda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +cancellation_slot::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two slots for equality. +

+
constexpr bool operator==(
+    const cancellation_slot & lhs,
+    const cancellation_slot & rhs);
+
+
+ + Requirements +
+

+ Header: asio/cancellation_signal.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/operator_not__eq_.html new file mode 100644 index 0000000..11f140e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +cancellation_slot::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two slots for inequality. +

+
constexpr bool operator!=(
+    const cancellation_slot & lhs,
+    const cancellation_slot & rhs);
+
+
+ + Requirements +
+

+ Header: asio/cancellation_signal.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder.html new file mode 100644 index 0000000..961fc84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder.html @@ -0,0 +1,248 @@ + + + +cancellation_slot_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A call wrapper type to bind a cancellation slot of type CancellationSlot + to an object of type T. +

+
template<
+    typename T,
+    typename CancellationSlot>
+class cancellation_slot_binder
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ argument_type +

+ 		+

+ The type of the function's argument. +

+
+

+ cancellation_slot_type +

+ 		+

+ The type of the associated cancellation slot. +

+
+

+ first_argument_type +

+ 		+

+ The type of the function's first argument. +

+
+

+ result_type +

+ 		+

+ The return type if a function. +

+
+

+ second_argument_type +

+ 		+

+ The type of the function's second argument. +

+
+

+ target_type +

+ 		+

+ The type of the target object. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancellation_slot_binder [constructor] +

+ 		+

+ Construct a cancellation slot wrapper for the specified object. +
—
Copy constructor.
—
Construct a copy, + but specify a different cancellation slot.
—
Construct + a copy of a different cancellation slot wrapper type.
—
+ Construct a copy of a different cancellation slot wrapper type, + but specify a different cancellation slot.
—
Move constructor. +
—
Move construct the target object, but specify a different + cancellation slot.
—
Move construct from a different + cancellation slot wrapper type.
—
Move construct from + a different cancellation slot wrapper type, but specify a different + cancellation slot. +

+
+

+ get +

+ 		+

+ Obtain a reference to the target object. +

+
+

+ get_cancellation_slot +

+ 		+

+ Obtain the associated cancellation slot. +

+
+

+ operator() +

+ 		+

+ Forwarding function call operator. +

+
+

+ ~cancellation_slot_binder [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/_cancellation_slot_binder.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/_cancellation_slot_binder.html new file mode 100644 index 0000000..78b4b09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/_cancellation_slot_binder.html @@ -0,0 +1,41 @@ + + + +cancellation_slot_binder::~cancellation_slot_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~cancellation_slot_binder();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/argument_type.html new file mode 100644 index 0000000..f904713 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/argument_type.html @@ -0,0 +1,74 @@ + + + +cancellation_slot_binder::argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's argument. +

+
typedef see_below argument_type;
+
+

+ The type of argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting a single argument, argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type argument_type, + then argument_type + is a synonym for T::argument_type; +
    • +
  • + otherwise argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder.html new file mode 100644 index 0000000..7845346 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder.html @@ -0,0 +1,128 @@ + + + +cancellation_slot_binder::cancellation_slot_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a cancellation slot wrapper for the specified object. +

+
template<
+    typename U>
+cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    U && u);
+  » more...
+
+

+ Copy constructor. +

+
cancellation_slot_binder(
+    const cancellation_slot_binder & other);
+  » more...
+
+

+ Construct a copy, but specify a different cancellation slot. +

+
cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    const cancellation_slot_binder & other);
+  » more...
+
+

+ Construct a copy of a different cancellation slot wrapper type. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    const cancellation_slot_binder< U, OtherCancellationSlot > & other,
+    constraint_t< is_constructible< CancellationSlot, OtherCancellationSlot >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Construct a copy of a different cancellation slot wrapper type, but specify + a different cancellation slot. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    const cancellation_slot_binder< U, OtherCancellationSlot > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move constructor. +

+
cancellation_slot_binder(
+    cancellation_slot_binder && other);
+  » more...
+
+

+ Move construct the target object, but specify a different cancellation + slot. +

+
cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    cancellation_slot_binder && other);
+  » more...
+
+

+ Move construct from a different cancellation slot wrapper type. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    cancellation_slot_binder< U, OtherCancellationSlot > && other,
+    constraint_t< is_constructible< CancellationSlot, OtherCancellationSlot >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move construct from a different cancellation slot wrapper type, but specify + a different cancellation slot. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    cancellation_slot_binder< U, OtherCancellationSlot > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload1.html new file mode 100644 index 0000000..77aa059 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload1.html @@ -0,0 +1,49 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (1 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a cancellation slot wrapper for the specified object. +

+
template<
+    typename U>
+cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    U && u);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload2.html new file mode 100644 index 0000000..9a9c81e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload2.html @@ -0,0 +1,42 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (2 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
cancellation_slot_binder(
+    const cancellation_slot_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload3.html new file mode 100644 index 0000000..0343943 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload3.html @@ -0,0 +1,43 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (3 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy, but specify a different cancellation slot. +

+
cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    const cancellation_slot_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload4.html new file mode 100644 index 0000000..29ef51f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload4.html @@ -0,0 +1,53 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (4 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different cancellation slot wrapper type. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    const cancellation_slot_binder< U, OtherCancellationSlot > & other,
+    constraint_t< is_constructible< CancellationSlot, OtherCancellationSlot >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the CancellationSlot + type is constructible from type OtherCancellationSlot, + and the type T is constructible + from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload5.html new file mode 100644 index 0000000..5878d30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload5.html @@ -0,0 +1,52 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (5 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different cancellation slot wrapper type, but specify + a different cancellation slot. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    const cancellation_slot_binder< U, OtherCancellationSlot > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload6.html new file mode 100644 index 0000000..7eab983 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload6.html @@ -0,0 +1,42 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (6 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
cancellation_slot_binder(
+    cancellation_slot_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload7.html new file mode 100644 index 0000000..5b44215 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload7.html @@ -0,0 +1,44 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (7 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct the target object, but specify a different cancellation + slot. +

+
cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    cancellation_slot_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload8.html new file mode 100644 index 0000000..1dd847d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload8.html @@ -0,0 +1,47 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (8 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different cancellation slot wrapper type. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    cancellation_slot_binder< U, OtherCancellationSlot > && other,
+    constraint_t< is_constructible< CancellationSlot, OtherCancellationSlot >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload9.html new file mode 100644 index 0000000..c9d5cf4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_binder/overload9.html @@ -0,0 +1,48 @@ + + + +cancellation_slot_binder::cancellation_slot_binder (9 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different cancellation slot wrapper type, but specify + a different cancellation slot. +

+
template<
+    typename U,
+    typename OtherCancellationSlot>
+cancellation_slot_binder(
+    const cancellation_slot_type & s,
+    cancellation_slot_binder< U, OtherCancellationSlot > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_type.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_type.html new file mode 100644 index 0000000..a9a9365 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/cancellation_slot_type.html @@ -0,0 +1,52 @@ + + + +cancellation_slot_binder::cancellation_slot_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the associated cancellation slot. +

+
typedef CancellationSlot cancellation_slot_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/first_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/first_argument_type.html new file mode 100644 index 0000000..c311a24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/first_argument_type.html @@ -0,0 +1,74 @@ + + + +cancellation_slot_binder::first_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's first argument. +

+
typedef see_below first_argument_type;
+
+

+ The type of first_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, first_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then first_argument_type + is a synonym for T::first_argument_type; +
    • +
  • + otherwise first_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get.html new file mode 100644 index 0000000..8640834 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get.html @@ -0,0 +1,46 @@ + + + +cancellation_slot_binder::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a reference to the target object. +

+
target_type & get();
+  » more...
+
+const target_type & get() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get/overload1.html new file mode 100644 index 0000000..479d650 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get/overload1.html @@ -0,0 +1,41 @@ + + + +cancellation_slot_binder::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
target_type & get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get/overload2.html new file mode 100644 index 0000000..cfd955c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get/overload2.html @@ -0,0 +1,41 @@ + + + +cancellation_slot_binder::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
const target_type & get() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get_cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get_cancellation_slot.html new file mode 100644 index 0000000..1fabf69 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/get_cancellation_slot.html @@ -0,0 +1,42 @@ + + + +cancellation_slot_binder::get_cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the associated cancellation slot. +

+
cancellation_slot_type get_cancellation_slot() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_.html new file mode 100644 index 0000000..15fa1a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_.html @@ -0,0 +1,58 @@ + + + +cancellation_slot_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwarding + function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..757b8e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +cancellation_slot_binder::operator() (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..f670562 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload2.html @@ -0,0 +1,44 @@ + + + +cancellation_slot_binder::operator() (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload3.html new file mode 100644 index 0000000..f6ea6ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/operator_lp__rp_/overload3.html @@ -0,0 +1,44 @@ + + + +cancellation_slot_binder::operator() (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/result_type.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/result_type.html new file mode 100644 index 0000000..ab32080 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/result_type.html @@ -0,0 +1,74 @@ + + + +cancellation_slot_binder::result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + return type if a function. +

+
typedef see_below result_type;
+
+

+ The type of result_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + function type, result_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type result_type, + then result_type is + a synonym for T::result_type; +
    • +
  • + otherwise result_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/second_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/second_argument_type.html new file mode 100644 index 0000000..a4f6888 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/second_argument_type.html @@ -0,0 +1,74 @@ + + + +cancellation_slot_binder::second_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's second argument. +

+
typedef see_below second_argument_type;
+
+

+ The type of second_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, second_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then second_argument_type + is a synonym for T::second_argument_type; +
    • +
  • + otherwise second_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/target_type.html new file mode 100644 index 0000000..4b592f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_slot_binder/target_type.html @@ -0,0 +1,52 @@ + + + +cancellation_slot_binder::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the target object. +

+
typedef T target_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state.html new file mode 100644 index 0000000..76619ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state.html @@ -0,0 +1,127 @@ + + + +cancellation_state + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A cancellation state is used for chaining signals and slots in compositions. +

+
class cancellation_state
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancellation_state [constructor] +

+ 		+

+ Construct a disconnected cancellation state.
—
Construct + and attach to a parent slot to create a new child slot. +

+
+

+ cancelled +

+ 		+

+ Returns the cancellation types that have been triggered. +

+
+

+ clear +

+ 		+

+ Clears the specified cancellation types, if they have been triggered. +

+
+

+ slot +

+ 		+

+ Returns the single child slot associated with the state. +

+
+
+ + Requirements +
+

+ Header: asio/cancellation_state.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state.html new file mode 100644 index 0000000..5cd7798 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state.html @@ -0,0 +1,70 @@ + + + +cancellation_state::cancellation_state + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a disconnected cancellation state. +

+
constexpr cancellation_state();
+  » more...
+
+

+ Construct and attach to a parent slot to create a new child slot. +

+
template<
+    typename CancellationSlot>
+explicit constexpr cancellation_state(
+    CancellationSlot slot);
+  » more...
+
+template<
+    typename CancellationSlot,
+    typename Filter>
+constexpr cancellation_state(
+    CancellationSlot slot,
+    Filter filter);
+  » more...
+
+template<
+    typename CancellationSlot,
+    typename InFilter,
+    typename OutFilter>
+constexpr cancellation_state(
+    CancellationSlot slot,
+    InFilter in_filter,
+    OutFilter out_filter);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload1.html new file mode 100644 index 0000000..a94f1ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload1.html @@ -0,0 +1,41 @@ + + + +cancellation_state::cancellation_state (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a disconnected cancellation state. +

+
constexpr cancellation_state();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload2.html new file mode 100644 index 0000000..11c1c2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload2.html @@ -0,0 +1,61 @@ + + + +cancellation_state::cancellation_state (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and attach to a parent slot to create a new child slot. +

+
template<
+    typename CancellationSlot>
+constexpr cancellation_state(
+    CancellationSlot slot);
+
+

+ Initialises the cancellation state so that it allows terminal cancellation + only. Equivalent to cancellation_state(slot, enable_terminal_cancellation()). +

+
+ + Parameters +
+
+

+
+
slot
+

+ The parent cancellation slot to which the state will be attached. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload3.html new file mode 100644 index 0000000..6db35cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload3.html @@ -0,0 +1,87 @@ + + + +cancellation_state::cancellation_state (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and attach to a parent slot to create a new child slot. +

+
template<
+    typename CancellationSlot,
+    typename Filter>
+constexpr cancellation_state(
+    CancellationSlot slot,
+    Filter filter);
+
+
+ + Parameters +
+
+

+
+
slot
+

+ The parent cancellation slot to which the state will be attached. +

+
filter
+
+

+ A function object that is used to transform incoming cancellation + signals as they are received from the parent slot. This function + object must have the signature: +

+
asio::cancellation_type_t filter(
+   asio::cancellation_type_t);
+
+
+
+
+

+ The library provides the following pre-defined cancellation filters: +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload4.html new file mode 100644 index 0000000..d623bca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancellation_state/overload4.html @@ -0,0 +1,100 @@ + + + +cancellation_state::cancellation_state (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and attach to a parent slot to create a new child slot. +

+
template<
+    typename CancellationSlot,
+    typename InFilter,
+    typename OutFilter>
+constexpr cancellation_state(
+    CancellationSlot slot,
+    InFilter in_filter,
+    OutFilter out_filter);
+
+
+ + Parameters +
+
+

+
+
slot
+

+ The parent cancellation slot to which the state will be attached. +

+
in_filter
+
+

+ A function object that is used to transform incoming cancellation + signals as they are received from the parent slot. This function + object must have the signature: +

+
asio::cancellation_type_t in_filter(
+   asio::cancellation_type_t);
+
+
+
out_filter
+
+

+ A function object that is used to transform outcoming cancellation + signals as they are relayed to the child slot. This function object + must have the signature: +

+
asio::cancellation_type_t out_filter(
+   asio::cancellation_type_t);
+
+
+
+
+

+ The library provides the following pre-defined cancellation filters: +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancelled.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancelled.html new file mode 100644 index 0000000..7d78b3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/cancelled.html @@ -0,0 +1,42 @@ + + + +cancellation_state::cancelled + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns + the cancellation types that have been triggered. +

+
cancellation_type_t cancelled() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/clear.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/clear.html new file mode 100644 index 0000000..789bb7d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/clear.html @@ -0,0 +1,43 @@ + + + +cancellation_state::clear + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Clears the + specified cancellation types, if they have been triggered. +

+
void clear(
+    cancellation_type_t mask = cancellation_type::all);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/slot.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/slot.html new file mode 100644 index 0000000..ff5dc60 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_state/slot.html @@ -0,0 +1,45 @@ + + + +cancellation_state::slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns the + single child slot associated with the state. +

+
constexpr cancellation_slot slot() const;
+
+

+ This sub-slot is used with the operations that are being composed. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_type.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_type.html new file mode 100644 index 0000000..5913919 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_type.html @@ -0,0 +1,95 @@ + + + +cancellation_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Enumeration representing the different types of cancellation that may be + requested from or implemented by an asynchronous operation. +

+
enum class cancellation_type : unsigned int
+
+

+ + + + + +

+
+ + Values +
+
+

+
+
none
+

+ Bitmask representing no types of cancellation. +

+
terminal
+

+ Requests cancellation where, following a successful cancellation, the + only safe operations on the I/O object are closure or destruction. +

+
partial
+

+ Requests cancellation where a successful cancellation may result in + partial side effects or no side effects. Following cancellation, the + I/O object is in a well-known state, and may be used for further operations. +

+
total
+

+ Requests cancellation where a successful cancellation results in no + apparent side effects. Following cancellation, the I/O object is in + the same observable state as it was prior to the operation. +

+
all
+

+ Bitmask representing all types of cancellation. +

+
+
+
+ + Requirements +
+

+ Header: asio/cancellation_type.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/cancellation_type_t.html b/Packages/asio-1.36.0/doc/asio/reference/cancellation_type_t.html new file mode 100644 index 0000000..bf8b701 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/cancellation_type_t.html @@ -0,0 +1,53 @@ + + + +cancellation_type_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Portability typedef. +

+
typedef cancellation_type cancellation_type_t;
+
+
+ + Requirements +
+

+ Header: asio/cancellation_type.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_composed.html b/Packages/asio-1.36.0/doc/asio/reference/co_composed.html new file mode 100644 index 0000000..83d0f93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_composed.html @@ -0,0 +1,188 @@ + + + +co_composed + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Creates an initiation function object that may be used to launch a coroutine-based + composed asynchronous operation. +

+
template<
+    typename... Signatures,
+    typename Implementation,
+    typename... IoObjectsOrExecutors>
+auto co_composed(
+    Implementation && implementation,
+    IoObjectsOrExecutors &&... io_objects_or_executors);
+
+

+ The co_composed utility simplifies the implementation of composed asynchronous + operations by automatically adapting a coroutine to be an initiation function + object for use with async_initiate. + When awaiting asynchronous operations, the coroutine automatically uses a + conforming intermediate completion handler. +

+
+ + Parameters +
+
+

+
+
implementation
+

+ A function object that contains the coroutine-based implementation + of the composed asynchronous operation. The first argument to the function + object represents the state of the operation, and may be used to test + for cancellation. The remaining arguments are those passed to async_initiate after the completion + token. +

+
io_objects_or_executors
+

+ Zero or more I/O objects or I/O executors for which outstanding work + must be maintained while the operation is incomplete. +

+
+
+
+ + Per-Operation + Cancellation +
+

+ By default, terminal per-operation cancellation is enabled for composed operations + that use co_composed. To disable cancellation for the composed operation, + or to alter its supported cancellation types, call the state's reset_cancellation_state function. +

+
+ + Examples +
+

+ The following example illustrates manual error handling and explicit checks + for cancellation. The completion handler is invoked via a co_yield + to the state's complete function, + which never returns. +

+
template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    CompletionToken&& token)
+{
+  return asio::async_initiate<
+    CompletionToken, void(std::error_code)>(
+      asio::co_composed(
+        [](auto state, tcp::socket& socket) -> void
+        {
+          state.reset_cancellation_state(
+            asio::enable_terminal_cancellation());
+
+          while (!state.cancelled())
+          {
+            char data[1024];
+            auto [e1, n1] =
+              co_await socket.async_read_some(
+                asio::buffer(data));
+
+            if (e1)
+              co_yield state.complete(e1);
+
+            if (!!state.cancelled())
+              co_yield state.complete(
+                make_error_code(asio::error::operation_aborted));
+
+            auto [e2, n2] =
+              co_await asio::async_write(socket,
+                asio::buffer(data, n1));
+
+            if (e2)
+              co_yield state.complete(e2);
+          }
+        }, socket),
+      token, std::ref(socket));
+}
+
+

+ This next example shows exception-based error handling and implicit checks + for cancellation. The completion handler is invoked after returning from + the coroutine via co_return. + Valid co_return values are + specified using completion signatures passed to the co_composed + function. +

+
template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    CompletionToken&& token)
+{
+  return asio::async_initiate<
+    CompletionToken, void(std::error_code)>(
+      asio::co_composed<
+        void(std::error_code)>(
+          [](auto state, tcp::socket& socket) -> void
+          {
+            try
+            {
+              state.throw_if_cancelled(true);
+              state.reset_cancellation_state(
+                asio::enable_terminal_cancellation());
+
+              for (;;)
+              {
+                char data[1024];
+                std::size_t n = co_await socket.async_read_some(
+                    asio::buffer(data));
+
+                co_await asio::async_write(socket,
+                    asio::buffer(data, n));
+              }
+            }
+            catch (const std::system_error& e)
+            {
+              co_return {e.code()};
+            }
+          }, socket),
+      token, std::ref(socket));
+}
+
+
+ + Requirements +
+

+ Header: asio/co_composed.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_spawn.html b/Packages/asio-1.36.0/doc/asio/reference/co_spawn.html new file mode 100644 index 0000000..466e2c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_spawn.html @@ -0,0 +1,119 @@ + + + +co_spawn + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Spawn a new coroutined-based thread of execution. +

+
template<
+    typename Executor,
+    typename T,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    const Executor & ex,
+    awaitable< T, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t<(is_executor< Executor >::value||execution::is_executor< Executor >::value) &&is_convertible< Executor, AwaitableExecutor >::value >  = 0);
+  » more...
+
+template<
+    typename Executor,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    const Executor & ex,
+    awaitable< void, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t<(is_executor< Executor >::value||execution::is_executor< Executor >::value) &&is_convertible< Executor, AwaitableExecutor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename T,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    ExecutionContext & ctx,
+    awaitable< T, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value &&is_convertible< typename ExecutionContext::executor_type, AwaitableExecutor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    ExecutionContext & ctx,
+    awaitable< void, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value &&is_convertible< typename ExecutionContext::executor_type, AwaitableExecutor >::value >  = 0);
+  » more...
+
+template<
+    typename Executor,
+    typename F,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    const Executor & ex,
+    F && f,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename F,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    ExecutionContext & ctx,
+    F && f,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/impl/co_spawn.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload1.html new file mode 100644 index 0000000..2cc6b39 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload1.html @@ -0,0 +1,135 @@ + + + +co_spawn (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a new coroutined-based thread of execution. +

+
template<
+    typename Executor,
+    typename T,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    const Executor & ex,
+    awaitable< T, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t<(is_executor< Executor >::value||execution::is_executor< Executor >::value) &&is_convertible< Executor, AwaitableExecutor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ex
+

+ The executor that will be used to schedule the new thread of execution. +

+
a
+

+ The awaitable + object that is the result of calling the coroutine's entry point + function. +

+
token
+
+

+ The completion + token that will handle the notification that the thread of + execution has completed. The function signature of the completion + handler must be: +

+
void handler(std::exception_ptr, T);
+
+
+
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, T)
+
+
+ + Example +
+
asio::awaitable<std::size_t> echo(tcp::socket socket)
+{
+  std::size_t bytes_transferred = 0;
+
+  try
+  {
+    char data[1024];
+    for (;;)
+    {
+      std::size_t n = co_await socket.async_read_some(
+          asio::buffer(data), asio::use_awaitable);
+
+      co_await asio::async_write(socket,
+          asio::buffer(data, n), asio::use_awaitable);
+
+      bytes_transferred += n;
+    }
+  }
+  catch (const std::exception&)
+  {
+  }
+
+  co_return bytes_transferred;
+}
+
+// ...
+
+asio::co_spawn(my_executor,
+  echo(std::move(my_tcp_socket)),
+  [](std::exception_ptr e, std::size_t n)
+  {
+    std::cout << "transferred " << n << "\n";
+  });
+
+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call this_coro::reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload2.html new file mode 100644 index 0000000..ae43b59 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload2.html @@ -0,0 +1,126 @@ + + + +co_spawn (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a new coroutined-based thread of execution. +

+
template<
+    typename Executor,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    const Executor & ex,
+    awaitable< void, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t<(is_executor< Executor >::value||execution::is_executor< Executor >::value) &&is_convertible< Executor, AwaitableExecutor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ex
+

+ The executor that will be used to schedule the new thread of execution. +

+
a
+

+ The awaitable + object that is the result of calling the coroutine's entry point + function. +

+
token
+
+

+ The completion + token that will handle the notification that the thread of + execution has completed. The function signature of the completion + handler must be: +

+
void handler(std::exception_ptr);
+
+
+
+
+
+ + Completion + Signature +
+
void(std::exception_ptr)
+
+
+ + Example +
+
asio::awaitable<void> echo(tcp::socket socket)
+{
+  try
+  {
+    char data[1024];
+    for (;;)
+    {
+      std::size_t n = co_await socket.async_read_some(
+          asio::buffer(data), asio::use_awaitable);
+
+      co_await asio::async_write(socket,
+          asio::buffer(data, n), asio::use_awaitable);
+    }
+  }
+  catch (const std::exception& e)
+  {
+    std::cerr << "Exception: " << e.what() << "\n";
+  }
+}
+
+// ...
+
+asio::co_spawn(my_executor,
+  echo(std::move(my_tcp_socket)),
+  asio::detached);
+
+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call this_coro::reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload3.html new file mode 100644 index 0000000..c4e10b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload3.html @@ -0,0 +1,136 @@ + + + +co_spawn (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a new coroutined-based thread of execution. +

+
template<
+    typename ExecutionContext,
+    typename T,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    ExecutionContext & ctx,
+    awaitable< T, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value &&is_convertible< typename ExecutionContext::executor_type, AwaitableExecutor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context that will provide the executor to be used to + schedule the new thread of execution. +

+
a
+

+ The awaitable + object that is the result of calling the coroutine's entry point + function. +

+
token
+
+

+ The completion + token that will handle the notification that the thread of + execution has completed. The function signature of the completion + handler must be: +

+
void handler(std::exception_ptr);
+
+
+
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, T)
+
+
+ + Example +
+
asio::awaitable<std::size_t> echo(tcp::socket socket)
+{
+  std::size_t bytes_transferred = 0;
+
+  try
+  {
+    char data[1024];
+    for (;;)
+    {
+      std::size_t n = co_await socket.async_read_some(
+          asio::buffer(data), asio::use_awaitable);
+
+      co_await asio::async_write(socket,
+          asio::buffer(data, n), asio::use_awaitable);
+
+      bytes_transferred += n;
+    }
+  }
+  catch (const std::exception&)
+  {
+  }
+
+  co_return bytes_transferred;
+}
+
+// ...
+
+asio::co_spawn(my_io_context,
+  echo(std::move(my_tcp_socket)),
+  [](std::exception_ptr e, std::size_t n)
+  {
+    std::cout << "transferred " << n << "\n";
+  });
+
+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call this_coro::reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload4.html new file mode 100644 index 0000000..44b1746 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload4.html @@ -0,0 +1,127 @@ + + + +co_spawn (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a new coroutined-based thread of execution. +

+
template<
+    typename ExecutionContext,
+    typename AwaitableExecutor,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    ExecutionContext & ctx,
+    awaitable< void, AwaitableExecutor > a,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value &&is_convertible< typename ExecutionContext::executor_type, AwaitableExecutor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context that will provide the executor to be used to + schedule the new thread of execution. +

+
a
+

+ The awaitable + object that is the result of calling the coroutine's entry point + function. +

+
token
+
+

+ The completion + token that will handle the notification that the thread of + execution has completed. The function signature of the completion + handler must be: +

+
void handler(std::exception_ptr);
+
+
+
+
+
+ + Completion + Signature +
+
void(std::exception_ptr)
+
+
+ + Example +
+
asio::awaitable<void> echo(tcp::socket socket)
+{
+  try
+  {
+    char data[1024];
+    for (;;)
+    {
+      std::size_t n = co_await socket.async_read_some(
+          asio::buffer(data), asio::use_awaitable);
+
+      co_await asio::async_write(socket,
+          asio::buffer(data, n), asio::use_awaitable);
+    }
+  }
+  catch (const std::exception& e)
+  {
+    std::cerr << "Exception: " << e.what() << "\n";
+  }
+}
+
+// ...
+
+asio::co_spawn(my_io_context,
+  echo(std::move(my_tcp_socket)),
+  asio::detached);
+
+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call this_coro::reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload5.html new file mode 100644 index 0000000..e28a39f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload5.html @@ -0,0 +1,159 @@ + + + +co_spawn (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a new coroutined-based thread of execution. +

+
template<
+    typename Executor,
+    typename F,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    const Executor & ex,
+    F && f,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ex
+

+ The executor that will be used to schedule the new thread of execution. +

+
f
+

+ A nullary function object with a return type of the form asio::awaitable<R,E> + that will be used as the coroutine's entry point. +

+
token
+

+ The completion + token that will handle the notification that the thread of + execution has completed. If R + is void, the function + signature of the completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the first template + argument to the awaitable + returned by the supplied function object F: +

+
asio::awaitable<R, AwaitableExecutor> F()
+
+
+ + Example +
+
asio::awaitable<std::size_t> echo(tcp::socket socket)
+{
+  std::size_t bytes_transferred = 0;
+
+  try
+  {
+    char data[1024];
+    for (;;)
+    {
+      std::size_t n = co_await socket.async_read_some(
+          asio::buffer(data), asio::use_awaitable);
+
+      co_await asio::async_write(socket,
+          asio::buffer(data, n), asio::use_awaitable);
+
+      bytes_transferred += n;
+    }
+  }
+  catch (const std::exception&)
+  {
+  }
+
+  co_return bytes_transferred;
+}
+
+// ...
+
+asio::co_spawn(my_executor,
+  [socket = std::move(my_tcp_socket)]() mutable
+    -> asio::awaitable<void>
+  {
+    try
+    {
+      char data[1024];
+      for (;;)
+      {
+        std::size_t n = co_await socket.async_read_some(
+            asio::buffer(data), asio::use_awaitable);
+
+        co_await asio::async_write(socket,
+            asio::buffer(data, n), asio::use_awaitable);
+      }
+    }
+    catch (const std::exception& e)
+    {
+      std::cerr << "Exception: " << e.what() << "\n";
+    }
+  }, asio::detached);
+
+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call this_coro::reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload6.html new file mode 100644 index 0000000..15a4259 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/co_spawn/overload6.html @@ -0,0 +1,160 @@ + + + +co_spawn (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a new coroutined-based thread of execution. +

+
template<
+    typename ExecutionContext,
+    typename F,
+    typename CompletionToken = DEFAULT>
+DEDUCED co_spawn(
+    ExecutionContext & ctx,
+    F && f,
+    CompletionToken && token = DEFAULT,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context that will provide the executor to be used to + schedule the new thread of execution. +

+
f
+

+ A nullary function object with a return type of the form asio::awaitable<R,E> + that will be used as the coroutine's entry point. +

+
token
+

+ The completion + token that will handle the notification that the thread of + execution has completed. If R + is void, the function + signature of the completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the first template + argument to the awaitable + returned by the supplied function object F: +

+
asio::awaitable<R, AwaitableExecutor> F()
+
+
+ + Example +
+
asio::awaitable<std::size_t> echo(tcp::socket socket)
+{
+  std::size_t bytes_transferred = 0;
+
+  try
+  {
+    char data[1024];
+    for (;;)
+    {
+      std::size_t n = co_await socket.async_read_some(
+          asio::buffer(data), asio::use_awaitable);
+
+      co_await asio::async_write(socket,
+          asio::buffer(data, n), asio::use_awaitable);
+
+      bytes_transferred += n;
+    }
+  }
+  catch (const std::exception&)
+  {
+  }
+
+  co_return bytes_transferred;
+}
+
+// ...
+
+asio::co_spawn(my_io_context,
+  [socket = std::move(my_tcp_socket)]() mutable
+    -> asio::awaitable<void>
+  {
+    try
+    {
+      char data[1024];
+      for (;;)
+      {
+        std::size_t n = co_await socket.async_read_some(
+            asio::buffer(data), asio::use_awaitable);
+
+        co_await asio::async_write(socket,
+            asio::buffer(data, n), asio::use_awaitable);
+      }
+    }
+    catch (const std::exception& e)
+    {
+      std::cerr << "Exception: " << e.what() << "\n";
+    }
+  }, asio::detached);
+
+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call this_coro::reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of.html b/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of.html new file mode 100644 index 0000000..65074fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of.html @@ -0,0 +1,101 @@ + + + +completion_signature_of + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The completion_signature_of trait determines + the completion signature of an asynchronous operation. +

+
template<
+    typename T,
+    typename... Args>
+struct completion_signature_of
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+

+ Class template completion_signature_of + is a trait with a member type alias type + that denotes the completion signature of the asynchronous operation initiated + by the expression T(Args..., token) + operation, where token is + an unspecified completion token type. If the asynchronous operation does + not have exactly one completion signature, the instantion of the trait is + well-formed but the member type alias type + is omitted. If the expression T(Args..., + token) + is not an asynchronous operation then use of the trait is ill-formed. +

+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of/type.html b/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of/type.html new file mode 100644 index 0000000..3459627 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of/type.html @@ -0,0 +1,50 @@ + + + +completion_signature_of::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef automatically_determined type;
+
+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of_t.html b/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of_t.html new file mode 100644 index 0000000..1c64296 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/completion_signature_of_t.html @@ -0,0 +1,94 @@ + + + +completion_signature_of_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef typename completion_signature_of< T, Args... >::type completion_signature_of_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+

+ Class template completion_signature_of + is a trait with a member type alias type + that denotes the completion signature of the asynchronous operation initiated + by the expression T(Args..., token) + operation, where token is + an unspecified completion token type. If the asynchronous operation does + not have exactly one completion signature, the instantion of the trait is + well-formed but the member type alias type + is omitted. If the expression T(Args..., + token) + is not an asynchronous operation then use of the trait is ill-formed. +

+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/composed.html b/Packages/asio-1.36.0/doc/asio/reference/composed.html new file mode 100644 index 0000000..29299dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/composed.html @@ -0,0 +1,162 @@ + + + +composed + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Creates an initiation function object that may be used to launch an asynchronous + operation with a stateful implementation. +

+
template<
+    typename... Signatures,
+    typename Implementation,
+    typename... IoObjectsOrExecutors>
+auto composed(
+    Implementation && implementation,
+    IoObjectsOrExecutors &&... io_objects_or_executors);
+
+

+ The composed function simplifies + the implementation of composed asynchronous operations automatically by wrapping + a stateful function object for use as an initiation function object. +

+
+ + Parameters +
+
+

+
+
implementation
+

+ A function object that contains the implementation of the composed + asynchronous operation. The first argument to the function object is + a non-const reference to the enclosing intermediate completion handler. + The remaining arguments are any arguments that originate from the completion + handlers of any asynchronous operations performed by the implementation. +

+
io_objects_or_executors
+

+ Zero or more I/O objects or I/O executors for which outstanding work + must be maintained. +

+
+
+
+ + Per-Operation + Cancellation +
+

+ By default, terminal per-operation cancellation is enabled for composed operations + that are implemented using composed. + To disable cancellation for the composed operation, or to alter its supported + cancellation types, call the self + object's reset_cancellation_state + function. +

+
+ + Example: +
+
struct async_echo_implementation
+{
+  tcp::socket& socket_;
+  asio::mutable_buffer buffer_;
+  enum { starting, reading, writing } state_;
+
+  template <typename Self>
+  void operator()(Self& self,
+      asio::error_code error,
+      std::size_t n)
+  {
+    switch (state_)
+    {
+    case starting:
+      state_ = reading;
+      socket_.async_read_some(
+          buffer_, std::move(self));
+      break;
+    case reading:
+      if (error)
+      {
+        self.complete(error, 0);
+      }
+      else
+      {
+        state_ = writing;
+        asio::async_write(socket_, buffer_,
+            asio::transfer_exactly(n),
+            std::move(self));
+      }
+      break;
+    case writing:
+      self.complete(error, n);
+      break;
+    }
+  }
+};
+
+template <typename CompletionToken>
+auto async_echo(tcp::socket& socket,
+    asio::mutable_buffer buffer,
+    CompletionToken&& token)
+  -> decltype(
+    asio::async_initiate<CompletionToken,
+      void(asio::error_code, std::size_t)>(
+        asio::composed(
+          async_echo_implementation{socket, buffer,
+            async_echo_implementation::starting}, socket),
+        token))
+{
+  return asio::async_initiate<CompletionToken,
+    void(asio::error_code, std::size_t)>(
+      asio::composed(
+        async_echo_implementation{socket, buffer,
+          async_echo_implementation::starting}, socket),
+      token, asio::error_code{}, 0);
+}
+
+
+ + Requirements +
+

+ Header: asio/composed.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config.html b/Packages/asio-1.36.0/doc/asio/reference/config.html new file mode 100644 index 0000000..e78bab0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config.html @@ -0,0 +1,104 @@ + + + +config + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+config +

+

+ +

+

+ Provides access to the configuration values associated with an execution + context. +

+
class config
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ config + [constructor] +

+ 		+

+ Constructor.
—
Copy constructor. +

+
+

+ get +

+ 		+

+ Retrieve an integral configuration value. +

+
+
+ + Requirements +
+

+ Header: asio/config.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config/config.html b/Packages/asio-1.36.0/doc/asio/reference/config/config.html new file mode 100644 index 0000000..856c7d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config/config.html @@ -0,0 +1,50 @@ + + + +config::config + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
explicit config(
+    execution_context & context);
+  » more...
+
+

+ Copy constructor. +

+
config(
+    const config & other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config/config/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/config/config/overload1.html new file mode 100644 index 0000000..21c23e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config/config/overload1.html @@ -0,0 +1,47 @@ + + + +config::config (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
config(
+    execution_context & context);
+
+

+ This constructor initialises a config + object to retrieve configuration values associated with the specified + execution context. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config/config/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/config/config/overload2.html new file mode 100644 index 0000000..99ace4c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config/config/overload2.html @@ -0,0 +1,42 @@ + + + +config::config (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
config(
+    const config & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config/get.html b/Packages/asio-1.36.0/doc/asio/reference/config/get.html new file mode 100644 index 0000000..0903fbf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config/get.html @@ -0,0 +1,46 @@ + + + +config::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Retrieve an integral configuration value. +

+
template<
+    typename T>
+constraint_t< is_integral< T >::value, T > get(
+    const char * section,
+    const char * key_name,
+    T default_value) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint.html new file mode 100644 index 0000000..c521cb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint.html @@ -0,0 +1,115 @@ + + + +config_from_concurrency_hint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Configures an execution context based on a concurrency hint. +

+
class config_from_concurrency_hint :
+  public execution_context::service_maker
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ config_from_concurrency_hint [constructor] +

+ 		+

+ Construct with a default concurrency hint.
—
Construct + with a specified concurrency hint. +

+
+

+ make +

+ 		+

+ Add a concrete service to the specified execution context. +

+
+

+ This configuration service is provided for backwards compatibility with the + existing concurrency hint mechanism. +

+
+ + Example +
+
asio::io_context my_io_context{
+   asio::config_from_concurrency_hint{1}};
+
+
+ + Requirements +
+

+ Header: asio/config.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint.html new file mode 100644 index 0000000..1132c30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint.html @@ -0,0 +1,50 @@ + + + +config_from_concurrency_hint::config_from_concurrency_hint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + with a default concurrency hint. +

+
config_from_concurrency_hint();
+  » more...
+
+

+ Construct with a specified concurrency hint. +

+
explicit config_from_concurrency_hint(
+    int concurrency_hint);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint/overload1.html new file mode 100644 index 0000000..58e9ae2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint/overload1.html @@ -0,0 +1,41 @@ + + + +config_from_concurrency_hint::config_from_concurrency_hint (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with a default concurrency hint. +

+
config_from_concurrency_hint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint/overload2.html new file mode 100644 index 0000000..d202add --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/config_from_concurrency_hint/overload2.html @@ -0,0 +1,42 @@ + + + +config_from_concurrency_hint::config_from_concurrency_hint (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with a specified concurrency hint. +

+
config_from_concurrency_hint(
+    int concurrency_hint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/make.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/make.html new file mode 100644 index 0000000..783499e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_concurrency_hint/make.html @@ -0,0 +1,43 @@ + + + +config_from_concurrency_hint::make + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Add + a concrete service to the specified execution context. +

+
virtual void make(
+    execution_context & ctx) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_env.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_env.html new file mode 100644 index 0000000..fd4e572 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_env.html @@ -0,0 +1,116 @@ + + + +config_from_env + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Configures an execution context by reading environment variables. +

+
class config_from_env :
+  public execution_context::service_maker
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ config_from_env [constructor] +

+ 		+

+ Construct with the default prefix "asio".
—
+ Construct with a specified prefix. +

+
+

+ make +

+ 		+

+ Add a concrete service to the specified execution context. +

+
+

+ The environment variable names are formed by concatenating the prefix, section, + and key, with underscore as delimiter, and then converting the resulting + string to upper case. +

+
+ + Example +
+
asio::io_context my_io_context{
+   asio::config_from_env{"my_app"}};
+
+
+ + Requirements +
+

+ Header: asio/config.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env.html new file mode 100644 index 0000000..3c7d70b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env.html @@ -0,0 +1,50 @@ + + + +config_from_env::config_from_env + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + with the default prefix "asio". +

+
config_from_env();
+  » more...
+
+

+ Construct with a specified prefix. +

+
explicit config_from_env(
+    std::string prefix);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env/overload1.html new file mode 100644 index 0000000..e43804b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env/overload1.html @@ -0,0 +1,41 @@ + + + +config_from_env::config_from_env (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with the default prefix "asio". +

+
config_from_env();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env/overload2.html new file mode 100644 index 0000000..4c54417 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/config_from_env/overload2.html @@ -0,0 +1,42 @@ + + + +config_from_env::config_from_env (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with a specified prefix. +

+
config_from_env(
+    std::string prefix);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_env/make.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/make.html new file mode 100644 index 0000000..02b86ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_env/make.html @@ -0,0 +1,43 @@ + + + +config_from_env::make + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Add a concrete service + to the specified execution context. +

+
virtual void make(
+    execution_context & ctx) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_string.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_string.html new file mode 100644 index 0000000..fa0db4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_string.html @@ -0,0 +1,129 @@ + + + +config_from_string + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Configures an execution context by reading variables from a string. +

+
class config_from_string :
+  public execution_context::service_maker
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ config_from_string [constructor] +

+ 		+

+ Construct with the default prefix "asio".
—
+ Construct with a specified prefix. +

+
+

+ make +

+ 		+

+ Add a concrete service to the specified execution context. +

+
+

+ Each variable must be on a line of its own, and of the form: +

+

+ section.key=value +

+

+ or, if an optional prefix is specified: +

+

+ prefix.section.key=value +

+

+ Blank lines and lines starting with # + are ignored. It is also permitted to include a comment starting with # after the value. +

+
+ + Example +
+
asio::io_context my_io_context{
+   asio::config_from_string{
+     "scheduler.concurrency_hint=10\n"
+     "scheduler.locking=1"}};
+
+
+ + Requirements +
+

+ Header: asio/config.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string.html new file mode 100644 index 0000000..7784e5b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string.html @@ -0,0 +1,52 @@ + + + +config_from_string::config_from_string + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + with the default prefix "asio". +

+
explicit config_from_string(
+    std::string s);
+  » more...
+
+

+ Construct with a specified prefix. +

+
config_from_string(
+    std::string s,
+    std::string prefix);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string/overload1.html new file mode 100644 index 0000000..113b5a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string/overload1.html @@ -0,0 +1,42 @@ + + + +config_from_string::config_from_string (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with the default prefix "asio". +

+
config_from_string(
+    std::string s);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string/overload2.html new file mode 100644 index 0000000..908058b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/config_from_string/overload2.html @@ -0,0 +1,43 @@ + + + +config_from_string::config_from_string (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with a specified prefix. +

+
config_from_string(
+    std::string s,
+    std::string prefix);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_from_string/make.html b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/make.html new file mode 100644 index 0000000..a24a300 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_from_string/make.html @@ -0,0 +1,43 @@ + + + +config_from_string::make + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Add a concrete + service to the specified execution context. +

+
virtual void make(
+    execution_context & ctx) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_service.html b/Packages/asio-1.36.0/doc/asio/reference/config_service.html new file mode 100644 index 0000000..b321d11 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_service.html @@ -0,0 +1,158 @@ + + + +config_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Base class for configuration implementations. +

+
class config_service :
+  public execution_context::service
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ key_type +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ config_service [constructor] +

+ 		+

+ Constructor. +

+
+

+ context +

+ 		+

+ Get the context object that owns the service. +

+
+

+ get_value +

+ 		+

+ Retrieve a configuration value. +

+
+

+ shutdown +

+ 		+

+ Shutdown the service. +

+
+
+ + Requirements +
+

+ Header: asio/config.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_service/config_service.html b/Packages/asio-1.36.0/doc/asio/reference/config_service/config_service.html new file mode 100644 index 0000000..3886379 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_service/config_service.html @@ -0,0 +1,42 @@ + + + +config_service::config_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
config_service(
+    execution_context & ctx);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_service/context.html b/Packages/asio-1.36.0/doc/asio/reference/config_service/context.html new file mode 100644 index 0000000..3bd8bc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_service/context.html @@ -0,0 +1,45 @@ + + + +config_service::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Get the context + object that owns the service. +

+
execution_context & context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_service/get_value.html b/Packages/asio-1.36.0/doc/asio/reference/config_service/get_value.html new file mode 100644 index 0000000..ab64c0c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_service/get_value.html @@ -0,0 +1,46 @@ + + + +config_service::get_value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Retrieve + a configuration value. +

+
virtual const char * get_value(
+    const char * section,
+    const char * key_name,
+    char * value,
+    std::size_t value_len) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_service/key_type.html b/Packages/asio-1.36.0/doc/asio/reference/config_service/key_type.html new file mode 100644 index 0000000..90f3404 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_service/key_type.html @@ -0,0 +1,154 @@ + + + +config_service::key_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef config_service key_type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ key_type +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ config_service [constructor] +

+ 		+

+ Constructor. +

+
+

+ context +

+ 		+

+ Get the context object that owns the service. +

+
+

+ get_value +

+ 		+

+ Retrieve a configuration value. +

+
+

+ shutdown +

+ 		+

+ Shutdown the service. +

+
+
+ + Requirements +
+

+ Header: asio/config.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/config_service/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/config_service/shutdown.html new file mode 100644 index 0000000..8c5f2f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/config_service/shutdown.html @@ -0,0 +1,42 @@ + + + +config_service::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Shutdown the + service. +

+
virtual void shutdown();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect.html b/Packages/asio-1.36.0/doc/asio/reference/connect.html new file mode 100644 index 0000000..25d3ec6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect.html @@ -0,0 +1,152 @@ + + + +connect + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The connect function is a + composed operation that establishes a socket connection by trying each endpoint + in a sequence. +

+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    asio::error_code & ec,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename ConnectCondition>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    ConnectCondition connect_condition,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< is_connect_condition< ConnectCondition, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename ConnectCondition>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    ConnectCondition connect_condition,
+    asio::error_code & ec,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< is_connect_condition< ConnectCondition, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename ConnectCondition>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    ConnectCondition connect_condition,
+    constraint_t< is_connect_condition< ConnectCondition, Iterator >::value >  = 0);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename ConnectCondition>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    ConnectCondition connect_condition,
+    asio::error_code & ec,
+    constraint_t< is_connect_condition< ConnectCondition, Iterator >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/impl/connect.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload1.html new file mode 100644 index 0000000..4b21bdd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload1.html @@ -0,0 +1,102 @@ + + + +connect (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The socket to be connected. If the socket is already open, it will + be closed. +

+
endpoints
+

+ A sequence of endpoints. +

+
+
+
+ + Return + Value +
+

+ The successfully connected endpoint. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the sequence is empty, the associated error_code is asio::error::not_found. + Otherwise, contains the error from the last connection attempt. +

+
+
+
+ + Example +
+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::socket s(my_context);
+asio::connect(s, r.resolve(q));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload2.html new file mode 100644 index 0000000..939c3b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload2.html @@ -0,0 +1,101 @@ + + + +connect (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    asio::error_code & ec,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The socket to be connected. If the socket is already open, it will + be closed. +

+
endpoints
+

+ A sequence of endpoints. +

+
ec
+

+ Set to indicate what error occurred, if any. If the sequence is empty, + set to asio::error::not_found. Otherwise, contains + the error from the last connection attempt. +

+
+
+
+ + Return + Value +
+

+ On success, the successfully connected endpoint. Otherwise, a default-constructed + endpoint. +

+
+ + Example +
+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::socket s(my_context);
+asio::error_code ec;
+asio::connect(s, r.resolve(q), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload3.html new file mode 100644 index 0000000..16ff1dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload3.html @@ -0,0 +1,107 @@ + + + +connect (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
end
+

+ An iterator pointing to the end of a sequence of endpoints. +

+
+
+
+ + Return + Value +
+

+ An iterator denoting the successfully connected endpoint. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the sequence is empty, the associated error_code is asio::error::not_found. + Otherwise, contains the error from the last connection attempt. +

+
+
+
+ + Example +
+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::resolver::results_type e = r.resolve(q);
+tcp::socket s(my_context);
+asio::connect(s, e.begin(), e.end());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload4.html new file mode 100644 index 0000000..c099ced --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload4.html @@ -0,0 +1,106 @@ + + + +connect (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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 asio::error::not_found. Otherwise, contains + the error from the last connection attempt. +

+
+
+
+ + Return + Value +
+

+ On success, an iterator denoting the successfully connected endpoint. Otherwise, + the end iterator. +

+
+ + Example +
+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::resolver::results_type e = r.resolve(q);
+tcp::socket s(my_context);
+asio::error_code ec;
+asio::connect(s, e.begin(), e.end(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload5.html new file mode 100644 index 0000000..effa99f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload5.html @@ -0,0 +1,146 @@ + + + +connect (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename ConnectCondition>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    ConnectCondition connect_condition,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< is_connect_condition< ConnectCondition, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The socket to be connected. If the socket is already open, it will + be closed. +

+
endpoints
+

+ 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: +

+
bool connect_condition(
+   const asio::error_code& ec,
+   const typename Protocol::endpoint& 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 the next endpoint to be tried. The function object should + return true if the next endpoint should be tried, and false if it + should be skipped. +

+
+
+
+
+ + Return + Value +
+

+ The successfully connected endpoint. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the sequence is empty, the associated error_code is asio::error::not_found. + Otherwise, contains the error from the last connection attempt. +

+
+
+
+ + Example +
+

+ The following connect condition function object can be used to output information + about the individual connection attempts: +

+
struct my_connect_condition
+{
+  bool operator()(
+      const asio::error_code& ec,
+      const::tcp::endpoint& next)
+  {
+    if (ec) std::cout << "Error: " << ec.message() << std::endl;
+    std::cout << "Trying: " << next << std::endl;
+    return true;
+  }
+};
+
+

+ It would be used with the connect function as follows: +

+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::socket s(my_context);
+tcp::endpoint e = asio::connect(s,
+    r.resolve(q), my_connect_condition());
+std::cout << "Connected to: " << e << std::endl;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload6.html new file mode 100644 index 0000000..b906620 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload6.html @@ -0,0 +1,148 @@ + + + +connect (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename EndpointSequence,
+    typename ConnectCondition>
+Protocol::endpoint connect(
+    basic_socket< Protocol, Executor > & s,
+    const EndpointSequence & endpoints,
+    ConnectCondition connect_condition,
+    asio::error_code & ec,
+    constraint_t< is_endpoint_sequence< EndpointSequence >::value >  = 0,
+    constraint_t< is_connect_condition< ConnectCondition, decltype(declval< const EndpointSequence & >().begin())>::value >= 0);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The socket to be connected. If the socket is already open, it will + be closed. +

+
endpoints
+

+ 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: +

+
bool connect_condition(
+   const asio::error_code& ec,
+   const typename Protocol::endpoint& 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 the next endpoint to be tried. The function object should + return true if the next endpoint should be tried, and false if it + should be skipped. +

+
+
ec
+

+ Set to indicate what error occurred, if any. If the sequence is empty, + set to asio::error::not_found. Otherwise, contains + the error from the last connection attempt. +

+
+
+
+ + Return + Value +
+

+ On success, the successfully connected endpoint. Otherwise, a default-constructed + endpoint. +

+
+ + Example +
+

+ The following connect condition function object can be used to output information + about the individual connection attempts: +

+
struct my_connect_condition
+{
+  bool operator()(
+      const asio::error_code& ec,
+      const::tcp::endpoint& next)
+  {
+    if (ec) std::cout << "Error: " << ec.message() << std::endl;
+    std::cout << "Trying: " << next << std::endl;
+    return true;
+  }
+};
+
+

+ It would be used with the connect function as follows: +

+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::socket s(my_context);
+asio::error_code ec;
+tcp::endpoint e = asio::connect(s,
+    r.resolve(q), my_connect_condition(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+else
+{
+  std::cout << "Connected to: " << e << std::endl;
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload7.html new file mode 100644 index 0000000..9139df2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload7.html @@ -0,0 +1,151 @@ + + + +connect (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename ConnectCondition>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    ConnectCondition connect_condition,
+    constraint_t< is_connect_condition< ConnectCondition, Iterator >::value >  = 0);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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: +

+
bool connect_condition(
+   const asio::error_code& ec,
+   const typename Protocol::endpoint& 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 the next endpoint to be tried. The function object should + return true if the next endpoint should be tried, and false if it + should be skipped. +

+
+
+
+
+ + Return + Value +
+

+ An iterator denoting the successfully connected endpoint. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the sequence is empty, the associated error_code is asio::error::not_found. + Otherwise, contains the error from the last connection attempt. +

+
+
+
+ + Example +
+

+ The following connect condition function object can be used to output information + about the individual connection attempts: +

+
struct my_connect_condition
+{
+  bool operator()(
+      const asio::error_code& ec,
+      const::tcp::endpoint& next)
+  {
+    if (ec) std::cout << "Error: " << ec.message() << std::endl;
+    std::cout << "Trying: " << next << std::endl;
+    return true;
+  }
+};
+
+

+ It would be used with the connect function as follows: +

+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::resolver::results_type e = r.resolve(q);
+tcp::socket s(my_context);
+tcp::resolver::results_type::iterator i = asio::connect(
+    s, e.begin(), e.end(), my_connect_condition());
+std::cout << "Connected to: " << i->endpoint() << std::endl;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/connect/overload8.html new file mode 100644 index 0000000..4947a6a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect/overload8.html @@ -0,0 +1,153 @@ + + + +connect (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Establishes a socket connection by trying each endpoint in a sequence. +

+
template<
+    typename Protocol,
+    typename Executor,
+    typename Iterator,
+    typename ConnectCondition>
+Iterator connect(
+    basic_socket< Protocol, Executor > & s,
+    Iterator begin,
+    Iterator end,
+    ConnectCondition connect_condition,
+    asio::error_code & ec,
+    constraint_t< is_connect_condition< ConnectCondition, Iterator >::value >  = 0);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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: +

+
bool connect_condition(
+   const asio::error_code& ec,
+   const typename Protocol::endpoint& 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 the next endpoint to be tried. The function object should + return true if the next endpoint should be tried, and false if it + should be skipped. +

+
+
ec
+

+ Set to indicate what error occurred, if any. If the sequence is empty, + set to asio::error::not_found. Otherwise, contains + the error from the last connection attempt. +

+
+
+
+ + Return + Value +
+

+ On success, an iterator denoting the successfully connected endpoint. Otherwise, + the end iterator. +

+
+ + Example +
+

+ The following connect condition function object can be used to output information + about the individual connection attempts: +

+
struct my_connect_condition
+{
+  bool operator()(
+      const asio::error_code& ec,
+      const::tcp::endpoint& next)
+  {
+    if (ec) std::cout << "Error: " << ec.message() << std::endl;
+    std::cout << "Trying: " << next << std::endl;
+    return true;
+  }
+};
+
+

+ It would be used with the connect function as follows: +

+
tcp::resolver r(my_context);
+tcp::resolver::query q("host", "service");
+tcp::resolver::results_type e = r.resolve(q);
+tcp::socket s(my_context);
+asio::error_code ec;
+tcp::resolver::results_type::iterator i = asio::connect(
+    s, e.begin(), e.end(), my_connect_condition());
+if (ec)
+{
+  // An error occurred.
+}
+else
+{
+  std::cout << "Connected to: " << i->endpoint() << std::endl;
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/connect_pipe.html new file mode 100644 index 0000000..40861dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect_pipe.html @@ -0,0 +1,68 @@ + + + +connect_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Connect two pipe ends using an anonymous pipe. +

+
template<
+    typename Executor1,
+    typename Executor2>
+void connect_pipe(
+    basic_readable_pipe< Executor1 > & read_end,
+    basic_writable_pipe< Executor2 > & write_end);
+  » more...
+
+template<
+    typename Executor1,
+    typename Executor2>
+void connect_pipe(
+    basic_readable_pipe< Executor1 > & read_end,
+    basic_writable_pipe< Executor2 > & write_end,
+    asio::error_code & ec);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/connect_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect_pipe/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/connect_pipe/overload1.html new file mode 100644 index 0000000..599e3bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect_pipe/overload1.html @@ -0,0 +1,76 @@ + + + +connect_pipe (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Connect two pipe ends using an anonymous pipe. +

+
template<
+    typename Executor1,
+    typename Executor2>
+void connect_pipe(
+    basic_readable_pipe< Executor1 > & read_end,
+    basic_writable_pipe< Executor2 > & write_end);
+
+
+ + Parameters +
+
+

+
+
read_end
+

+ The read end of the pipe. +

+
write_end
+

+ The write end of the pipe. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/connect_pipe/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/connect_pipe/overload2.html new file mode 100644 index 0000000..c2334f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/connect_pipe/overload2.html @@ -0,0 +1,90 @@ + + + +connect_pipe (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Connect two pipe ends using an anonymous pipe. +

+
template<
+    typename Executor1,
+    typename Executor2>
+void connect_pipe(
+    basic_readable_pipe< Executor1 > & read_end,
+    basic_writable_pipe< Executor2 > & write_end,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
read_end
+

+ The read end of the pipe. +

+
write_end
+

+ The write end of the pipe. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/consign.html b/Packages/asio-1.36.0/doc/asio/reference/consign.html new file mode 100644 index 0000000..fbfce23 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/consign.html @@ -0,0 +1,64 @@ + + + +consign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Completion token adapter used to specify that the completion handler should + carry additional values along with it. +

+
template<
+    typename CompletionToken,
+    typename... Values>
+constexpr consign_t< decay_t< CompletionToken >, decay_t< Values >... > consign(
+    CompletionToken && completion_token,
+    Values &&... values);
+
+

+ This completion token adapter is typically used to keep at least one copy + of an object, such as a smart pointer, alive until the completion handler + is called. +

+
+ + Requirements +
+

+ Header: asio/consign.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/consign_t.html b/Packages/asio-1.36.0/doc/asio/reference/consign_t.html new file mode 100644 index 0000000..a282eb6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/consign_t.html @@ -0,0 +1,98 @@ + + + +consign_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Completion token type used to specify that the completion handler should + carry additional values along with it. +

+
template<
+    typename CompletionToken,
+    typename... Values>
+class consign_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ consign_t + [constructor] +

+ 		+

+ Constructor. +

+
+

+ This completion token adapter is typically used to keep at least one copy + of an object, such as a smart pointer, alive until the completion handler + is called. +

+
+ + Requirements +
+

+ Header: asio/consign.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/consign_t/consign_t.html b/Packages/asio-1.36.0/doc/asio/reference/consign_t/consign_t.html new file mode 100644 index 0000000..92249b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/consign_t/consign_t.html @@ -0,0 +1,46 @@ + + + +consign_t::consign_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T,
+    typename... V>
+constexpr consign_t(
+    T && completion_token,
+    V &&... values);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer.html new file mode 100644 index 0000000..298a257 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer.html @@ -0,0 +1,187 @@ + + + +const_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Holds a buffer that cannot be modified. +

+
class const_buffer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffer [constructor] +

+ 		+

+ Construct an empty buffer.
—
Construct a buffer to + represent a given memory range.
—
Construct a non-modifiable + buffer from a modifiable one.
—
Construct a buffer + from a span of bytes. +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new non-modifiable buffer that is offset from the start + of another. +

+
+

+ The 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::const_buffer b1 = ...;
+std::size_t s1 = b1.size();
+const unsigned char* p1 = static_cast<const unsigned char*>(b1.data());
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer.html new file mode 100644 index 0000000..f92da81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer.html @@ -0,0 +1,71 @@ + + + +const_buffer::const_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an empty buffer. +

+
const_buffer();
+  » more...
+
+

+ Construct a buffer to represent a given memory range. +

+
const_buffer(
+    const void * data,
+    std::size_t size);
+  » more...
+
+

+ Construct a non-modifiable buffer from a modifiable one. +

+
const_buffer(
+    const mutable_buffer & b);
+  » more...
+
+

+ Construct a buffer from a span of bytes. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+const_buffer(
+    const Span< T, Extent > & span,
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload1.html new file mode 100644 index 0000000..5329e6a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload1.html @@ -0,0 +1,41 @@ + + + +const_buffer::const_buffer (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an empty buffer. +

+
const_buffer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload2.html new file mode 100644 index 0000000..d875d79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload2.html @@ -0,0 +1,43 @@ + + + +const_buffer::const_buffer (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a buffer to represent a given memory range. +

+
const_buffer(
+    const void * data,
+    std::size_t size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload3.html new file mode 100644 index 0000000..986fec2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload3.html @@ -0,0 +1,42 @@ + + + +const_buffer::const_buffer (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a non-modifiable buffer from a modifiable one. +

+
const_buffer(
+    const mutable_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload4.html new file mode 100644 index 0000000..3c9d3a4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/const_buffer/overload4.html @@ -0,0 +1,48 @@ + + + +const_buffer::const_buffer (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a buffer from a span of bytes. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+const_buffer(
+    const Span< T, Extent > & span,
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/data.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/data.html new file mode 100644 index 0000000..06032c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/data.html @@ -0,0 +1,42 @@ + + + +const_buffer::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a pointer to the beginning + of the memory range. +

+
const void * data() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_.html new file mode 100644 index 0000000..7caab98 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_.html @@ -0,0 +1,50 @@ + + + +const_buffer::operator+ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create a + new non-modifiable buffer that is offset from the start of another. +

+
const_buffer operator+(
+    const const_buffer & b,
+    std::size_t n);
+  » more...
+
+const_buffer operator+(
+    std::size_t n,
+    const const_buffer & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_/overload1.html new file mode 100644 index 0000000..292d82d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_/overload1.html @@ -0,0 +1,43 @@ + + + +const_buffer::operator+ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that is offset from the start of another. +

+
const_buffer operator+(
+    const const_buffer & b,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_/overload2.html new file mode 100644 index 0000000..f561029 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus_/overload2.html @@ -0,0 +1,43 @@ + + + +const_buffer::operator+ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that is offset from the start of another. +

+
const_buffer operator+(
+    std::size_t n,
+    const const_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus__eq_.html new file mode 100644 index 0000000..3165ba1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/operator_plus__eq_.html @@ -0,0 +1,43 @@ + + + +const_buffer::operator+= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move + the start of the buffer by the specified number of bytes. +

+
const_buffer & operator+=(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_buffer/size.html b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/size.html new file mode 100644 index 0000000..5065841 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_buffer/size.html @@ -0,0 +1,42 @@ + + + +const_buffer::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the size of the memory + range. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer.html new file mode 100644 index 0000000..7d856f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer.html @@ -0,0 +1,195 @@ + + + +const_registered_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Holds a registered buffer over non-modifiable data. +

+
class const_registered_buffer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ buffer +

+ 		+

+ Get the underlying constant buffer. +

+
+

+ const_registered_buffer [constructor] +

+ 		+

+ Default constructor creates an invalid registered buffer.
+ —
Construct a non-modifiable buffer from a modifiable one. +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ id +

+ 		+

+ Get the registered buffer identifier. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new non-modifiable registered buffer that is offset from + the start of another. +

+

+ Create a new non-modifiable buffer that is offset from the start + of another. +

+
+

+ Satisfies the ConstBufferSequence + type requirements. +

+
+ + Requirements +
+

+ Header: asio/registered_buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/buffer.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/buffer.html new file mode 100644 index 0000000..074c429 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/buffer.html @@ -0,0 +1,42 @@ + + + +const_registered_buffer::buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the underlying constant buffer. +

+
const const_buffer & buffer() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer.html new file mode 100644 index 0000000..07015c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer.html @@ -0,0 +1,50 @@ + + + +const_registered_buffer::const_registered_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor creates an invalid registered buffer. +

+
const_registered_buffer();
+  » more...
+
+

+ Construct a non-modifiable buffer from a modifiable one. +

+
const_registered_buffer(
+    const mutable_registered_buffer & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer/overload1.html new file mode 100644 index 0000000..343e6d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer/overload1.html @@ -0,0 +1,41 @@ + + + +const_registered_buffer::const_registered_buffer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor creates an invalid registered buffer. +

+
const_registered_buffer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer/overload2.html new file mode 100644 index 0000000..06070a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/const_registered_buffer/overload2.html @@ -0,0 +1,42 @@ + + + +const_registered_buffer::const_registered_buffer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a non-modifiable buffer from a modifiable one. +

+
const_registered_buffer(
+    const mutable_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/data.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/data.html new file mode 100644 index 0000000..74fe930 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/data.html @@ -0,0 +1,50 @@ + + + +const_registered_buffer::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a pointer to the beginning of the memory range. +

+
const void * data() const;
+
+
+ + Return + Value +
+

+ buffer().data(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/id.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/id.html new file mode 100644 index 0000000..d47c828 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/id.html @@ -0,0 +1,42 @@ + + + +const_registered_buffer::id + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + registered buffer identifier. +

+
const registered_buffer_id & id() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_.html new file mode 100644 index 0000000..118bc84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_.html @@ -0,0 +1,54 @@ + + + +const_registered_buffer::operator+ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + a new non-modifiable registered buffer that is offset from the start of + another. +

+
const_registered_buffer operator+(
+    const const_registered_buffer & b,
+    std::size_t n);
+  » more...
+
+

+ Create a new non-modifiable buffer that is offset from the start of another. +

+
const_registered_buffer operator+(
+    std::size_t n,
+    const const_registered_buffer & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_/overload1.html new file mode 100644 index 0000000..614302a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_/overload1.html @@ -0,0 +1,44 @@ + + + +const_registered_buffer::operator+ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable registered buffer that is offset from the + start of another. +

+
const_registered_buffer operator+(
+    const const_registered_buffer & b,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_/overload2.html new file mode 100644 index 0000000..458d702 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus_/overload2.html @@ -0,0 +1,43 @@ + + + +const_registered_buffer::operator+ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new non-modifiable buffer that is offset from the start of another. +

+
const_registered_buffer operator+(
+    std::size_t n,
+    const const_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus__eq_.html new file mode 100644 index 0000000..729196a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/operator_plus__eq_.html @@ -0,0 +1,43 @@ + + + +const_registered_buffer::operator+= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move + the start of the buffer by the specified number of bytes. +

+
const_registered_buffer & operator+=(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/size.html b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/size.html new file mode 100644 index 0000000..67981e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/const_registered_buffer/size.html @@ -0,0 +1,50 @@ + + + +const_registered_buffer::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the size of the memory range. +

+
std::size_t size() const;
+
+
+ + Return + Value +
+

+ buffer().size(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/coroutine.html b/Packages/asio-1.36.0/doc/asio/reference/coroutine.html new file mode 100644 index 0000000..7e7cc98 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/coroutine.html @@ -0,0 +1,450 @@ + + + +coroutine + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides support for implementing stackless coroutines. +

+
class coroutine
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ coroutine + [constructor] +

+ 		+

+ Constructs a coroutine in its initial state. +

+
+

+ is_child +

+ 		+

+ Returns true if the coroutine is the child of a fork. +

+
+

+ is_complete +

+ 		+

+ Returns true if the coroutine has reached its terminal state. +

+
+

+ is_parent +

+ 		+

+ Returns true if the coroutine is the parent of a fork. +

+
+

+ The coroutine class may be + used to implement stackless coroutines. The class itself is used to store + the current state of the coroutine. +

+

+ Coroutines are copy-constructible and assignable, and the space overhead + is a single int. They can be used as a base class: +

+
class session : coroutine
+{
+  ...
+};
+
+

+ or as a data member: +

+
class session
+{
+  ...
+  coroutine coro_;
+};
+
+

+ or even bound in as a function argument using lambdas or bind(). The important thing is that as the application + maintains a copy of the object for as long as the coroutine must be kept + alive. +

+
+ + Pseudo-keywords +
+

+ A coroutine is used in conjunction with certain "pseudo-keywords", + which are implemented as macros. These macros are defined by a header file: +

+
#include <asio/yield.hpp>
+
+

+ and may conversely be undefined as follows: +

+
#include <asio/unyield.hpp>
+
+

+ reenter +

+

+ The reenter macro is used + to define the body of a coroutine. It takes a single argument: a pointer + or reference to a coroutine object. For example, if the base class is a coroutine + object you may write: +

+
reenter (this)
+{
+  ... coroutine body ...
+}
+
+

+ and if a data member or other variable you can write: +

+
reenter (coro_)
+{
+  ... coroutine body ...
+}
+
+

+ When reenter is executed + at runtime, control jumps to the location of the last yield + or fork. +

+

+ The coroutine body may also be a single statement, such as: +

+
reenter (this) for (;;)
+{
+  ...
+}
+
+

+ Limitation: The reenter + macro is implemented using a switch. This means that you must take care when + using local variables within the coroutine body. The local variable is not + allowed in a position where reentering the coroutine could bypass the variable + definition. +

+

+ yield statement +

+

+ This form of the yield keyword + is often used with asynchronous operations: +

+
yield socket_->async_read_some(buffer(*buffer_), *this);
+
+

+ This divides into four logical steps: +

+
    +
  • + yield saves the current + state of the coroutine. +
    • +
  • + The statement initiates the asynchronous operation. +
    • +
  • + The resume point is defined immediately following the statement. +
    • +
  • + Control is transferred to the end of the coroutine body. +
    • +
+

+ When the asynchronous operation completes, the function object is invoked + and reenter causes control + to transfer to the resume point. It is important to remember to carry the + coroutine state forward with the asynchronous operation. In the above snippet, + the current class is a function object object with a coroutine object as + base class or data member. +

+

+ The statement may also be a compound statement, and this permits us to define + local variables with limited scope: +

+
yield
+{
+  mutable_buffer b = buffer(*buffer_);
+  socket_->async_read_some(b, *this);
+}
+
+

+ yield return expression ; +

+

+ This form of yield is often + used in generators or coroutine-based parsers. For example, the function + object: +

+
struct interleave : coroutine
+{
+  istream& is1;
+  istream& is2;
+  char operator()(char c)
+  {
+    reenter (this) for (;;)
+    {
+      yield return is1.get();
+      yield return is2.get();
+    }
+  }
+};
+
+

+ defines a trivial coroutine that interleaves the characters from two input + streams. +

+

+ This type of yield divides + into three logical steps: +

+
    +
  • + yield saves the current + state of the coroutine. +
    • +
  • + The resume point is defined immediately following the semicolon. +
    • +
  • + The value of the expression is returned from the function. +
    • +
+

+ yield ; +

+

+ This form of yield is equivalent + to the following steps: +

+
    +
  • + yield saves the current + state of the coroutine. +
    • +
  • + The resume point is defined immediately following the semicolon. +
    • +
  • + Control is transferred to the end of the coroutine body. +
    • +
+

+ This form might be applied when coroutines are used for cooperative threading + and scheduling is explicitly managed. For example: +

+
struct task : coroutine
+{
+  ...
+  void operator()()
+  {
+    reenter (this)
+    {
+      while (... not finished ...)
+      {
+        ... do something ...
+        yield;
+        ... do some more ...
+        yield;
+      }
+    }
+  }
+  ...
+};
+...
+task t1, t2;
+for (;;)
+{
+  t1();
+  t2();
+}
+
+

+ yield break ; +

+

+ The final form of yield is + used to explicitly terminate the coroutine. This form is comprised of two + steps: +

+
    +
  • + yield sets the coroutine + state to indicate termination. +
    • +
  • + Control is transferred to the end of the coroutine body. +
    • +
+

+ Once terminated, calls to is_complete() return true and the coroutine cannot be + reentered. +

+

+ Note that a coroutine may also be implicitly terminated if the coroutine + body is exited without a yield, e.g. by return, throw or by running to the + end of the body. +

+

+ fork statement +

+

+ The fork pseudo-keyword is + used when "forking" a coroutine, i.e. splitting it into two (or + more) copies. One use of fork + is in a server, where a new coroutine is created to handle each client connection: +

+
reenter (this)
+{
+  do
+  {
+    socket_.reset(new tcp::socket(my_context_));
+    yield acceptor->async_accept(*socket_, *this);
+    fork server(*this)();
+  } while (is_parent());
+  ... client-specific handling follows ...
+}
+
+

+ The logical steps involved in a fork + are: +

+
    +
  • + fork saves the current + state of the coroutine. +
    • +
  • + The statement creates a copy of the coroutine and either executes it + immediately or schedules it for later execution. +
    • +
  • + The resume point is defined immediately following the semicolon. +
    • +
  • + For the "parent", control immediately continues from the next + line. +
    • +
+

+ The functions is_parent() + and is_child() + can be used to differentiate between parent and child. You would use these + functions to alter subsequent control flow. +

+

+ Note that fork doesn't do + the actual forking by itself. It is the application's responsibility to create + a clone of the coroutine and call it. The clone can be called immediately, + as above, or scheduled for delayed execution using something like post. +

+
+ + Alternate + macro names +
+

+ If preferred, an application can use macro names that follow a more typical + naming convention, rather than the pseudo-keywords. These are: +

+
    +
  • + ASIO_CORO_REENTER instead + of reenter +
    • +
  • + ASIO_CORO_YIELD instead + of yield +
    • +
  • + ASIO_CORO_FORK instead + of fork +
    • +
+
+ + Requirements +
+

+ Header: asio/coroutine.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/coroutine/coroutine.html b/Packages/asio-1.36.0/doc/asio/reference/coroutine/coroutine.html new file mode 100644 index 0000000..f5ea816 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/coroutine/coroutine.html @@ -0,0 +1,42 @@ + + + +coroutine::coroutine + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructs a coroutine + in its initial state. +

+
coroutine();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_child.html b/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_child.html new file mode 100644 index 0000000..6741b40 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_child.html @@ -0,0 +1,42 @@ + + + +coroutine::is_child + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns true if the coroutine + is the child of a fork. +

+
bool is_child() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_complete.html b/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_complete.html new file mode 100644 index 0000000..c8189ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_complete.html @@ -0,0 +1,42 @@ + + + +coroutine::is_complete + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns true if + the coroutine has reached its terminal state. +

+
bool is_complete() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_parent.html b/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_parent.html new file mode 100644 index 0000000..2aee1d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/coroutine/is_parent.html @@ -0,0 +1,42 @@ + + + +coroutine::is_parent + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns true if the + coroutine is the parent of a fork. +

+
bool is_parent() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deadline_timer.html b/Packages/asio-1.36.0/doc/asio/reference/deadline_timer.html new file mode 100644 index 0000000..261a0a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deadline_timer.html @@ -0,0 +1,393 @@ + + + +deadline_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ (Deprecated: Use system_timer.) Typedef for the typical usage of timer. Uses + a UTC clock. +

+
typedef basic_deadline_timer< boost::posix_time::ptime > deadline_timer;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ duration_type +

+ 		+

+ The duration type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_type +

+ 		+

+ The time type. +

+
+

+ traits_type +

+ 		+

+ The time traits type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_deadline_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a particular + expiry time relative to now.
—
Move-construct a basic_deadline_timer + from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_at +

+ 		+

+ Get the timer's expiry time as an absolute time.
—
+ Set the timer's expiry time as an absolute time. +

+
+

+ expires_from_now +

+ 		+

+ Get the timer's expiry time relative to now.
—
Set + the timer's expiry time relative to now. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_deadline_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_deadline_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ The basic_deadline_timer + class template provides the ability to perform a blocking or asynchronous + wait for a timer to expire. +

+

+ 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 deadline_timer typedef. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait: +

+
// Construct a timer without setting an expiry time.
+asio::deadline_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_from_now(boost::posix_time::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait: +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::deadline_timer timer(my_context,
+    boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + Changing + an active deadline_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: +

+
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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+
+ + Requirements +
+

+ Header: asio/deadline_timer.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/default_completion_token.html b/Packages/asio-1.36.0/doc/asio/reference/default_completion_token.html new file mode 100644 index 0000000..26fcfeb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/default_completion_token.html @@ -0,0 +1,102 @@ + + + +default_completion_token + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Traits type used to determine the default completion token type associated + with a type (such as an executor). +

+
template<
+    typename T>
+struct default_completion_token
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type default_completion_token_type, T::default_completion_token_type. + Otherwise the typedef type is asio::deferred_t. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. +

+

+ Specialisations of this trait may provide a nested typedef type, which is a default-constructible + completion token type. +

+

+ If not otherwise specialised, the default completion token type is deferred_t. +

+
+ + Requirements +
+

+ Header: asio/default_completion_token.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/default_completion_token/type.html b/Packages/asio-1.36.0/doc/asio/reference/default_completion_token/type.html new file mode 100644 index 0000000..a1a943a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/default_completion_token/type.html @@ -0,0 +1,54 @@ + + + +default_completion_token::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If + T has a nested type default_completion_token_type, T::default_completion_token_type. + Otherwise the typedef type + is deferred_t. +

+
typedef see_below type;
+
+
+ + Requirements +
+

+ Header: asio/default_completion_token.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/default_completion_token_t.html b/Packages/asio-1.36.0/doc/asio/reference/default_completion_token_t.html new file mode 100644 index 0000000..062842f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/default_completion_token_t.html @@ -0,0 +1,96 @@ + + + +default_completion_token_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef typename default_completion_token< T >::type default_completion_token_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ If T has a nested type default_completion_token_type, T::default_completion_token_type. + Otherwise the typedef type is asio::deferred_t. +

+
+

+ A program may specialise this traits type if the T + template parameter in the specialisation is a user-defined type. +

+

+ Specialisations of this trait may provide a nested typedef type, which is a default-constructible + completion token type. +

+

+ If not otherwise specialised, the default completion token type is deferred_t. +

+
+ + Requirements +
+

+ Header: asio/default_completion_token.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/defer.html b/Packages/asio-1.36.0/doc/asio/reference/defer.html new file mode 100644 index 0000000..994a923 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/defer.html @@ -0,0 +1,75 @@ + + + +defer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+defer +

+

+ +

+

+ Submits a completion token or function object for execution. +

+
template<
+    typename NullaryToken>
+auto defer(
+    NullaryToken && token);
+  » more...
+
+template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+auto defer(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t<(execution::is_executor< Executor >::value &&can_require< Executor, execution::blocking_t::never_t >::value)||is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+auto defer(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/defer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/defer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/defer/overload1.html new file mode 100644 index 0000000..3babedb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/defer/overload1.html @@ -0,0 +1,140 @@ + + + +defer (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename NullaryToken>
+auto defer(
+    NullaryToken && token);
+
+

+ This function submits an object for execution using the object's associated + executor. The function object is queued for execution, and is never called + from the current thread prior to returning from defer(). +

+

+ The use of defer(), + rather than post, + indicates the caller's preference that the executor defer the queueing + of the function object. This may allow the executor to optimise queueing + for cases when the function object represents a continuation of the current + call context. +

+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ This function returns async_initiate<NullaryToken, void()>(Init{}, token), + where Init is a function + object type defined as: +

+
class Init
+{
+public:
+  template <typename CompletionHandler>
+    void operator()(CompletionHandler&& completion_handler) const;
+};
+
+

+ The function call operator of Init: +

+
    +
  • +

    + Obtains the handler's associated executor object ex + of type Ex by performing +

    +

    + auto ex = get_associated_executor(handler); +

    +
    • +
  • +

    + Obtains the handler's associated allocator object alloc + by performing +

    +

    + auto alloc = get_associated_allocator(handler); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is true, performs +

    +

    + prefer( require(ex, execution::blocking.never), execution::relationship.continuation, + execution::allocator(alloc) ).execute(std::forward<CompletionHandler>(completion_handler)); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is false, performs +

    +

    + ex.defer( std::forward<CompletionHandler>(completion_handler), + alloc); +

    +
    • +
+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/defer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/defer/overload2.html new file mode 100644 index 0000000..4270727 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/defer/overload2.html @@ -0,0 +1,179 @@ + + + +defer (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+auto defer(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t<(execution::is_executor< Executor >::value &&can_require< Executor, execution::blocking_t::never_t >::value)||is_executor< Executor >::value >  = 0);
+
+

+ This function submits an object for execution using the specified executor. + The function object is queued for execution, and is never called from the + current thread prior to returning from defer(). +

+

+ The use of defer(), + rather than post, + indicates the caller's preference that the executor defer the queueing + of the function object. This may allow the executor to optimise queueing + for cases when the function object represents a continuation of the current + call context. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The target executor. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ This function returns async_initiate<NullaryToken, void()>(Init{ex}, token), + where Init is a function + object type defined as: +

+
class Init
+{
+public:
+  using executor_type = Executor;
+  explicit Init(const Executor& ex) : ex_(ex) {}
+  executor_type get_executor() const noexcept { return ex_; }
+  template <typename CompletionHandler>
+    void operator()(CompletionHandler&& completion_handler) const;
+private:
+  Executor ex_; // exposition only
+};
+
+

+ The function call operator of Init: +

+
    +
  • +

    + Obtains the handler's associated executor object ex1 + of type Ex1 by performing +

    +

    + auto ex1 = get_associated_executor(handler, ex); +

    +
    • +
  • +

    + Obtains the handler's associated allocator object alloc + by performing +

    +

    + auto alloc = get_associated_allocator(handler); +

    +
    • +
  • +

    + If execution::is_executor<Ex1>::value is true, constructs a function + object f with a member + executor_ that is initialised + with prefer(ex1, execution::outstanding_work.tracked), + a member handler_ that + is a decay-copy of completion_handler, + and a function call operator that performs: +

    +

    + auto a = get_associated_allocator(handler_); prefer(executor_, execution::allocator(a)).execute(std::move(handler_)); +

    +
    • +
  • +

    + If execution::is_executor<Ex1>::value is false, constructs a function + object f with a member + work_ that is initialised + with make_work_guard(ex1), a member handler_ + that is a decay-copy of completion_handler, + and a function call operator that performs: +

    +

    + auto a = get_associated_allocator(handler_); work_.get_executor().dispatch(std::move(handler_), + a); work_.reset(); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is true, performs +

    +

    + prefer( require(ex, execution::blocking.never), execution::relationship.continuation, + execution::allocator(alloc) ).execute(std::move(f)); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is false, performs +

    +

    + ex.defer(std::move(f), alloc); +

    +
    • +
+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/defer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/defer/overload3.html new file mode 100644 index 0000000..275c498 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/defer/overload3.html @@ -0,0 +1,85 @@ + + + +defer (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+auto defer(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context, from which the target executor is obtained. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ defer(ctx.get_executor(), + forward<NullaryToken>(token)). +

+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred.html b/Packages/asio-1.36.0/doc/asio/reference/deferred.html new file mode 100644 index 0000000..2f40605 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred.html @@ -0,0 +1,58 @@ + + + +deferred + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + object used to specify that an asynchronous operation should return a function + object to lazily launch the operation. +

+
constexpr deferred_t deferred;
+
+

+ See the documentation for deferred_t for a usage example. +

+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation.html new file mode 100644 index 0000000..86a3c09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation.html @@ -0,0 +1,108 @@ + + + +deferred_async_operation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates a deferred asynchronous operation. +

+
template<
+    typename Signature,
+    typename Initiation,
+    typename... InitArgs>
+class deferred_async_operation
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ deferred_async_operation [constructor] +

+ 		+

+ Construct a deferred asynchronous operation from the arguments + to an initiation function object. +

+
+

+ operator() +

+ 		+

+ Initiate the asynchronous operation using the supplied completion + token.
—
+

+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/deferred_async_operation.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/deferred_async_operation.html new file mode 100644 index 0000000..6610f38 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/deferred_async_operation.html @@ -0,0 +1,49 @@ + + + +deferred_async_operation::deferred_async_operation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a deferred asynchronous operation from the arguments to an initiation function + object. +

+
template<
+    typename I,
+    typename... A>
+constexpr deferred_async_operation(
+    deferred_init_tag ,
+    I && initiation,
+    A &&... init_args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_.html new file mode 100644 index 0000000..d6097aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_.html @@ -0,0 +1,54 @@ + + + +deferred_async_operation::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Initiate + the asynchronous operation using the supplied completion token. +

+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+  » more...
+
+
+
+template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..15840b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +deferred_async_operation::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Initiate the asynchronous operation using the supplied completion token. +

+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..634f95e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation/operator_lp__rp_/overload2.html @@ -0,0 +1,41 @@ + + + +deferred_async_operation::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_.html new file mode 100644 index 0000000..22f5913 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_.html @@ -0,0 +1,110 @@ + + + +deferred_async_operation< deferred_signatures< Signatures... >, Initiation, InitArgs... > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates a deferred asynchronous operation thas has multiple completion + signatures. +

+
template<
+    typename... Signatures,
+    typename Initiation,
+    typename... InitArgs>
+class deferred_async_operation< deferred_signatures< Signatures... >, Initiation, InitArgs... >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ deferred_async_operation +

+ 		+

+ Construct a deferred asynchronous operation from the arguments + to an initiation function object. +

+
+

+ operator() +

+ 		+

+ Initiate the asynchronous operation using the supplied completion + token.
—
+

+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/deferred_async_operation.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/deferred_async_operation.html new file mode 100644 index 0000000..76ff032 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/deferred_async_operation.html @@ -0,0 +1,50 @@ + + + +deferred_async_operation< deferred_signatures< Signatures... >, Initiation, InitArgs... >::deferred_async_operation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a deferred asynchronous operation from the arguments to an initiation function + object. +

+
template<
+    typename I,
+    typename... A>
+constexpr deferred_async_operation(
+    deferred_init_tag ,
+    I && initiation,
+    A &&... init_args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_.html new file mode 100644 index 0000000..709be18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_.html @@ -0,0 +1,55 @@ + + + +deferred_async_operation< deferred_signatures< Signatures... >, Initiation, InitArgs... >::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Initiate + the asynchronous operation using the supplied completion token. +

+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+  » more...
+
+
+
+template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..6d6a663 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_/overload1.html @@ -0,0 +1,45 @@ + + + +deferred_async_operation< deferred_signatures< Signatures... >, Initiation, InitArgs... >::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Initiate the asynchronous operation using the supplied completion token. +

+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..8357dd1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_async_operation_lt__deferred_signatures_lt__Signatures_ellipsis___gt__comma__Initiation_comma__InitArgs_ellipsis___gt_/operator_lp__rp_/overload2.html @@ -0,0 +1,42 @@ + + + +deferred_async_operation< deferred_signatures< Signatures... >, Initiation, InitArgs... >::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional.html new file mode 100644 index 0000000..687c2b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional.html @@ -0,0 +1,130 @@ + + + +deferred_conditional + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Used to represent a deferred conditional branch. +

+
template<
+    typename OnTrue = deferred_noop,
+    typename OnFalse = deferred_noop>
+class deferred_conditional
+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ deferred_conditional [constructor] +

+ 		+

+ Construct a deferred conditional with the value to determine which + branch will be executed. +

+
+

+ operator() +

+ 		+

+ Invoke the conditional branch bsaed on the stored value.
+ —
+

+
+

+ otherwise +

+ 		+

+ Set the false branch of the conditional. +

+
+

+ then +

+ 		+

+ Set the true branch of the conditional. +

+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/deferred_conditional.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/deferred_conditional.html new file mode 100644 index 0000000..7e70ea1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/deferred_conditional.html @@ -0,0 +1,44 @@ + + + +deferred_conditional::deferred_conditional + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a deferred conditional with the value to determine which branch will be + executed. +

+
constexpr deferred_conditional(
+    bool b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_.html new file mode 100644 index 0000000..1096c51 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_.html @@ -0,0 +1,54 @@ + + + +deferred_conditional::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Invoke + the conditional branch bsaed on the stored value. +

+
template<
+    typename... Args>
+auto operator()(
+    Args &&... args);
+  » more...
+
+
+
+template<
+    typename... Args>
+auto operator()(
+    Args &&... args) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..b40f8f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +deferred_conditional::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Invoke the conditional branch bsaed on the stored value. +

+
template<
+    typename... Args>
+auto operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..946f264 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/operator_lp__rp_/overload2.html @@ -0,0 +1,41 @@ + + + +deferred_conditional::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename... Args>
+auto operator()(
+    Args &&... args) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/otherwise.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/otherwise.html new file mode 100644 index 0000000..3398fc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/otherwise.html @@ -0,0 +1,48 @@ + + + +deferred_conditional::otherwise + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the false branch of the conditional. +

+
template<
+    typename T>
+deferred_conditional< OnTrue, T > otherwise(
+    T on_false,
+    constraint_t< is_deferred< T >::value > *  = 0,
+    constraint_t< !is_same< conditional_t< true, OnTrue, T >, deferred_noop >::value > *  = 0,
+    constraint_t< is_same< conditional_t< true, OnFalse, T >, deferred_noop >::value > *  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/then.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/then.html new file mode 100644 index 0000000..591c587 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_conditional/then.html @@ -0,0 +1,47 @@ + + + +deferred_conditional::then + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set the + true branch of the conditional. +

+
template<
+    typename T>
+deferred_conditional< T, OnFalse > then(
+    T on_true,
+    constraint_t< is_deferred< T >::value > *  = 0,
+    constraint_t< is_same< conditional_t< true, OnTrue, T >, deferred_noop >::value > *  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_function.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_function.html new file mode 100644 index 0000000..2c759f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_function.html @@ -0,0 +1,134 @@ + + + +deferred_function + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wraps a function object so that it may be used as an element in a deferred + composition. +

+
template<
+    typename Function>
+class deferred_function
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ deferred_function [constructor] +

+ 		+

+ Constructor. +

+
+

+ operator() +

+ 		+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ function_ +

+ 		+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_function/deferred_function.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/deferred_function.html new file mode 100644 index 0000000..3340182 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/deferred_function.html @@ -0,0 +1,45 @@ + + + +deferred_function::deferred_function + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename F>
+constexpr deferred_function(
+    deferred_init_tag ,
+    F && function);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_function/function_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/function_.html new file mode 100644 index 0000000..1edf5e7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/function_.html @@ -0,0 +1,40 @@ + + + +deferred_function::function_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Function function_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_.html new file mode 100644 index 0000000..e7b9e11 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_.html @@ -0,0 +1,50 @@ + + + +deferred_function::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename... Args>
+auto operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+auto operator()(
+    Args &&... args) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..f76b32e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_/overload1.html @@ -0,0 +1,41 @@ + + + +deferred_function::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename... Args>
+auto operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..c1a1856 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_function/operator_lp__rp_/overload2.html @@ -0,0 +1,41 @@ + + + +deferred_function::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename... Args>
+auto operator()(
+    Args &&... args) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_init_tag.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_init_tag.html new file mode 100644 index 0000000..ced9674 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_init_tag.html @@ -0,0 +1,53 @@ + + + +deferred_init_tag + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Tag type to disambiguate deferred constructors. +

+
struct deferred_init_tag
+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_noop.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop.html new file mode 100644 index 0000000..4f0e647 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop.html @@ -0,0 +1,88 @@ + + + +deferred_noop + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Used to represent an empty deferred action. +

+
struct deferred_noop
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ No effect. +

+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_.html new file mode 100644 index 0000000..b800d61 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_.html @@ -0,0 +1,52 @@ + + + +deferred_noop::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +No + effect. +

+
template<
+    typename... Args>
+void operator()(
+    Args && ...);
+  » more...
+
+template<
+    typename... Args>
+void operator()(
+    Args && ...) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..ec6e268 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +deferred_noop::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ No effect. +

+
template<
+    typename... Args>
+void operator()(
+    Args && ...);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..9b8a135 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_noop/operator_lp__rp_/overload2.html @@ -0,0 +1,44 @@ + + + +deferred_noop::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ No effect. +

+
template<
+    typename... Args>
+void operator()(
+    Args && ...) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence.html new file mode 100644 index 0000000..0877f78 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence.html @@ -0,0 +1,100 @@ + + + +deferred_sequence + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Defines a link between two consecutive operations in a sequence. +

+
template<
+    typename Head,
+    typename Tail>
+class deferred_sequence :
+  public detail::deferred_sequence_types::base
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ deferred_sequence [constructor] +

+ 		+
+

+ operator() +

+ 		+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/deferred_sequence.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/deferred_sequence.html new file mode 100644 index 0000000..baa8f4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/deferred_sequence.html @@ -0,0 +1,46 @@ + + + +deferred_sequence::deferred_sequence + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename H,
+    typename T>
+constexpr deferred_sequence(
+    deferred_init_tag ,
+    H && head,
+    T && tail);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_.html new file mode 100644 index 0000000..565b446 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_.html @@ -0,0 +1,50 @@ + + + +deferred_sequence::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+  » more...
+
+template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..b0c548a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_/overload1.html @@ -0,0 +1,41 @@ + + + +deferred_sequence::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..dd9a33e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_sequence/operator_lp__rp_/overload2.html @@ -0,0 +1,41 @@ + + + +deferred_sequence::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_signatures.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_signatures.html new file mode 100644 index 0000000..ae6205b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_signatures.html @@ -0,0 +1,55 @@ + + + +deferred_signatures + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper type to wrap multiple completion signatures. +

+
template<
+    typename... Signatures>
+struct deferred_signatures
+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t.html new file mode 100644 index 0000000..aac1873 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t.html @@ -0,0 +1,213 @@ + + + +deferred_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Class used to specify that an asynchronous operation should return a function + object to lazily launch the operation. +

+
class deferred_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use deferred_t as its default + completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the deferred_t completion token as the + default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use deferred_t as its + default completion token type. +

+
+

+ deferred_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ operator() +

+ 		+

+ Creates a new deferred from a function.
—
Passes through + anything that is already deferred. +

+
+

+ values + [static] +

+ 		+

+ Returns a deferred operation that returns the provided values. +

+
+

+ when + [static] +

+ 		+

+ Creates a conditional object for branching deferred operations. +

+
+

+ The deferred_t + class is used to indicate that an asynchronous operation should return a + function object which is itself an initiation function. A deferred_t object may be passed + as a completion token to an asynchronous operation, typically as the default + completion token: +

+
auto my_deferred_op = my_socket.async_read_some(my_buffer);
+
+

+ or by explicitly passing the special value asio::deferred: +

+
auto my_deferred_op
+ = my_socket.async_read_some(my_buffer,
+     asio::deferred);
+
+

+ The initiating function (async_read_some in the above example) returns a + function object that will lazily initiate the operation. +

+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/as_default_on.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/as_default_on.html new file mode 100644 index 0000000..88204c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/as_default_on.html @@ -0,0 +1,46 @@ + + + +deferred_t::as_default_on + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + helper to adapt an I/O object to use deferred_t + as its default completion token type. +

+
template<
+    typename T>
+static decay_t< T >::template rebind_executor< executor_with_default< typenamedecay_t< T >::executor_type > >::other as_default_on(
+    T && object);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/as_default_on_t.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/as_default_on_t.html new file mode 100644 index 0000000..45be391 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/as_default_on_t.html @@ -0,0 +1,122 @@ + + + +deferred_t::as_default_on_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + alias to adapt an I/O object to use deferred_t + as its default completion token type. +

+
typedef typename T::template rebind_executor< executor_with_default< typename T::executor_type > >::other as_default_on_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify deferred_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/deferred_t.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/deferred_t.html new file mode 100644 index 0000000..94bf2d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/deferred_t.html @@ -0,0 +1,41 @@ + + + +deferred_t::deferred_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
constexpr deferred_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_.html new file mode 100644 index 0000000..d7827fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_.html @@ -0,0 +1,55 @@ + + + +deferred_t::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Creates a + new deferred from a function. +

+
template<
+    typename Function>
+constraint_t< !is_deferred< decay_t< Function > >::value, deferred_function< decay_t< Function > > > operator()(
+    Function && function) const;
+  » more...
+
+

+ Passes through anything that is already deferred. +

+
template<
+    typename T>
+constraint_t< is_deferred< decay_t< T > >::value, decay_t< T > > operator()(
+    T && t) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..ed380f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +deferred_t::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Creates a new deferred from a function. +

+
template<
+    typename Function>
+constraint_t< !is_deferred< decay_t< Function > >::value, deferred_function< decay_t< Function > > > operator()(
+    Function && function) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..526d679 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/operator_lp__rp_/overload2.html @@ -0,0 +1,44 @@ + + + +deferred_t::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Passes through anything that is already deferred. +

+
template<
+    typename T>
+constraint_t< is_deferred< decay_t< T > >::value, decay_t< T > > operator()(
+    T && t) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/values.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/values.html new file mode 100644 index 0000000..5db35b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/values.html @@ -0,0 +1,45 @@ + + + +deferred_t::values + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Returns a deferred operation + that returns the provided values. +

+
template<
+    typename... Args>
+static constexpr deferred_values< decay_t< Args >... > values(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t/when.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/when.html new file mode 100644 index 0000000..c2434bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t/when.html @@ -0,0 +1,43 @@ + + + +deferred_t::when + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Creates a conditional object + for branching deferred operations. +

+
static constexpr deferred_conditional when(
+    bool b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default.html new file mode 100644 index 0000000..e36cb44 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default.html @@ -0,0 +1,126 @@ + + + +deferred_t::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts an executor to add the deferred_t + completion token as the default. +

+
template<
+    typename InnerExecutor>
+struct executor_with_default :
+  public InnerExecutor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify deferred_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default/default_completion_token_type.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default/default_completion_token_type.html new file mode 100644 index 0000000..4d9eeaa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default/default_completion_token_type.html @@ -0,0 +1,212 @@ + + + +deferred_t::executor_with_default::default_completion_token_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + deferred_t as the default + completion token type. +

+
typedef deferred_t default_completion_token_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use deferred_t as its default + completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the deferred_t completion token as + the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use deferred_t as its + default completion token type. +

+
+

+ deferred_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ operator() +

+ 		+

+ Creates a new deferred from a function.
—
Passes + through anything that is already deferred. +

+
+

+ values + [static] +

+ 		+

+ Returns a deferred operation that returns the provided values. +

+
+

+ when + [static] +

+ 		+

+ Creates a conditional object for branching deferred operations. +

+
+

+ The deferred_t + class is used to indicate that an asynchronous operation should return + a function object which is itself an initiation function. A deferred_t object may be passed + as a completion token to an asynchronous operation, typically as the default + completion token: +

+
auto my_deferred_op = my_socket.async_read_some(my_buffer);
+
+

+ or by explicitly passing the special value asio::deferred: +

+
auto my_deferred_op
+ = my_socket.async_read_some(my_buffer,
+     asio::deferred);
+
+

+ The initiating function (async_read_some in the above example) returns + a function object that will lazily initiate the operation. +

+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default/executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default/executor_with_default.html new file mode 100644 index 0000000..198027f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_t__executor_with_default/executor_with_default.html @@ -0,0 +1,46 @@ + + + +deferred_t::executor_with_default::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + the adapted executor from the inner executor type. +

+
template<
+    typename InnerExecutor1>
+executor_with_default(
+    const InnerExecutor1 & ex,
+    constraint_t< conditional_t< !is_same< InnerExecutor1, executor_with_default >::value, is_convertible< InnerExecutor1, InnerExecutor >, false_type >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_values.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_values.html new file mode 100644 index 0000000..e007e53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_values.html @@ -0,0 +1,106 @@ + + + +deferred_values + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates deferred values. +

+
template<
+    typename... Values>
+class deferred_values
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ deferred_values [constructor] +

+ 		+

+ Construct a deferred asynchronous operation from the arguments + to an initiation function object. +

+
+

+ operator() +

+ 		+

+ Initiate the deferred operation using the supplied completion token. +
—
+

+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_values/deferred_values.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/deferred_values.html new file mode 100644 index 0000000..8719df2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/deferred_values.html @@ -0,0 +1,47 @@ + + + +deferred_values::deferred_values + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a deferred asynchronous operation from the arguments to an initiation function + object. +

+
template<
+    typename... V>
+constexpr deferred_values(
+    deferred_init_tag ,
+    V &&... values);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_.html new file mode 100644 index 0000000..1ca75a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_.html @@ -0,0 +1,54 @@ + + + +deferred_values::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Initiate + the deferred operation using the supplied completion token. +

+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+  » more...
+
+
+
+template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..132a12d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +deferred_values::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Initiate the deferred operation using the supplied completion token. +

+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..f14eb09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_values/operator_lp__rp_/overload2.html @@ -0,0 +1,41 @@ + + + +deferred_values::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename CompletionToken>
+auto operator()(
+    CompletionToken && token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_values__initiate.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_values__initiate.html new file mode 100644 index 0000000..56e11ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_values__initiate.html @@ -0,0 +1,82 @@ + + + +deferred_values::initiate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
struct initiate
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/deferred_values__initiate/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/deferred_values__initiate/operator_lp__rp_.html new file mode 100644 index 0000000..aa074b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/deferred_values__initiate/operator_lp__rp_.html @@ -0,0 +1,45 @@ + + + +deferred_values::initiate::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename Handler,
+    typename... V>
+void operator()(
+    Handler handler,
+    V &&... values);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached.html b/Packages/asio-1.36.0/doc/asio/reference/detached.html new file mode 100644 index 0000000..19edbc9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached.html @@ -0,0 +1,57 @@ + + + +detached + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + object used to specify that an asynchronous operation is detached. +

+
constexpr detached_t detached;
+
+

+ See the documentation for detached_t for a usage example. +

+
+ + Requirements +
+

+ Header: asio/detached.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t.html new file mode 100644 index 0000000..601b1e7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t.html @@ -0,0 +1,165 @@ + + + +detached_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + type used to specify that an asynchronous operation is detached. +

+
class detached_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use detached_t as its default + completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the detached_t completion token as the + default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use detached_t as its + default completion token type. +

+
+

+ detached_t [constructor] +

+ 		+

+ Constructor. +

+
+

+ The detached_t + class is used to indicate that an asynchronous operation is detached. That + is, there is no completion handler waiting for the operation's result. A + detached_t + object may be passed as a handler to an asynchronous operation, typically + using the special value asio::detached. + For example: +

+
my_socket.async_send(my_buffer, asio::detached);
+
+
+ + Requirements +
+

+ Header: asio/detached.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t/as_default_on.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t/as_default_on.html new file mode 100644 index 0000000..2818907 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t/as_default_on.html @@ -0,0 +1,46 @@ + + + +detached_t::as_default_on + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + helper to adapt an I/O object to use detached_t + as its default completion token type. +

+
template<
+    typename T>
+static decay_t< T >::template rebind_executor< executor_with_default< typenamedecay_t< T >::executor_type > >::other as_default_on(
+    T && object);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t/as_default_on_t.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t/as_default_on_t.html new file mode 100644 index 0000000..fba9802 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t/as_default_on_t.html @@ -0,0 +1,124 @@ + + + +detached_t::as_default_on_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + alias to adapt an I/O object to use detached_t + as its default completion token type. +

+
typedef typename T::template rebind_executor< executor_with_default< typename T::executor_type > >::other as_default_on_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify detached_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +
—
Convert the specified executor to the inner executor + type, then use that to construct the adapted executor. +

+
+
+ + Requirements +
+

+ Header: asio/detached.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t/detached_t.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t/detached_t.html new file mode 100644 index 0000000..c44e58a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t/detached_t.html @@ -0,0 +1,41 @@ + + + +detached_t::detached_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
constexpr detached_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default.html new file mode 100644 index 0000000..b28b30b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default.html @@ -0,0 +1,128 @@ + + + +detached_t::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts an executor to add the detached_t + completion token as the default. +

+
template<
+    typename InnerExecutor>
+struct executor_with_default :
+  public InnerExecutor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify detached_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type.
+ —
Convert the specified executor to the inner executor type, + then use that to construct the adapted executor. +

+
+
+ + Requirements +
+

+ Header: asio/detached.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/default_completion_token_type.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/default_completion_token_type.html new file mode 100644 index 0000000..d4358ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/default_completion_token_type.html @@ -0,0 +1,164 @@ + + + +detached_t::executor_with_default::default_completion_token_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + detached_t as the default + completion token type. +

+
typedef detached_t default_completion_token_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use detached_t as its default + completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the detached_t completion token as + the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use detached_t as its + default completion token type. +

+
+

+ detached_t [constructor] +

+ 		+

+ Constructor. +

+
+

+ The detached_t + class is used to indicate that an asynchronous operation is detached. That + is, there is no completion handler waiting for the operation's result. + A detached_t + object may be passed as a handler to an asynchronous operation, typically + using the special value asio::detached. + For example: +

+
my_socket.async_send(my_buffer, asio::detached);
+
+
+ + Requirements +
+

+ Header: asio/detached.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default.html new file mode 100644 index 0000000..f84b4d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default.html @@ -0,0 +1,55 @@ + + + +detached_t::executor_with_default::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + the adapted executor from the inner executor type. +

+
executor_with_default(
+    const InnerExecutor & ex);
+  » more...
+
+

+ Convert the specified executor to the inner executor type, then use that + to construct the adapted executor. +

+
template<
+    typename OtherExecutor>
+executor_with_default(
+    const OtherExecutor & ex,
+    constraint_t< is_convertible< OtherExecutor, InnerExecutor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default/overload1.html new file mode 100644 index 0000000..bd0c7e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default/overload1.html @@ -0,0 +1,42 @@ + + + +detached_t::executor_with_default::executor_with_default (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct the adapted executor from the inner executor type. +

+
executor_with_default(
+    const InnerExecutor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default/overload2.html new file mode 100644 index 0000000..6c93507 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/detached_t__executor_with_default/executor_with_default/overload2.html @@ -0,0 +1,46 @@ + + + +detached_t::executor_with_default::executor_with_default (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Convert the specified executor to the inner executor type, then use that + to construct the adapted executor. +

+
template<
+    typename OtherExecutor>
+executor_with_default(
+    const OtherExecutor & ex,
+    constraint_t< is_convertible< OtherExecutor, InnerExecutor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disable_cancellation.html b/Packages/asio-1.36.0/doc/asio/reference/disable_cancellation.html new file mode 100644 index 0000000..04646e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disable_cancellation.html @@ -0,0 +1,87 @@ + + + +disable_cancellation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A cancellation filter that disables cancellation. +

+
typedef cancellation_filter< cancellation_type::none > disable_cancellation;
+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Returns type & Mask. +

+
+
+ + Requirements +
+

+ Header: asio/cancellation_state.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/dispatch.html new file mode 100644 index 0000000..1f3b4dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dispatch.html @@ -0,0 +1,75 @@ + + + +dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Submits a completion token or function object for execution. +

+
template<
+    typename NullaryToken>
+auto dispatch(
+    NullaryToken && token);
+  » more...
+
+template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+auto dispatch(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t< execution::is_executor< Executor >::value||is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+auto dispatch(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/dispatch.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload1.html new file mode 100644 index 0000000..bce207e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload1.html @@ -0,0 +1,132 @@ + + + +dispatch (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename NullaryToken>
+auto dispatch(
+    NullaryToken && token);
+
+

+ This function submits an object for execution using the object's associated + executor. The function object may be called from the current thread prior + to returning from dispatch(). Otherwise, it is queued for execution. +

+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ This function returns async_initiate<NullaryToken, void()>(Init{}, token), + where Init is a function + object type defined as: +

+
class Init
+{
+public:
+  template <typename CompletionHandler>
+    void operator()(CompletionHandler&& completion_handler) const;
+};
+
+

+ The function call operator of Init: +

+
    +
  • +

    + Obtains the handler's associated executor object ex + of type Ex by performing +

    +

    + auto ex = get_associated_executor(handler); +

    +
    • +
  • +

    + Obtains the handler's associated allocator object alloc + by performing +

    +

    + auto alloc = get_associated_allocator(handler); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is true, performs +

    +

    + prefer(ex, execution::allocator(alloc)).execute( std::forward<CompletionHandler>(completion_handler)); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is false, performs +

    +

    + ex.dispatch( std::forward<CompletionHandler>(completion_handler), + alloc); +

    +
    • +
+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload2.html new file mode 100644 index 0000000..e408bc5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload2.html @@ -0,0 +1,172 @@ + + + +dispatch (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+auto dispatch(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t< execution::is_executor< Executor >::value||is_executor< Executor >::value >  = 0);
+
+

+ This function submits an object for execution using the specified executor. + The function object may be called from the current thread prior to returning + from dispatch(). + Otherwise, it is queued for execution. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The target executor. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ This function returns async_initiate<NullaryToken, void()>(Init{ex}, token), + where Init is a function + object type defined as: +

+
class Init
+{
+public:
+  using executor_type = Executor;
+  explicit Init(const Executor& ex) : ex_(ex) {}
+  executor_type get_executor() const noexcept { return ex_; }
+  template <typename CompletionHandler>
+    void operator()(CompletionHandler&& completion_handler) const;
+private:
+  Executor ex_; // exposition only
+};
+
+

+ The function call operator of Init: +

+
    +
  • +

    + Obtains the handler's associated executor object ex1 + of type Ex1 by performing +

    +

    + auto ex1 = get_associated_executor(handler, ex); +

    +
    • +
  • +

    + Obtains the handler's associated allocator object alloc + by performing +

    +

    + auto alloc = get_associated_allocator(handler); +

    +
    • +
  • +

    + If execution::is_executor<Ex1>::value is true, constructs a function + object f with a member + executor_ that is initialised + with prefer(ex1, execution::outstanding_work.tracked), + a member handler_ that + is a decay-copy of completion_handler, + and a function call operator that performs: +

    +

    + auto a = get_associated_allocator(handler_); prefer(executor_, execution::allocator(a)).execute(std::move(handler_)); +

    +
    • +
  • +

    + If execution::is_executor<Ex1>::value is false, constructs a function + object f with a member + work_ that is initialised + with make_work_guard(ex1), a member handler_ + that is a decay-copy of completion_handler, + and a function call operator that performs: +

    +

    + auto a = get_associated_allocator(handler_); work_.get_executor().dispatch(std::move(handler_), + a); work_.reset(); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is true, performs +

    +

    + prefer(ex, execution::allocator(alloc)).execute(std::move(f)); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is false, performs +

    +

    + ex.dispatch(std::move(f), alloc); +

    +
    • +
+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload3.html new file mode 100644 index 0000000..9ec88fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dispatch/overload3.html @@ -0,0 +1,86 @@ + + + +dispatch (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+auto dispatch(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context, from which the target executor is obtained. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ dispatch(ctx.get_executor(), + forward<NullaryToken>(token)). +

+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits.html new file mode 100644 index 0000000..846b3e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits.html @@ -0,0 +1,123 @@ + + + +disposition_traits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Traits type to adapt arbitrary error types as dispositions. +

+
template<
+    typename T>
+struct disposition_traits
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ not_an_error [static] +

+ 		+

+ Determine whether a disposition represents no error. +

+
+

+ throw_exception [static] +

+ 		+

+ Throw an exception if the disposition represents an error. +

+
+

+ to_exception_ptr [static] +

+ 		+

+ Convert a disposition into an exception_ptr. +

+
+

+ This type may be specialised for user-defined types, to allow them to be + treated as a disposition by asio. +

+

+ The primary trait is not defined. +

+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/not_an_error.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/not_an_error.html new file mode 100644 index 0000000..71bfb33 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/not_an_error.html @@ -0,0 +1,43 @@ + + + +disposition_traits::not_an_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether a disposition represents no error. +

+
static bool not_an_error(
+    const T & d);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/throw_exception.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/throw_exception.html new file mode 100644 index 0000000..f586d0a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/throw_exception.html @@ -0,0 +1,43 @@ + + + +disposition_traits::throw_exception + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Throw + an exception if the disposition represents an error. +

+
static void throw_exception(
+    T d);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/to_exception_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/to_exception_ptr.html new file mode 100644 index 0000000..7b17f17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits/to_exception_ptr.html @@ -0,0 +1,43 @@ + + + +disposition_traits::to_exception_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Convert + a disposition into an exception_ptr. +

+
static std::exception_ptr to_exception_ptr(
+    T d);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_.html new file mode 100644 index 0000000..629f386 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_.html @@ -0,0 +1,108 @@ + + + +disposition_traits< asio::error_code > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Specialisation of disposition_traits + for error_code. +

+
template<>
+struct disposition_traits< asio::error_code >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ not_an_error [static] +

+ 		+
+

+ throw_exception [static] +

+ 		+
+

+ to_exception_ptr [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/not_an_error.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/not_an_error.html new file mode 100644 index 0000000..8b5a1fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/not_an_error.html @@ -0,0 +1,42 @@ + + + +disposition_traits< asio::error_code >::not_an_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static bool not_an_error(
+    const asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/throw_exception.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/throw_exception.html new file mode 100644 index 0000000..ad5e44c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/throw_exception.html @@ -0,0 +1,42 @@ + + + +disposition_traits< asio::error_code >::throw_exception + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static void throw_exception(
+    const asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/to_exception_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/to_exception_ptr.html new file mode 100644 index 0000000..0e8ef5b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__asio__error_code__gt_/to_exception_ptr.html @@ -0,0 +1,42 @@ + + + +disposition_traits< asio::error_code >::to_exception_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static std::exception_ptr to_exception_ptr(
+    const asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_.html new file mode 100644 index 0000000..5e5881a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_.html @@ -0,0 +1,108 @@ + + + +disposition_traits< no_error_t > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Specialisation of disposition_traits + for no_error_t. +

+
template<>
+struct disposition_traits< no_error_t >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ not_an_error [static] +

+ 		+
+

+ throw_exception [static] +

+ 		+
+

+ to_exception_ptr [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/not_an_error.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/not_an_error.html new file mode 100644 index 0000000..fa90c57 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/not_an_error.html @@ -0,0 +1,42 @@ + + + +disposition_traits< no_error_t >::not_an_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static bool not_an_error(
+    no_error_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/throw_exception.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/throw_exception.html new file mode 100644 index 0000000..7ee5fe9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/throw_exception.html @@ -0,0 +1,42 @@ + + + +disposition_traits< no_error_t >::throw_exception + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static void throw_exception(
+    no_error_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/to_exception_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/to_exception_ptr.html new file mode 100644 index 0000000..a83a8ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__no_error_t__gt_/to_exception_ptr.html @@ -0,0 +1,42 @@ + + + +disposition_traits< no_error_t >::to_exception_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static std::exception_ptr to_exception_ptr(
+    no_error_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_.html new file mode 100644 index 0000000..47f1b64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_.html @@ -0,0 +1,108 @@ + + + +disposition_traits< std::exception_ptr > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Specialisation of disposition_traits + for std::exception_ptr. +

+
template<>
+struct disposition_traits< std::exception_ptr >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ not_an_error [static] +

+ 		+
+

+ throw_exception [static] +

+ 		+
+

+ to_exception_ptr [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/not_an_error.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/not_an_error.html new file mode 100644 index 0000000..305aa20 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/not_an_error.html @@ -0,0 +1,42 @@ + + + +disposition_traits< std::exception_ptr >::not_an_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static bool not_an_error(
+    const std::exception_ptr & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/throw_exception.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/throw_exception.html new file mode 100644 index 0000000..a66b479 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/throw_exception.html @@ -0,0 +1,42 @@ + + + +disposition_traits< std::exception_ptr >::throw_exception + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static void throw_exception(
+    std::exception_ptr e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/to_exception_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/to_exception_ptr.html new file mode 100644 index 0000000..0d11b0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/disposition_traits_lt__std__exception_ptr__gt_/to_exception_ptr.html @@ -0,0 +1,42 @@ + + + +disposition_traits< std::exception_ptr >::to_exception_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static std::exception_ptr to_exception_ptr(
+    std::exception_ptr e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer.html new file mode 100644 index 0000000..aa16067 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer.html @@ -0,0 +1,91 @@ + + + +dynamic_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The dynamic_buffer + function is used to create a dynamically resized buffer from a std::basic_string + or std::vector. +

+

+ Create a new dynamic buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+dynamic_string_buffer< Elem, Traits, Allocator > dynamic_buffer(
+    std::basic_string< Elem, Traits, Allocator > & data);
+  » more...
+
+template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+dynamic_string_buffer< Elem, Traits, Allocator > dynamic_buffer(
+    std::basic_string< Elem, Traits, Allocator > & data,
+    std::size_t max_size);
+  » more...
+
+

+ Create a new dynamic buffer that represents the given vector. +

+
template<
+    typename Elem,
+    typename Allocator>
+dynamic_vector_buffer< Elem, Allocator > dynamic_buffer(
+    std::vector< Elem, Allocator > & data);
+  » more...
+
+template<
+    typename Elem,
+    typename Allocator>
+dynamic_vector_buffer< Elem, Allocator > dynamic_buffer(
+    std::vector< Elem, Allocator > & data,
+    std::size_t max_size);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload1.html new file mode 100644 index 0000000..98f4c08 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload1.html @@ -0,0 +1,53 @@ + + + +dynamic_buffer (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new dynamic buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+dynamic_string_buffer< Elem, Traits, Allocator > dynamic_buffer(
+    std::basic_string< Elem, Traits, Allocator > & data);
+
+
+ + Return Value +
+

+ dynamic_string_buffer<Elem, Traits, Allocator>(data). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload2.html new file mode 100644 index 0000000..dbc62a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload2.html @@ -0,0 +1,54 @@ + + + +dynamic_buffer (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new dynamic buffer that represents the given string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+dynamic_string_buffer< Elem, Traits, Allocator > dynamic_buffer(
+    std::basic_string< Elem, Traits, Allocator > & data,
+    std::size_t max_size);
+
+
+ + Return Value +
+

+ dynamic_string_buffer<Elem, Traits, Allocator>(data, max_size). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload3.html new file mode 100644 index 0000000..b788381 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload3.html @@ -0,0 +1,52 @@ + + + +dynamic_buffer (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new dynamic buffer that represents the given vector. +

+
template<
+    typename Elem,
+    typename Allocator>
+dynamic_vector_buffer< Elem, Allocator > dynamic_buffer(
+    std::vector< Elem, Allocator > & data);
+
+
+ + Return Value +
+

+ dynamic_vector_buffer<Elem, Allocator>(data). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload4.html new file mode 100644 index 0000000..8517b4c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_buffer/overload4.html @@ -0,0 +1,53 @@ + + + +dynamic_buffer (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new dynamic buffer that represents the given vector. +

+
template<
+    typename Elem,
+    typename Allocator>
+dynamic_vector_buffer< Elem, Allocator > dynamic_buffer(
+    std::vector< Elem, Allocator > & data,
+    std::size_t max_size);
+
+
+ + Return Value +
+

+ dynamic_vector_buffer<Elem, Allocator>(data, max_size). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer.html new file mode 100644 index 0000000..3ef3ff5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer.html @@ -0,0 +1,266 @@ + + + +dynamic_string_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapt a basic_string to the DynamicBuffer requirements. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Allocator>
+class dynamic_string_buffer
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffers_type +

+ 		+

+ The type used to represent a sequence of constant buffers that + refers to the underlying memory. +

+
+

+ mutable_buffers_type +

+ 		+

+ The type used to represent a sequence of mutable buffers that refers + to the underlying memory. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ capacity +

+ 		+

+ Get the maximum size that the buffer may grow to without triggering + reallocation. +

+
+

+ commit +

+ 		+

+ DynamicBuffer_v1: Move bytes from the output sequence to the input + sequence. +

+
+

+ consume +

+ 		+

+ DynamicBuffer_v1: Remove characters from the input sequence. DynamicBuffer_v2: + Consume the specified number of bytes from the beginning of the + underlying memory. +

+
+

+ data +

+ 		+

+ DynamicBuffer_v1: Get a list of buffers that represents the input + sequence.
—
DynamicBuffer_v2: Get a sequence of buffers + that represents the underlying memory. +

+
+

+ dynamic_string_buffer [constructor] +

+ 		+

+ Construct a dynamic buffer from a string.
—
DynamicBuffer_v2: + Copy construct a dynamic buffer.
—
Move construct a + dynamic buffer. +

+
+

+ grow +

+ 		+

+ DynamicBuffer_v2: Grow the underlying memory by the specified number + of bytes. +

+
+

+ max_size +

+ 		+

+ Get the maximum size of the dynamic buffer. +

+
+

+ prepare +

+ 		+

+ DynamicBuffer_v1: Get a list of buffers that represents the output + sequence, with the given size. +

+
+

+ shrink +

+ 		+

+ DynamicBuffer_v2: Shrink the underlying memory by the specified + number of bytes. +

+
+

+ size +

+ 		+

+ DynamicBuffer_v1: Get the size of the input sequence. DynamicBuffer_v2: + Get the current size of the underlying memory. +

+
+

+ Requires that sizeof(Elem) == 1. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/capacity.html new file mode 100644 index 0000000..2758ec9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/capacity.html @@ -0,0 +1,51 @@ + + + +dynamic_string_buffer::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the maximum size that the buffer may grow to without triggering reallocation. +

+
std::size_t capacity() const;
+
+
+ + Return + Value +
+

+ The current capacity of the underlying string if less than max_size(). + Otherwise returns max_size(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/commit.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/commit.html new file mode 100644 index 0000000..9a59da3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/commit.html @@ -0,0 +1,73 @@ + + + +dynamic_string_buffer::commit + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Move bytes from the output sequence + to the input sequence. +

+
void commit(
+    std::size_t n);
+
+
+ + Parameters +
+
+

+
+
n
+

+ The number of bytes to append from the start of the output sequence + to the end of the input sequence. The remainder of the output sequence + is discarded. +

+
+
+

+ Requires a preceding call prepare(x) + where x >= + n, and no intervening operations + that modify the input or output sequence. +

+
+ + Remarks +
+

+ If n is greater than the + size of the output sequence, the entire output sequence is moved to the + input sequence and no error is issued. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/const_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/const_buffers_type.html new file mode 100644 index 0000000..af3781d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/const_buffers_type.html @@ -0,0 +1,187 @@ + + + +dynamic_string_buffer::const_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent a sequence of constant buffers that refers to the + underlying memory. +

+
typedef const_buffer const_buffers_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffer [constructor] +

+ 		+

+ Construct an empty buffer.
—
Construct a buffer to + represent a given memory range.
—
Construct a non-modifiable + buffer from a modifiable one.
—
Construct a buffer + from a span of bytes. +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new non-modifiable buffer that is offset from the start + of another. +

+
+

+ The 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::const_buffer b1 = ...;
+std::size_t s1 = b1.size();
+const unsigned char* p1 = static_cast<const unsigned char*>(b1.data());
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/consume.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/consume.html new file mode 100644 index 0000000..647c482 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/consume.html @@ -0,0 +1,62 @@ + + + +dynamic_string_buffer::consume + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Remove characters from the input + sequence. DynamicBuffer_v2: Consume the + specified number of bytes from the beginning of the underlying memory. +

+
void consume(
+    std::size_t n);
+
+

+ DynamicBuffer_v1: Removes n characters from the beginning of the + input sequence. +

+
+ + Remarks +
+

+ If n is greater than the + size of the input sequence, the entire input sequence is consumed and no + error is issued. +

+

+ DynamicBuffer_v2: Erases n bytes from the beginning of the string. + If n is greater than the + current size of the string, the string is emptied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data.html new file mode 100644 index 0000000..8e6a212 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data.html @@ -0,0 +1,57 @@ + + + +dynamic_string_buffer::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Get a list of buffers that represents + the input sequence. +

+
const_buffers_type data() const;
+  » more...
+
+

+ DynamicBuffer_v2: Get a sequence of buffers + that represents the underlying memory. +

+
mutable_buffers_type data(
+    std::size_t pos,
+    std::size_t n);
+  » more...
+
+const_buffers_type data(
+    std::size_t pos,
+    std::size_t n) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload1.html new file mode 100644 index 0000000..e5af9bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload1.html @@ -0,0 +1,61 @@ + + + +dynamic_string_buffer::data (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v1: Get a list of buffers + that represents the input sequence. +

+
const_buffers_type data() const;
+
+
+ + Return + Value +
+

+ An object of type const_buffers_type + that satisfies ConstBufferSequence requirements, representing the basic_string + memory in the input sequence. +

+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_string_buffer + or basic_string member + function that resizes or erases the string. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload2.html new file mode 100644 index 0000000..c930fe9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload2.html @@ -0,0 +1,82 @@ + + + +dynamic_string_buffer::data (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v2: Get a sequence of + buffers that represents the underlying memory. +

+
mutable_buffers_type data(
+    std::size_t pos,
+    std::size_t n);
+
+
+ + Parameters +
+
+

+
+
pos
+

+ Position of the first byte to represent in the buffer sequence +

+
n
+

+ The number of bytes to return in the buffer sequence. If the underlying + memory is shorter, the buffer sequence represents as many bytes + as are available. +

+
+
+
+ + Return + Value +
+

+ An object of type mutable_buffers_type + that satisfies MutableBufferSequence requirements, representing the basic_string + memory. +

+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_string_buffer + or basic_string member + function that resizes or erases the string. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload3.html new file mode 100644 index 0000000..202cc87 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/data/overload3.html @@ -0,0 +1,72 @@ + + + +dynamic_string_buffer::data (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v2: Get a sequence of + buffers that represents the underlying memory. +

+
const_buffers_type data(
+    std::size_t pos,
+    std::size_t n) const;
+
+
+ + Parameters +
+
+

+
+
pos
+

+ Position of the first byte to represent in the buffer sequence +

+
n
+

+ The number of bytes to return in the buffer sequence. If the underlying + memory is shorter, the buffer sequence represents as many bytes + as are available. +

+
+
+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_string_buffer + or basic_string member + function that resizes or erases the string. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer.html new file mode 100644 index 0000000..a659165 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer.html @@ -0,0 +1,60 @@ + + + +dynamic_string_buffer::dynamic_string_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a dynamic buffer from a string. +

+
explicit dynamic_string_buffer(
+    std::basic_string< Elem, Traits, Allocator > & s,
+    std::size_t maximum_size = (std::numeric_limits< std::size_t >::max)());
+  » more...
+
+

+ DynamicBuffer_v2: Copy construct a dynamic + buffer. +

+
dynamic_string_buffer(
+    const dynamic_string_buffer & other);
+  » more...
+
+

+ Move construct a dynamic buffer. +

+
dynamic_string_buffer(
+    dynamic_string_buffer && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload1.html new file mode 100644 index 0000000..404ec2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload1.html @@ -0,0 +1,76 @@ + + + +dynamic_string_buffer::dynamic_string_buffer (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a dynamic buffer from a string. +

+
dynamic_string_buffer(
+    std::basic_string< Elem, Traits, Allocator > & s,
+    std::size_t maximum_size = (std::numeric_limits< std::size_t >::max)());
+
+
+ + Parameters +
+
+

+
+
s
+

+ The string to be used as backing storage for the dynamic buffer. + The object stores a reference to the string and the user is responsible + for ensuring that the string object remains valid while the dynamic_string_buffer + object, and copies of the object, are in use. +

+
+
+

+ DynamicBuffer_v1: Any existing data + in the string is treated as the dynamic buffer's input sequence. +

+
+ + Parameters +
+
+

+
+
maximum_size
+

+ Specifies a maximum size for the buffer, in bytes. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload2.html new file mode 100644 index 0000000..e0d32c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload2.html @@ -0,0 +1,43 @@ + + + +dynamic_string_buffer::dynamic_string_buffer (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v2: Copy construct a dynamic + buffer. +

+
dynamic_string_buffer(
+    const dynamic_string_buffer & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload3.html new file mode 100644 index 0000000..4b6dcf5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/dynamic_string_buffer/overload3.html @@ -0,0 +1,42 @@ + + + +dynamic_string_buffer::dynamic_string_buffer (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct a dynamic buffer. +

+
dynamic_string_buffer(
+    dynamic_string_buffer && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/grow.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/grow.html new file mode 100644 index 0000000..5add625 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/grow.html @@ -0,0 +1,62 @@ + + + +dynamic_string_buffer::grow + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v2: Grow the underlying memory by + the specified number of bytes. +

+
void grow(
+    std::size_t n);
+
+

+ Resizes the string to accommodate an additional n + bytes at the end. +

+
+ + Exceptions +
+
+

+
+
std::length_error
+

+ If size() + + n + > max_size(). +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/max_size.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/max_size.html new file mode 100644 index 0000000..d7797a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/max_size.html @@ -0,0 +1,50 @@ + + + +dynamic_string_buffer::max_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the maximum size of the dynamic buffer. +

+
std::size_t max_size() const;
+
+
+ + Return + Value +
+

+ The allowed maximum size of the underlying memory. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/mutable_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/mutable_buffers_type.html new file mode 100644 index 0000000..f5470ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/mutable_buffers_type.html @@ -0,0 +1,186 @@ + + + +dynamic_string_buffer::mutable_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent a sequence of mutable buffers that refers to the + underlying memory. +

+
typedef mutable_buffer mutable_buffers_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ mutable_buffer [constructor] +

+ 		+

+ Construct an empty buffer.
—
Construct a buffer to + represent a given memory range.
—
Construct a buffer + from a span of bytes. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new modifiable buffer that is offset from the start + of another. +

+
+

+ The 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::mutable_buffer b1 = ...;
+std::size_t s1 = b1.size();
+unsigned char* p1 = static_cast<unsigned char*>(b1.data());
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/prepare.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/prepare.html new file mode 100644 index 0000000..b536fcb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/prepare.html @@ -0,0 +1,81 @@ + + + +dynamic_string_buffer::prepare + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Get a list of buffers that represents + the output sequence, with the given size. +

+
mutable_buffers_type prepare(
+    std::size_t n);
+
+

+ Ensures that the output sequence can accommodate n + bytes, resizing the basic_string object as necessary. +

+
+ + Return + Value +
+

+ An object of type mutable_buffers_type + that satisfies MutableBufferSequence requirements, representing basic_string + memory at the start of the output sequence of size n. +

+
+ + Exceptions +
+
+

+
+
std::length_error
+

+ If size() + + n + > max_size(). +

+
+
+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_string_buffer + or basic_string member + function that modifies the input sequence or output sequence. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/shrink.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/shrink.html new file mode 100644 index 0000000..f922f4c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/shrink.html @@ -0,0 +1,48 @@ + + + +dynamic_string_buffer::shrink + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v2: Shrink the underlying memory by + the specified number of bytes. +

+
void shrink(
+    std::size_t n);
+
+

+ Erases n bytes from the + end of the string by resizing the basic_string object. If n is greater than the current size of + the string, the string is emptied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/size.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/size.html new file mode 100644 index 0000000..464d0ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_string_buffer/size.html @@ -0,0 +1,53 @@ + + + +dynamic_string_buffer::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Get the size of the input sequence. + DynamicBuffer_v2: Get the current size + of the underlying memory. +

+
std::size_t size() const;
+
+
+ + Return + Value +
+

+ DynamicBuffer_v1 The current size of the + input sequence. DynamicBuffer_v2: The + current size of the underlying string if less than max_size(). Otherwise returns max_size(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer.html new file mode 100644 index 0000000..cbf0996 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer.html @@ -0,0 +1,265 @@ + + + +dynamic_vector_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapt a vector to the DynamicBuffer requirements. +

+
template<
+    typename Elem,
+    typename Allocator>
+class dynamic_vector_buffer
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffers_type +

+ 		+

+ The type used to represent a sequence of constant buffers that + refers to the underlying memory. +

+
+

+ mutable_buffers_type +

+ 		+

+ The type used to represent a sequence of mutable buffers that refers + to the underlying memory. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ capacity +

+ 		+

+ Get the maximum size that the buffer may grow to without triggering + reallocation. +

+
+

+ commit +

+ 		+

+ DynamicBuffer_v1: Move bytes from the output sequence to the input + sequence. +

+
+

+ consume +

+ 		+

+ DynamicBuffer_v1: Remove characters from the input sequence. DynamicBuffer_v2: + Consume the specified number of bytes from the beginning of the + underlying memory. +

+
+

+ data +

+ 		+

+ DynamicBuffer_v1: Get a list of buffers that represents the input + sequence.
—
DynamicBuffer_v2: Get a sequence of buffers + that represents the underlying memory. +

+
+

+ dynamic_vector_buffer [constructor] +

+ 		+

+ Construct a dynamic buffer from a vector.
—
DynamicBuffer_v2: + Copy construct a dynamic buffer.
—
Move construct a + dynamic buffer. +

+
+

+ grow +

+ 		+

+ DynamicBuffer_v2: Grow the underlying memory by the specified number + of bytes. +

+
+

+ max_size +

+ 		+

+ Get the maximum size of the dynamic buffer. +

+
+

+ prepare +

+ 		+

+ DynamicBuffer_v1: Get a list of buffers that represents the output + sequence, with the given size. +

+
+

+ shrink +

+ 		+

+ DynamicBuffer_v2: Shrink the underlying memory by the specified + number of bytes. +

+
+

+ size +

+ 		+

+ DynamicBuffer_v1: Get the size of the input sequence. DynamicBuffer_v2: + Get the current size of the underlying memory. +

+
+

+ Requires that sizeof(Elem) == 1. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/capacity.html new file mode 100644 index 0000000..b6eb647 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/capacity.html @@ -0,0 +1,52 @@ + + + +dynamic_vector_buffer::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the maximum size that the buffer may grow to without triggering reallocation. +

+
std::size_t capacity() const;
+
+
+ + Return + Value +
+

+ DynamicBuffer_v1: The current total capacity + of the buffer, i.e. for both the input sequence and output sequence. DynamicBuffer_v2: The current capacity of the underlying + vector if less than max_size(). Otherwise returns max_size(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/commit.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/commit.html new file mode 100644 index 0000000..e60abc4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/commit.html @@ -0,0 +1,73 @@ + + + +dynamic_vector_buffer::commit + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Move bytes from the output sequence + to the input sequence. +

+
void commit(
+    std::size_t n);
+
+
+ + Parameters +
+
+

+
+
n
+

+ The number of bytes to append from the start of the output sequence + to the end of the input sequence. The remainder of the output sequence + is discarded. +

+
+
+

+ Requires a preceding call prepare(x) + where x >= + n, and no intervening operations + that modify the input or output sequence. +

+
+ + Remarks +
+

+ If n is greater than the + size of the output sequence, the entire output sequence is moved to the + input sequence and no error is issued. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/const_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/const_buffers_type.html new file mode 100644 index 0000000..c9decee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/const_buffers_type.html @@ -0,0 +1,187 @@ + + + +dynamic_vector_buffer::const_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent a sequence of constant buffers that refers to the + underlying memory. +

+
typedef const_buffer const_buffers_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffer [constructor] +

+ 		+

+ Construct an empty buffer.
—
Construct a buffer to + represent a given memory range.
—
Construct a non-modifiable + buffer from a modifiable one.
—
Construct a buffer + from a span of bytes. +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new non-modifiable buffer that is offset from the start + of another. +

+
+

+ The 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::const_buffer b1 = ...;
+std::size_t s1 = b1.size();
+const unsigned char* p1 = static_cast<const unsigned char*>(b1.data());
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/consume.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/consume.html new file mode 100644 index 0000000..33e30bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/consume.html @@ -0,0 +1,62 @@ + + + +dynamic_vector_buffer::consume + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Remove characters from the input + sequence. DynamicBuffer_v2: Consume the + specified number of bytes from the beginning of the underlying memory. +

+
void consume(
+    std::size_t n);
+
+

+ DynamicBuffer_v1: Removes n characters from the beginning of the + input sequence. +

+
+ + Remarks +
+

+ If n is greater than the + size of the input sequence, the entire input sequence is consumed and no + error is issued. +

+

+ DynamicBuffer_v2: Erases n bytes from the beginning of the vector. + If n is greater than the + current size of the vector, the vector is emptied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data.html new file mode 100644 index 0000000..6b9e90e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data.html @@ -0,0 +1,57 @@ + + + +dynamic_vector_buffer::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Get a list of buffers that represents + the input sequence. +

+
const_buffers_type data() const;
+  » more...
+
+

+ DynamicBuffer_v2: Get a sequence of buffers + that represents the underlying memory. +

+
mutable_buffers_type data(
+    std::size_t pos,
+    std::size_t n);
+  » more...
+
+const_buffers_type data(
+    std::size_t pos,
+    std::size_t n) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload1.html new file mode 100644 index 0000000..241f91d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload1.html @@ -0,0 +1,61 @@ + + + +dynamic_vector_buffer::data (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v1: Get a list of buffers + that represents the input sequence. +

+
const_buffers_type data() const;
+
+
+ + Return + Value +
+

+ An object of type const_buffers_type + that satisfies ConstBufferSequence requirements, representing the vector + memory in the input sequence. +

+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_vector_buffer + or vector member function + that modifies the input sequence or output sequence. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload2.html new file mode 100644 index 0000000..c966e94 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload2.html @@ -0,0 +1,82 @@ + + + +dynamic_vector_buffer::data (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v2: Get a sequence of + buffers that represents the underlying memory. +

+
mutable_buffers_type data(
+    std::size_t pos,
+    std::size_t n);
+
+
+ + Parameters +
+
+

+
+
pos
+

+ Position of the first byte to represent in the buffer sequence +

+
n
+

+ The number of bytes to return in the buffer sequence. If the underlying + memory is shorter, the buffer sequence represents as many bytes + as are available. +

+
+
+
+ + Return + Value +
+

+ An object of type mutable_buffers_type + that satisfies MutableBufferSequence requirements, representing the vector + memory. +

+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_vector_buffer + or vector member function + that resizes or erases the vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload3.html new file mode 100644 index 0000000..bd92ab8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/data/overload3.html @@ -0,0 +1,72 @@ + + + +dynamic_vector_buffer::data (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v2: Get a sequence of + buffers that represents the underlying memory. +

+
const_buffers_type data(
+    std::size_t pos,
+    std::size_t n) const;
+
+
+ + Parameters +
+
+

+
+
pos
+

+ Position of the first byte to represent in the buffer sequence +

+
n
+

+ The number of bytes to return in the buffer sequence. If the underlying + memory is shorter, the buffer sequence represents as many bytes + as are available. +

+
+
+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_vector_buffer + or vector member function + that resizes or erases the vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer.html new file mode 100644 index 0000000..e7845ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer.html @@ -0,0 +1,60 @@ + + + +dynamic_vector_buffer::dynamic_vector_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a dynamic buffer from a vector. +

+
explicit dynamic_vector_buffer(
+    std::vector< Elem, Allocator > & v,
+    std::size_t maximum_size = (std::numeric_limits< std::size_t >::max)());
+  » more...
+
+

+ DynamicBuffer_v2: Copy construct a dynamic + buffer. +

+
dynamic_vector_buffer(
+    const dynamic_vector_buffer & other);
+  » more...
+
+

+ Move construct a dynamic buffer. +

+
dynamic_vector_buffer(
+    dynamic_vector_buffer && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload1.html new file mode 100644 index 0000000..4149630 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload1.html @@ -0,0 +1,63 @@ + + + +dynamic_vector_buffer::dynamic_vector_buffer (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a dynamic buffer from a vector. +

+
dynamic_vector_buffer(
+    std::vector< Elem, Allocator > & v,
+    std::size_t maximum_size = (std::numeric_limits< std::size_t >::max)());
+
+
+ + Parameters +
+
+

+
+
v
+

+ The vector to be used as backing storage for the dynamic buffer. + The object stores a reference to the vector and the user is responsible + for ensuring that the vector object remains valid while the dynamic_vector_buffer + object, and copies of the object, are in use. +

+
maximum_size
+

+ Specifies a maximum size for the buffer, in bytes. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload2.html new file mode 100644 index 0000000..f50f2da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload2.html @@ -0,0 +1,43 @@ + + + +dynamic_vector_buffer::dynamic_vector_buffer (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ DynamicBuffer_v2: Copy construct a dynamic + buffer. +

+
dynamic_vector_buffer(
+    const dynamic_vector_buffer & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload3.html new file mode 100644 index 0000000..05005f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/dynamic_vector_buffer/overload3.html @@ -0,0 +1,42 @@ + + + +dynamic_vector_buffer::dynamic_vector_buffer (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct a dynamic buffer. +

+
dynamic_vector_buffer(
+    dynamic_vector_buffer && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/grow.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/grow.html new file mode 100644 index 0000000..4a1414b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/grow.html @@ -0,0 +1,62 @@ + + + +dynamic_vector_buffer::grow + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v2: Grow the underlying memory by + the specified number of bytes. +

+
void grow(
+    std::size_t n);
+
+

+ Resizes the vector to accommodate an additional n + bytes at the end. +

+
+ + Exceptions +
+
+

+
+
std::length_error
+

+ If size() + + n + > max_size(). +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/max_size.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/max_size.html new file mode 100644 index 0000000..e0d0276 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/max_size.html @@ -0,0 +1,52 @@ + + + +dynamic_vector_buffer::max_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the maximum size of the dynamic buffer. +

+
std::size_t max_size() const;
+
+
+ + Return + Value +
+

+ DynamicBuffer_v1: The allowed maximum + of the sum of the sizes of the input sequence and output sequence. DynamicBuffer_v2: The allowed maximum size of the + underlying memory. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/mutable_buffers_type.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/mutable_buffers_type.html new file mode 100644 index 0000000..6dfc382 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/mutable_buffers_type.html @@ -0,0 +1,186 @@ + + + +dynamic_vector_buffer::mutable_buffers_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used to represent a sequence of mutable buffers that refers to the + underlying memory. +

+
typedef mutable_buffer mutable_buffers_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ mutable_buffer [constructor] +

+ 		+

+ Construct an empty buffer.
—
Construct a buffer to + represent a given memory range.
—
Construct a buffer + from a span of bytes. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new modifiable buffer that is offset from the start + of another. +

+
+

+ The 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::mutable_buffer b1 = ...;
+std::size_t s1 = b1.size();
+unsigned char* p1 = static_cast<unsigned char*>(b1.data());
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/prepare.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/prepare.html new file mode 100644 index 0000000..e65d3f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/prepare.html @@ -0,0 +1,81 @@ + + + +dynamic_vector_buffer::prepare + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Get a list of buffers that represents + the output sequence, with the given size. +

+
mutable_buffers_type prepare(
+    std::size_t n);
+
+

+ Ensures that the output sequence can accommodate n + bytes, resizing the vector object as necessary. +

+
+ + Return + Value +
+

+ An object of type mutable_buffers_type + that satisfies MutableBufferSequence requirements, representing vector + memory at the start of the output sequence of size n. +

+
+ + Exceptions +
+
+

+
+
std::length_error
+

+ If size() + + n + > max_size(). +

+
+
+
+ + Remarks +
+

+ The returned object is invalidated by any dynamic_vector_buffer + or vector member function + that modifies the input sequence or output sequence. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/shrink.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/shrink.html new file mode 100644 index 0000000..88e2e0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/shrink.html @@ -0,0 +1,48 @@ + + + +dynamic_vector_buffer::shrink + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v2: Shrink the underlying memory by + the specified number of bytes. +

+
void shrink(
+    std::size_t n);
+
+

+ Erases n bytes from the + end of the vector by resizing the vector object. If n + is greater than the current size of the vector, the vector is emptied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/size.html b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/size.html new file mode 100644 index 0000000..efd3599 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/dynamic_vector_buffer/size.html @@ -0,0 +1,53 @@ + + + +dynamic_vector_buffer::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +DynamicBuffer_v1: Get the size of the input sequence. + DynamicBuffer_v2: Get the current size + of the underlying memory. +

+
std::size_t size() const;
+
+
+ + Return + Value +
+

+ DynamicBuffer_v1 The current size of the + input sequence. DynamicBuffer_v2: The + current size of the underlying vector if less than max_size(). Otherwise returns max_size(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/enable_partial_cancellation.html b/Packages/asio-1.36.0/doc/asio/reference/enable_partial_cancellation.html new file mode 100644 index 0000000..9a4696a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/enable_partial_cancellation.html @@ -0,0 +1,88 @@ + + + +enable_partial_cancellation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A cancellation filter that enables terminal and partial cancellation. +

+
typedef cancellation_filter< cancellation_type::terminal|cancellation_type::partial > enable_partial_cancellation;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Returns type & Mask. +

+
+
+ + Requirements +
+

+ Header: asio/cancellation_state.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/enable_terminal_cancellation.html b/Packages/asio-1.36.0/doc/asio/reference/enable_terminal_cancellation.html new file mode 100644 index 0000000..a0a1056 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/enable_terminal_cancellation.html @@ -0,0 +1,88 @@ + + + +enable_terminal_cancellation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A cancellation filter that enables terminal cancellation only. +

+
typedef cancellation_filter< cancellation_type::terminal > enable_terminal_cancellation;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Returns type & Mask. +

+
+
+ + Requirements +
+

+ Header: asio/cancellation_state.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/enable_total_cancellation.html b/Packages/asio-1.36.0/doc/asio/reference/enable_total_cancellation.html new file mode 100644 index 0000000..bdd04ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/enable_total_cancellation.html @@ -0,0 +1,88 @@ + + + +enable_total_cancellation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A cancellation filter that enables terminal, partial and total cancellation. +

+
typedef cancellation_filter< cancellation_type::terminal|cancellation_type::partial|cancellation_type::total > enable_total_cancellation;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Returns type & Mask. +

+
+
+ + Requirements +
+

+ Header: asio/cancellation_state.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_category.html new file mode 100644 index 0000000..2c0c3b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_category.html @@ -0,0 +1,50 @@ + + + +error::addrinfo_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const asio::error_category & addrinfo_category = asio::error::get_addrinfo_category();
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors.html b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors.html new file mode 100644 index 0000000..9754af2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors.html @@ -0,0 +1,71 @@ + + + +error::addrinfo_errors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
enum addrinfo_errors
+
+

+ + +

+
+ + Values +
+
+

+
+
service_not_found
+

+ The service is not supported for the given socket type. +

+
socket_type_not_supported
+

+ The socket type is not supported. +

+
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors__gt_.html new file mode 100644 index 0000000..7a3c229 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors__gt_.html @@ -0,0 +1,83 @@ + + + +error::addrinfo_errors > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct is_error_code_enum< asio::error::addrinfo_errors >
+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors__gt_/value.html b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors__gt_/value.html new file mode 100644 index 0000000..446d31a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__addrinfo_errors__gt_/value.html @@ -0,0 +1,41 @@ + + + +error::addrinfo_errors >::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const bool value = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors.html b/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors.html new file mode 100644 index 0000000..88579f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors.html @@ -0,0 +1,232 @@ + + + +error::basic_errors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
enum basic_errors
+
+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+
+ + Values +
+
+

+
+
access_denied
+

+ Permission denied. +

+
address_family_not_supported
+

+ Address family not supported by protocol. +

+
address_in_use
+

+ Address already in use. +

+
already_connected
+

+ Transport endpoint is already connected. +

+
already_started
+

+ Operation already in progress. +

+
broken_pipe
+

+ Broken pipe. +

+
connection_aborted
+

+ A connection has been aborted. +

+
connection_refused
+

+ Connection refused. +

+
connection_reset
+

+ Connection reset by peer. +

+
bad_descriptor
+

+ Bad file descriptor. +

+
fault
+

+ Bad address. +

+
host_unreachable
+

+ No route to host. +

+
in_progress
+

+ Operation now in progress. +

+
interrupted
+

+ Interrupted system call. +

+
invalid_argument
+

+ Invalid argument. +

+
message_size
+

+ Message too long. +

+
name_too_long
+

+ The name was too long. +

+
network_down
+

+ Network is down. +

+
network_reset
+

+ Network dropped connection on reset. +

+
network_unreachable
+

+ Network is unreachable. +

+
no_descriptors
+

+ Too many open files. +

+
no_buffer_space
+

+ No buffer space available. +

+
no_memory
+

+ Cannot allocate memory. +

+
no_permission
+

+ Operation not permitted. +

+
no_protocol_option
+

+ Protocol not available. +

+
no_such_device
+

+ No such device. +

+
not_connected
+

+ Transport endpoint is not connected. +

+
not_socket
+

+ Socket operation on non-socket. +

+
operation_aborted
+

+ Operation cancelled. +

+
operation_not_supported
+

+ Operation not supported. +

+
shut_down
+

+ Cannot send after transport endpoint shutdown. +

+
timed_out
+

+ Connection timed out. +

+
try_again
+

+ Resource temporarily unavailable. +

+
would_block
+

+ The socket is marked non-blocking and the requested operation would + block. +

+
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors__gt_.html new file mode 100644 index 0000000..b5c1432 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors__gt_.html @@ -0,0 +1,83 @@ + + + +error::basic_errors > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct is_error_code_enum< asio::error::basic_errors >
+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors__gt_/value.html b/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors__gt_/value.html new file mode 100644 index 0000000..cfa829d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__basic_errors__gt_/value.html @@ -0,0 +1,41 @@ + + + +error::basic_errors >::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const bool value = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__clear.html b/Packages/asio-1.36.0/doc/asio/reference/error__clear.html new file mode 100644 index 0000000..1de2dd8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__clear.html @@ -0,0 +1,51 @@ + + + +error::clear + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void clear(
+    asio::error_code & ec);
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__get_addrinfo_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__get_addrinfo_category.html new file mode 100644 index 0000000..196c7cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__get_addrinfo_category.html @@ -0,0 +1,50 @@ + + + +error::get_addrinfo_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const asio::error_category & get_addrinfo_category();
+
+
+ + Requirements +
+

+ Header: asio/impl/error.ipp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__get_misc_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__get_misc_category.html new file mode 100644 index 0000000..89c87ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__get_misc_category.html @@ -0,0 +1,50 @@ + + + +error::get_misc_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const asio::error_category & get_misc_category();
+
+
+ + Requirements +
+

+ Header: asio/impl/error.ipp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__get_netdb_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__get_netdb_category.html new file mode 100644 index 0000000..ac64fd1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__get_netdb_category.html @@ -0,0 +1,50 @@ + + + +error::get_netdb_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const asio::error_category & get_netdb_category();
+
+
+ + Requirements +
+

+ Header: asio/impl/error.ipp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__get_ssl_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__get_ssl_category.html new file mode 100644 index 0000000..c25c983 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__get_ssl_category.html @@ -0,0 +1,50 @@ + + + +error::get_ssl_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const asio::error_category & get_ssl_category();
+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__get_system_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__get_system_category.html new file mode 100644 index 0000000..25bec5a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__get_system_category.html @@ -0,0 +1,50 @@ + + + +error::get_system_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const asio::error_category & get_system_category();
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code.html b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code.html new file mode 100644 index 0000000..0b362cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code.html @@ -0,0 +1,68 @@ + + + +error::make_error_code + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
asio::error_code make_error_code(
+    basic_errors e);
+  » more...
+
+asio::error_code make_error_code(
+    netdb_errors e);
+  » more...
+
+asio::error_code make_error_code(
+    addrinfo_errors e);
+  » more...
+
+asio::error_code make_error_code(
+    misc_errors e);
+  » more...
+
+asio::error_code make_error_code(
+    ssl_errors e);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload1.html new file mode 100644 index 0000000..f4ed83a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload1.html @@ -0,0 +1,39 @@ + + + +error::make_error_code (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
asio::error_code make_error_code(
+    basic_errors e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload2.html new file mode 100644 index 0000000..d9e3797 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload2.html @@ -0,0 +1,39 @@ + + + +error::make_error_code (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
asio::error_code make_error_code(
+    netdb_errors e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload3.html new file mode 100644 index 0000000..8182dcd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload3.html @@ -0,0 +1,39 @@ + + + +error::make_error_code (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
asio::error_code make_error_code(
+    addrinfo_errors e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload4.html new file mode 100644 index 0000000..5a42f83 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload4.html @@ -0,0 +1,39 @@ + + + +error::make_error_code (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
asio::error_code make_error_code(
+    misc_errors e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload5.html new file mode 100644 index 0000000..f589708 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__make_error_code/overload5.html @@ -0,0 +1,39 @@ + + + +error::make_error_code (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
asio::error_code make_error_code(
+    ssl_errors e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__misc_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__misc_category.html new file mode 100644 index 0000000..04a422f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__misc_category.html @@ -0,0 +1,50 @@ + + + +error::misc_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const asio::error_category & misc_category = asio::error::get_misc_category();
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors.html b/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors.html new file mode 100644 index 0000000..3ac796f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors.html @@ -0,0 +1,81 @@ + + + +error::misc_errors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
enum misc_errors
+
+

+ + + + +

+
+ + Values +
+
+

+
+
already_open
+

+ Already open. +

+
eof
+

+ End of file or stream. +

+
not_found
+

+ Element not found. +

+
fd_set_failure
+

+ The descriptor cannot fit into the select system call's fd_set. +

+
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors__gt_.html new file mode 100644 index 0000000..d01d8d0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors__gt_.html @@ -0,0 +1,84 @@ + + + +error::misc_errors > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct is_error_code_enum< asio::error::misc_errors >
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors__gt_/value.html b/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors__gt_/value.html new file mode 100644 index 0000000..0ddcba3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__misc_errors__gt_/value.html @@ -0,0 +1,41 @@ + + + +error::misc_errors >::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const bool value = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__netdb_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_category.html new file mode 100644 index 0000000..37f46d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_category.html @@ -0,0 +1,50 @@ + + + +error::netdb_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const asio::error_category & netdb_category = asio::error::get_netdb_category();
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors.html b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors.html new file mode 100644 index 0000000..6220eea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors.html @@ -0,0 +1,81 @@ + + + +error::netdb_errors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
enum netdb_errors
+
+

+ + + + +

+
+ + Values +
+
+

+
+
host_not_found
+

+ Host not found (authoritative). +

+
host_not_found_try_again
+

+ Host not found (non-authoritative). +

+
no_data
+

+ The query is valid but does not have associated address data. +

+
no_recovery
+

+ A non-recoverable error occurred. +

+
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors__gt_.html new file mode 100644 index 0000000..afb02ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors__gt_.html @@ -0,0 +1,83 @@ + + + +error::netdb_errors > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct is_error_code_enum< asio::error::netdb_errors >
+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors__gt_/value.html b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors__gt_/value.html new file mode 100644 index 0000000..e0ba21c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__netdb_errors__gt_/value.html @@ -0,0 +1,41 @@ + + + +error::netdb_errors >::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const bool value = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__ssl_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_category.html new file mode 100644 index 0000000..e90062a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_category.html @@ -0,0 +1,50 @@ + + + +error::ssl_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const asio::error_category & ssl_category = asio::error::get_ssl_category();
+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors.html b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors.html new file mode 100644 index 0000000..c969950 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors.html @@ -0,0 +1,50 @@ + + + +error::ssl_errors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
enum ssl_errors
+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors__gt_.html new file mode 100644 index 0000000..d2e494c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors__gt_.html @@ -0,0 +1,84 @@ + + + +error::ssl_errors > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct is_error_code_enum< asio::error::ssl_errors >
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors__gt_/value.html b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors__gt_/value.html new file mode 100644 index 0000000..afa9f35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__ssl_errors__gt_/value.html @@ -0,0 +1,41 @@ + + + +error::ssl_errors >::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const bool value = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error__system_category.html b/Packages/asio-1.36.0/doc/asio/reference/error__system_category.html new file mode 100644 index 0000000..f8d4c2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error__system_category.html @@ -0,0 +1,50 @@ + + + +error::system_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const asio::error_category & system_category = asio::error::get_system_category();
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error_category.html b/Packages/asio-1.36.0/doc/asio/reference/error_category.html new file mode 100644 index 0000000..3bf4426 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error_category.html @@ -0,0 +1,50 @@ + + + +error_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef std::error_category error_category;
+
+
+ + Requirements +
+

+ Header: asio/error_code.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/error_code.html b/Packages/asio-1.36.0/doc/asio/reference/error_code.html new file mode 100644 index 0000000..fe9654c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/error_code.html @@ -0,0 +1,50 @@ + + + +error_code + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef std::error_code error_code;
+
+
+ + Requirements +
+

+ Header: asio/error_code.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__allocator.html b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator.html new file mode 100644 index 0000000..869d3b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator.html @@ -0,0 +1,53 @@ + + + +execution::allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::allocator_t property. +

+
constexpr allocator_t< void > allocator;
+
+
+ + Requirements +
+

+ Header: asio/execution/allocator.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t.html new file mode 100644 index 0000000..150a210 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t.html @@ -0,0 +1,165 @@ + + + +execution::allocator_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property to describe which allocator an executor will use to allocate the + memory required to store a submitted function object. +

+
template<
+    typename ProtoAllocator>
+struct allocator_t
+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value +

+ 		+

+ Obtain the allocator stored in the allocator_t property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The allocator_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The allocator_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The allocator_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/allocator.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/allocator_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/allocator_t.html new file mode 100644 index 0000000..1a0e421 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/allocator_t.html @@ -0,0 +1,42 @@ + + + +execution::allocator_t::allocator_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr allocator_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_applicable_property_v.html new file mode 100644 index 0000000..8f91a40 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::allocator_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::allocator_t + property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_preferable.html new file mode 100644 index 0000000..b6b198c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::allocator_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::allocator_t + property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_requirable.html new file mode 100644 index 0000000..ea218da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::allocator_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::allocator_t + property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/value.html new file mode 100644 index 0000000..c62d400 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__allocator_t/value.html @@ -0,0 +1,46 @@ + + + +execution::allocator_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the allocator stored in the execution::allocator_t property object. +

+
constexpr ProtoAllocator value() const;
+
+

+ Present only if ProtoAllocator + is non-void. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor.html new file mode 100644 index 0000000..8bf8a0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor.html @@ -0,0 +1,280 @@ + + + +execution::any_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Polymorphic executor wrapper. +

+
template<
+    typename... SupportableProperties>
+class any_executor
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ any_executor [constructor] +

+ 		+

+ Default constructor.
—
Construct in an empty state. + Equivalent effects to default constructor.
—
Copy constructor. +
—
Move constructor.
—
Construct to point + to the same target as another any_executor.
—
Construct + a polymorphic wrapper for the specified executor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ execute +

+ 		+

+ Execute the function on the target executor. +

+
+

+ operator bool +

+ 		+

+ Determine whether the wrapper has a target executor. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator.
+ —
Assignment operator that sets the polymorphic wrapper to + the empty state.
—
Assignment operator to create a + polymorphic wrapper for the specified executor. +

+
+

+ prefer +

+ 		+

+ Obtain a polymorphic wrapper with the specified property. +

+
+

+ query +

+ 		+

+ Obtain the value associated with the specified property. +

+
+

+ require +

+ 		+

+ Obtain a polymorphic wrapper with the specified property. +

+
+

+ swap +

+ 		+

+ Swap targets with another polymorphic wrapper. +

+
+

+ target +

+ 		+

+ Get a pointer to the target executor. +

+
+

+ target_type +

+ 		+

+ Get the type of the target executor. +

+
+

+ ~any_executor [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/execution/any_executor.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/_any_executor.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/_any_executor.html new file mode 100644 index 0000000..5b2dc5f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/_any_executor.html @@ -0,0 +1,41 @@ + + + +execution::any_executor::~any_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~any_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor.html new file mode 100644 index 0000000..61483ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor.html @@ -0,0 +1,106 @@ + + + +execution::any_executor::any_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
any_executor();
+  » more...
+
+

+ Construct in an empty state. Equivalent effects to default constructor. +

+
any_executor(
+    nullptr_t );
+  » more...
+
+

+ Copy constructor. +

+
any_executor(
+    const any_executor & e);
+  » more...
+
+

+ Move constructor. +

+
any_executor(
+    any_executor && e);
+  » more...
+
+

+ Construct to point to the same target as another execution::any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_executor(
+    any_executor< OtherSupportableProperties... > e);
+  » more...
+
+template<
+    class... OtherSupportableProperties>
+any_executor(
+    std::nothrow_t ,
+    any_executor< OtherSupportableProperties... > e);
+  » more...
+
+any_executor(
+    std::nothrow_t ,
+    const any_executor & e);
+  » more...
+
+any_executor(
+    std::nothrow_t ,
+    any_executor && e);
+  » more...
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_executor(
+    Executor e);
+  » more...
+
+template<
+    typename Executor>
+any_executor(
+    std::nothrow_t ,
+    Executor e);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload1.html new file mode 100644 index 0000000..c497c79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload1.html @@ -0,0 +1,41 @@ + + + +execution::any_executor::any_executor (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
any_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload10.html new file mode 100644 index 0000000..2126b89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload10.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::any_executor (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_executor(
+    std::nothrow_t ,
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload2.html new file mode 100644 index 0000000..d862a6c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload2.html @@ -0,0 +1,42 @@ + + + +execution::any_executor::any_executor (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct in an empty state. Equivalent effects to default constructor. +

+
any_executor(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload3.html new file mode 100644 index 0000000..d6bc99d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload3.html @@ -0,0 +1,42 @@ + + + +execution::any_executor::any_executor (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
any_executor(
+    const any_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload4.html new file mode 100644 index 0000000..6850743 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload4.html @@ -0,0 +1,42 @@ + + + +execution::any_executor::any_executor (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
any_executor(
+    any_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload5.html new file mode 100644 index 0000000..3b6a4fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload5.html @@ -0,0 +1,44 @@ + + + +execution::any_executor::any_executor (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another execution::any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_executor(
+    any_executor< OtherSupportableProperties... > e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload6.html new file mode 100644 index 0000000..a3b2044 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload6.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::any_executor (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another execution::any_executor. +

+
template<
+    class... OtherSupportableProperties>
+any_executor(
+    std::nothrow_t ,
+    any_executor< OtherSupportableProperties... > e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload7.html new file mode 100644 index 0000000..a35aa5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload7.html @@ -0,0 +1,43 @@ + + + +execution::any_executor::any_executor (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another execution::any_executor. +

+
any_executor(
+    std::nothrow_t ,
+    const any_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload8.html new file mode 100644 index 0000000..058dc3e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload8.html @@ -0,0 +1,43 @@ + + + +execution::any_executor::any_executor (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to point to the same target as another execution::any_executor. +

+
any_executor(
+    std::nothrow_t ,
+    any_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload9.html new file mode 100644 index 0000000..8f2c64e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/any_executor/overload9.html @@ -0,0 +1,44 @@ + + + +execution::any_executor::any_executor (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_executor(
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/context.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/context.html new file mode 100644 index 0000000..f54fd7d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/context.html @@ -0,0 +1,47 @@ + + + +execution::any_executor::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the underlying execution context. +

+
automatically_determined context() const;
+
+

+ This function is provided for backward compatibility. It is automatically + defined when the SupportableProperties... + list includes a property of type execution::context_as<U>, for some type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/execute.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/execute.html new file mode 100644 index 0000000..6e93476 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/execute.html @@ -0,0 +1,49 @@ + + + +execution::any_executor::execute + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Execute + the function on the target executor. +

+
template<
+    typename Function>
+void execute(
+    Function && f) const;
+
+

+ Throws bad_executor + if the polymorphic wrapper has no target. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_bool.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_bool.html new file mode 100644 index 0000000..81c7007 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_bool.html @@ -0,0 +1,52 @@ + + + +execution::any_executor::operator bool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the wrapper has a target executor. +

+
operator bool() const;
+
+
+ + Return + Value +
+

+ true if the polymorphic wrapper + has a target executor, otherwise false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_.html new file mode 100644 index 0000000..14f665f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_.html @@ -0,0 +1,67 @@ + + + +execution::any_executor::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment + operator. +

+
any_executor & operator=(
+    const any_executor & e);
+  » more...
+
+

+ Move assignment operator. +

+
any_executor & operator=(
+    any_executor && e);
+  » more...
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_executor & operator=(
+    nullptr_t );
+  » more...
+
+

+ Assignment operator to create a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+any_executor & operator=(
+    Executor e);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload1.html new file mode 100644 index 0000000..12428f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +execution::any_executor::operator= (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
any_executor & operator=(
+    const any_executor & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload2.html new file mode 100644 index 0000000..e17a7ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +execution::any_executor::operator= (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
any_executor & operator=(
+    any_executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload3.html new file mode 100644 index 0000000..5fed891 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload3.html @@ -0,0 +1,42 @@ + + + +execution::any_executor::operator= (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator that sets the polymorphic wrapper to the empty state. +

+
any_executor & operator=(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload4.html new file mode 100644 index 0000000..8e3d9dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq_/overload4.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::operator= (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator to create a polymorphic wrapper for the specified + executor. +

+
template<
+    typename Executor>
+any_executor & operator=(
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_.html new file mode 100644 index 0000000..99e8b6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_.html @@ -0,0 +1,61 @@ + + + +execution::any_executor::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+  » more...
+
+template<
+    typename... SupportableProperties>
+bool operator==(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload1.html new file mode 100644 index 0000000..f69d572 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload1.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::operator== (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload2.html new file mode 100644 index 0000000..0179502 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload2.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::operator== (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload3.html new file mode 100644 index 0000000..97dec83 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_eq__eq_/overload3.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::operator== (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator==(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_.html new file mode 100644 index 0000000..1b5853b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_.html @@ -0,0 +1,61 @@ + + + +execution::any_executor::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+  » more...
+
+template<
+    typename... SupportableProperties>
+bool operator!=(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload1.html new file mode 100644 index 0000000..82c0ff4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload1.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::operator!= (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload2.html new file mode 100644 index 0000000..fa0981d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload2.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::operator!= (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    const any_executor< SupportableProperties... > & a,
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload3.html new file mode 100644 index 0000000..7049a6c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/operator_not__eq_/overload3.html @@ -0,0 +1,45 @@ + + + +execution::any_executor::operator!= (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator. +

+
template<
+    typename... SupportableProperties>
+bool operator!=(
+    nullptr_t ,
+    const any_executor< SupportableProperties... > & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/prefer.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/prefer.html new file mode 100644 index 0000000..69af5af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/prefer.html @@ -0,0 +1,55 @@ + + + +execution::any_executor::prefer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_executor prefer(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the prefer + customisation point. +

+

+ For example: +

+
execution::any_executor<execution::blocking_t::possibly_t> ex = ...;
+auto ex2 = asio::prefer(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/query.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/query.html new file mode 100644 index 0000000..ecf0b0a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/query.html @@ -0,0 +1,55 @@ + + + +execution::any_executor::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the value associated with the specified property. +

+
template<
+    typename Property>
+Property::polymorphic_query_result_type query(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the query + customisation point. +

+

+ For example: +

+
execution::any_executor<execution::occupancy_t> ex = ...;
+size_t n = asio::query(ex, execution::occupancy);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/require.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/require.html new file mode 100644 index 0000000..12a2e03 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/require.html @@ -0,0 +1,56 @@ + + + +execution::any_executor::require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a polymorphic wrapper with the specified property. +

+
template<
+    typename Property>
+any_executor require(
+    Property ) const;
+
+

+ Do not call this function directly. It is intended for use with the require + and prefer + customisation points. +

+

+ For example: +

+
execution::any_executor<execution::blocking_t::possibly_t> ex = ...;
+auto ex2 = asio::require(ex, execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/swap.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/swap.html new file mode 100644 index 0000000..ea3eb71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/swap.html @@ -0,0 +1,43 @@ + + + +execution::any_executor::swap + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Swap + targets with another polymorphic wrapper. +

+
void swap(
+    any_executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target.html new file mode 100644 index 0000000..ee0334a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target.html @@ -0,0 +1,50 @@ + + + +execution::any_executor::target + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a pointer to the target executor. +

+
template<
+    typename Executor>
+Executor * target();
+  » more...
+
+template<
+    typename Executor>
+const Executor * target() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target/overload1.html new file mode 100644 index 0000000..36302c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target/overload1.html @@ -0,0 +1,43 @@ + + + +execution::any_executor::target (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a pointer to the target executor. +

+
template<
+    typename Executor>
+Executor * target();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target/overload2.html new file mode 100644 index 0000000..5de17ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target/overload2.html @@ -0,0 +1,43 @@ + + + +execution::any_executor::target (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a pointer to the target executor. +

+
template<
+    typename Executor>
+const Executor * target() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target_type.html new file mode 100644 index 0000000..2ec3b92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__any_executor/target_type.html @@ -0,0 +1,42 @@ + + + +execution::any_executor::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the type of the target executor. +

+
const type_info & target_type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor.html b/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor.html new file mode 100644 index 0000000..13b156b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor.html @@ -0,0 +1,103 @@ + + + +execution::bad_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Exception thrown when trying to access an empty polymorphic executor. +

+
class bad_executor :
+  public exception
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bad_executor [constructor] +

+ 		+

+ Constructor. +

+
+

+ what +

+ 		+

+ Obtain message associated with exception. +

+
+
+ + Requirements +
+

+ Header: asio/execution/bad_executor.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor/bad_executor.html b/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor/bad_executor.html new file mode 100644 index 0000000..3e7542d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor/bad_executor.html @@ -0,0 +1,41 @@ + + + +execution::bad_executor::bad_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
bad_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor/what.html b/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor/what.html new file mode 100644 index 0000000..e007f50 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__bad_executor/what.html @@ -0,0 +1,42 @@ + + + +execution::bad_executor::what + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + message associated with exception. +

+
virtual const char * what() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking.html new file mode 100644 index 0000000..f905904 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking.html @@ -0,0 +1,53 @@ + + + +execution::blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::blocking_t property. +

+
constexpr blocking_t blocking;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation.html new file mode 100644 index 0000000..7956a53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation.html @@ -0,0 +1,53 @@ + + + +execution::blocking_adaptation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::blocking_adaptation_t property. +

+
constexpr blocking_adaptation_t blocking_adaptation;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t.html new file mode 100644 index 0000000..198e4e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t.html @@ -0,0 +1,286 @@ + + + +execution::blocking_adaptation_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property to describe whether automatic adaptation of an executor is allowed + in order to apply the execution::blocking_adaptation_t::allowed_t property. +

+
struct blocking_adaptation_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allowed_t +

+ 		+

+ A sub-property that indicates that automatic adaptation is allowed. +

+
+

+ disallowed_t +

+ 		+

+ A sub-property that indicates that automatic adaptation is not + allowed. +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ blocking_adaptation_t [constructor] +

+ 		+

+ Default constructor.
—
Construct from a sub-property + value. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allowed [static] +

+ 		+

+ A special value used for accessing the blocking_adaptation_t::allowed_t + property. +

+
+

+ disallowed [static] +

+ 		+

+ A special value used for accessing the blocking_adaptation_t::disallowed_t + property. +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The blocking_adaptation_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The top-level blocking_adaptation_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The top-level blocking_adaptation_t property cannot be required. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare property values for inequality. +

+
+

+ operator== +

+ 		+

+ Compare property values for equality. +

+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/allowed.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/allowed.html new file mode 100644 index 0000000..640b561 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/allowed.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::allowed + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::blocking_adaptation_t::allowed_t property. +

+
static constexpr allowed_t allowed;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t.html new file mode 100644 index 0000000..2ad40dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t.html @@ -0,0 +1,54 @@ + + + +execution::blocking_adaptation_t::blocking_adaptation_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr blocking_adaptation_t();
+  » more...
+
+

+ Construct from a sub-property value. +

+
constexpr blocking_adaptation_t(
+    disallowed_t );
+  » more...
+
+constexpr blocking_adaptation_t(
+    allowed_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload1.html new file mode 100644 index 0000000..768f880 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload1.html @@ -0,0 +1,41 @@ + + + +execution::blocking_adaptation_t::blocking_adaptation_t (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr blocking_adaptation_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload2.html new file mode 100644 index 0000000..75a045b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload2.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::blocking_adaptation_t (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr blocking_adaptation_t(
+    disallowed_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload3.html new file mode 100644 index 0000000..465701d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/blocking_adaptation_t/overload3.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::blocking_adaptation_t (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr blocking_adaptation_t(
+    allowed_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/disallowed.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/disallowed.html new file mode 100644 index 0000000..78b043e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/disallowed.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::disallowed + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::blocking_adaptation_t::disallowed_t property. +

+
static constexpr disallowed_t disallowed;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_applicable_property_v.html new file mode 100644 index 0000000..d24cee5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::blocking_adaptation_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_adaptation_t property + applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_preferable.html new file mode 100644 index 0000000..a537ddc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::blocking_adaptation_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::blocking_adaptation_t property + cannot be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_requirable.html new file mode 100644 index 0000000..a4985a4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::blocking_adaptation_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::blocking_adaptation_t property + cannot be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/operator_eq__eq_.html new file mode 100644 index 0000000..e5ef7b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +execution::blocking_adaptation_t::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for equality. +

+
constexpr bool operator==(
+    const blocking_adaptation_t & a,
+    const blocking_adaptation_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/operator_not__eq_.html new file mode 100644 index 0000000..d083773 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +execution::blocking_adaptation_t::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for inequality. +

+
constexpr bool operator!=(
+    const blocking_adaptation_t & a,
+    const blocking_adaptation_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..cfe2263 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::blocking_adaptation_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef blocking_adaptation_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t.html new file mode 100644 index 0000000..309d2ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t.html @@ -0,0 +1,197 @@ + + + +execution::blocking_adaptation_t::allowed_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that automatic adaptation is allowed. +

+
struct allowed_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allowed_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The blocking_adaptation_t::allowed_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The blocking_adaptation_t::allowed_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The blocking_adaptation_t::allowed_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/allowed_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/allowed_t.html new file mode 100644 index 0000000..fd70041 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/allowed_t.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::allowed_t::allowed_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr allowed_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_applicable_property_v.html new file mode 100644 index 0000000..34f0fb2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::blocking_adaptation_t::allowed_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_adaptation_t::allowed_t property applies to + executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_preferable.html new file mode 100644 index 0000000..aa78bc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::allowed_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_adaptation_t::allowed_t property can be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_requirable.html new file mode 100644 index 0000000..771808d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::allowed_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_adaptation_t::allowed_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..c75aa09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::blocking_adaptation_t::allowed_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef blocking_adaptation_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/value.html new file mode 100644 index 0000000..bf5b908 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__allowed_t/value.html @@ -0,0 +1,50 @@ + + + +execution::blocking_adaptation_t::allowed_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr blocking_adaptation_t value();
+
+
+ + Return + Value +
+

+ allowed_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t.html new file mode 100644 index 0000000..b85841b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t.html @@ -0,0 +1,197 @@ + + + +execution::blocking_adaptation_t::disallowed_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that automatic adaptation is not allowed. +

+
struct disallowed_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ disallowed_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The blocking_adaptation_t::disallowed_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The blocking_adaptation_t::disallowed_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The blocking_adaptation_t::disallowed_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/disallowed_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/disallowed_t.html new file mode 100644 index 0000000..d719985 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/disallowed_t.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::disallowed_t::disallowed_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr disallowed_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_applicable_property_v.html new file mode 100644 index 0000000..3616007 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::blocking_adaptation_t::disallowed_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_adaptation_t::disallowed_t property applies + to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_preferable.html new file mode 100644 index 0000000..9bf5cd1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::disallowed_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_adaptation_t::disallowed_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_requirable.html new file mode 100644 index 0000000..c5d7060 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_adaptation_t::disallowed_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_adaptation_t::disallowed_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..415ec76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::blocking_adaptation_t::disallowed_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef blocking_adaptation_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking_adaptation.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/value.html new file mode 100644 index 0000000..2f78cb8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_adaptation_t__disallowed_t/value.html @@ -0,0 +1,50 @@ + + + +execution::blocking_adaptation_t::disallowed_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr blocking_adaptation_t value();
+
+
+ + Return + Value +
+

+ disallowed_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t.html new file mode 100644 index 0000000..5cfa462 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t.html @@ -0,0 +1,312 @@ + + + +execution::blocking_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property to describe what guarantees an executor makes about the blocking + behaviour of their execution functions. +

+
struct blocking_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ always_t +

+ 		+

+ A sub-property that indicates that invocation of an executor's + execution function shall block until completion of all invocations + of the submitted function object. +

+
+

+ never_t +

+ 		+

+ A sub-property that indicates that invocation of an executor's + execution function shall not block pending completion of the invocations + of the submitted function object. +

+
+

+ possibly_t +

+ 		+

+ A sub-property that indicates that invocation of an executor's + execution function may block pending completion of one or more + invocations of the submitted function object. +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ blocking_t [constructor] +

+ 		+

+ Default constructor.
—
Construct from a sub-property + value. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ always [static] +

+ 		+

+ A special value used for accessing the blocking_t::always_t property. +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The blocking_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The top-level blocking_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The top-level blocking_t property cannot be required. +

+
+

+ never [static] +

+ 		+

+ A special value used for accessing the blocking_t::never_t property. +

+
+

+ possibly [static] +

+ 		+

+ A special value used for accessing the blocking_t::possibly_t property. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare property values for inequality. +

+
+

+ operator== +

+ 		+

+ Compare property values for equality. +

+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/always.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/always.html new file mode 100644 index 0000000..53174e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/always.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::always + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::blocking_t::always_t property. +

+
static constexpr always_t always;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t.html new file mode 100644 index 0000000..f68a795 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t.html @@ -0,0 +1,58 @@ + + + +execution::blocking_t::blocking_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr blocking_t();
+  » more...
+
+

+ Construct from a sub-property value. +

+
constexpr blocking_t(
+    possibly_t );
+  » more...
+
+constexpr blocking_t(
+    always_t );
+  » more...
+
+constexpr blocking_t(
+    never_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload1.html new file mode 100644 index 0000000..e88fb6d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload1.html @@ -0,0 +1,41 @@ + + + +execution::blocking_t::blocking_t (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr blocking_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload2.html new file mode 100644 index 0000000..b50fa58 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload2.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::blocking_t (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr blocking_t(
+    possibly_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload3.html new file mode 100644 index 0000000..3d68d48 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload3.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::blocking_t (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr blocking_t(
+    always_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload4.html new file mode 100644 index 0000000..326e4d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/blocking_t/overload4.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::blocking_t (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr blocking_t(
+    never_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_applicable_property_v.html new file mode 100644 index 0000000..93a5b77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::blocking_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t + property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_preferable.html new file mode 100644 index 0000000..7c19a4d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::blocking_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::blocking_t property cannot be + preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_requirable.html new file mode 100644 index 0000000..aeb692e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::blocking_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::blocking_t property cannot be + required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/never.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/never.html new file mode 100644 index 0000000..1e766d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/never.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::never + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A special + value used for accessing the execution::blocking_t::never_t property. +

+
static constexpr never_t never;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/operator_eq__eq_.html new file mode 100644 index 0000000..1a34540 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +execution::blocking_t::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for equality. +

+
constexpr bool operator==(
+    const blocking_t & a,
+    const blocking_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/operator_not__eq_.html new file mode 100644 index 0000000..ac0ccd7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +execution::blocking_t::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for inequality. +

+
constexpr bool operator!=(
+    const blocking_t & a,
+    const blocking_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..84053b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::blocking_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef blocking_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/possibly.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/possibly.html new file mode 100644 index 0000000..8e710b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t/possibly.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::possibly + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::blocking_t::possibly_t property. +

+
static constexpr possibly_t possibly;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t.html new file mode 100644 index 0000000..2b93fcd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t.html @@ -0,0 +1,199 @@ + + + +execution::blocking_t::always_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that invocation of an executor's execution + function shall block until completion of all invocations of the submitted + function object. +

+
struct always_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ always_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The blocking_t::always_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The blocking_t::always_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The blocking_t::always_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/always_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/always_t.html new file mode 100644 index 0000000..3531bc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/always_t.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::always_t::always_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr always_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_applicable_property_v.html new file mode 100644 index 0000000..028ffa5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_applicable_property_v.html @@ -0,0 +1,43 @@ + + + +execution::blocking_t::always_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::always_t property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_preferable.html new file mode 100644 index 0000000..775f51e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::always_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::always_t property can be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_requirable.html new file mode 100644 index 0000000..13da29d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::always_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::always_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..daaf423 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::blocking_t::always_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef blocking_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/value.html new file mode 100644 index 0000000..1fb5e0c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__always_t/value.html @@ -0,0 +1,50 @@ + + + +execution::blocking_t::always_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr blocking_t value();
+
+
+ + Return + Value +
+

+ always_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t.html new file mode 100644 index 0000000..294f399 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t.html @@ -0,0 +1,199 @@ + + + +execution::blocking_t::never_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that invocation of an executor's execution + function shall not block pending completion of the invocations of the submitted + function object. +

+
struct never_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ never_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The blocking_t::never_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The blocking_t::never_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The blocking_t::never_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_applicable_property_v.html new file mode 100644 index 0000000..078ed84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_applicable_property_v.html @@ -0,0 +1,43 @@ + + + +execution::blocking_t::never_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::never_t property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_preferable.html new file mode 100644 index 0000000..cb29c8a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::never_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::never_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_requirable.html new file mode 100644 index 0000000..08053c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::never_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::never_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/never_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/never_t.html new file mode 100644 index 0000000..f8df3f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/never_t.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::never_t::never_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr never_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..11fdd35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::blocking_t::never_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef blocking_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/value.html new file mode 100644 index 0000000..6c2cd93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__never_t/value.html @@ -0,0 +1,50 @@ + + + +execution::blocking_t::never_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr blocking_t value();
+
+
+ + Return + Value +
+

+ never_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t.html new file mode 100644 index 0000000..9447f3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t.html @@ -0,0 +1,199 @@ + + + +execution::blocking_t::possibly_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that invocation of an executor's execution + function may block pending completion of one or more invocations of the submitted + function object. +

+
struct possibly_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ possibly_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The blocking_t::possibly_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The blocking_t::possibly_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The blocking_t::possibly_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_applicable_property_v.html new file mode 100644 index 0000000..b6412b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::blocking_t::possibly_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::possibly_t property applies to + executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_preferable.html new file mode 100644 index 0000000..8939f1e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::possibly_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::possibly_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_requirable.html new file mode 100644 index 0000000..e460b37 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::possibly_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::blocking_t::possibly_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..cc742c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::blocking_t::possibly_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef blocking_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/blocking.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/possibly_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/possibly_t.html new file mode 100644 index 0000000..4966d8a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/possibly_t.html @@ -0,0 +1,42 @@ + + + +execution::blocking_t::possibly_t::possibly_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr possibly_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/value.html new file mode 100644 index 0000000..0d3d5f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__blocking_t__possibly_t/value.html @@ -0,0 +1,50 @@ + + + +execution::blocking_t::possibly_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr blocking_t value();
+
+
+ + Return + Value +
+

+ possibly_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context.html new file mode 100644 index 0000000..309d7ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context.html @@ -0,0 +1,53 @@ + + + +execution::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::context_t property. +

+
constexpr context_t context;
+
+
+ + Requirements +
+

+ Header: asio/execution/context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_as.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as.html new file mode 100644 index 0000000..9024147 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as.html @@ -0,0 +1,54 @@ + + + +execution::context_as + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::context_as_t property. +

+
template <typename U>
+constexpr context_as_t context_as;
+
+
+ + Requirements +
+

+ Header: asio/execution/context_as.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t.html new file mode 100644 index 0000000..a134277 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t.html @@ -0,0 +1,151 @@ + + + +execution::context_as_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property that is used to obtain the execution context that is associated + with an executor. +

+
template<
+    typename U>
+struct context_as_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The context_as_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The context_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The context_t property cannot be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/context_as.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_applicable_property_v.html new file mode 100644 index 0000000..87b9f92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::context_as_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_as_t + property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_preferable.html new file mode 100644 index 0000000..ce73608 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::context_as_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_t + property cannot be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_requirable.html new file mode 100644 index 0000000..d27478b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::context_as_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_t + property cannot be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..a1796e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_as_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::context_as_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef T polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/context_as.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t.html new file mode 100644 index 0000000..167acc5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t.html @@ -0,0 +1,149 @@ + + + +execution::context_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property that is used to obtain the execution context that is associated + with an executor. +

+
struct context_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The context_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The context_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The context_t property cannot be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_applicable_property_v.html new file mode 100644 index 0000000..85c2baa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::context_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_t + property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_preferable.html new file mode 100644 index 0000000..8d0fa87 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::context_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_t + property cannot be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_requirable.html new file mode 100644 index 0000000..fa54c72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::context_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_t + property cannot be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..3a73159 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__context_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::context_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef std::any polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__invocable_archetype.html b/Packages/asio-1.36.0/doc/asio/reference/execution__invocable_archetype.html new file mode 100644 index 0000000..c8f4a07 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__invocable_archetype.html @@ -0,0 +1,89 @@ + + + +execution::invocable_archetype + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An archetypal function object used for determining adherence to the execution::executor + concept. +

+
struct invocable_archetype
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Function call operator. +

+
+
+ + Requirements +
+

+ Header: asio/execution/invocable_archetype.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__invocable_archetype/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__invocable_archetype/operator_lp__rp_.html new file mode 100644 index 0000000..1161de3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__invocable_archetype/operator_lp__rp_.html @@ -0,0 +1,45 @@ + + + +execution::invocable_archetype::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + call operator. +

+
template<
+    typename... Args>
+void operator()(
+    Args && ...);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__is_executor.html b/Packages/asio-1.36.0/doc/asio/reference/execution__is_executor.html new file mode 100644 index 0000000..8a08228 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__is_executor.html @@ -0,0 +1,63 @@ + + + +execution::is_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The execution::is_executor + trait detects whether a type T satisfies the execution::executor concept. +

+
template<
+    typename T>
+struct is_executor :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template is_executor + is a UnaryTypeTrait that is derived from true_type + if the type T meets the concept + definition for an executor, otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/execution/executor.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping.html new file mode 100644 index 0000000..bd4bdac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping.html @@ -0,0 +1,53 @@ + + + +execution::mapping + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::mapping_t property. +

+
constexpr mapping_t mapping;
+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t.html new file mode 100644 index 0000000..7e756e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t.html @@ -0,0 +1,310 @@ + + + +execution::mapping_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property to describe what guarantees an executor makes about the mapping + of execution agents on to threads of execution. +

+
struct mapping_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ new_thread_t +

+ 		+

+ A sub-property that indicates that execution agents are mapped + on to new threads of execution. +

+
+

+ other_t +

+ 		+

+ A sub-property that indicates that the mapping of execution agents + is implementation-defined. +

+
+

+ thread_t +

+ 		+

+ A sub-property that indicates that execution agents are mapped + on to threads of execution. +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ mapping_t [constructor] +

+ 		+

+ Default constructor.
—
Construct from a sub-property + value. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The mapping_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The top-level mapping_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The top-level mapping_t property cannot be required. +

+
+

+ new_thread [static] +

+ 		+

+ A special value used for accessing the mapping_t::new_thread_t + property. +

+
+

+ other [static] +

+ 		+

+ A special value used for accessing the mapping_t::other_t property. +

+
+

+ thread [static] +

+ 		+

+ A special value used for accessing the mapping_t::thread_t property. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare property values for inequality. +

+
+

+ operator== +

+ 		+

+ Compare property values for equality. +

+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_applicable_property_v.html new file mode 100644 index 0000000..42b5d76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::mapping_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t + property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_preferable.html new file mode 100644 index 0000000..98f3812 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::mapping_t property cannot be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_requirable.html new file mode 100644 index 0000000..d361b1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::mapping_t property cannot be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t.html new file mode 100644 index 0000000..d4c87fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t.html @@ -0,0 +1,58 @@ + + + +execution::mapping_t::mapping_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr mapping_t();
+  » more...
+
+

+ Construct from a sub-property value. +

+
constexpr mapping_t(
+    thread_t );
+  » more...
+
+constexpr mapping_t(
+    new_thread_t );
+  » more...
+
+constexpr mapping_t(
+    other_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload1.html new file mode 100644 index 0000000..088f1d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload1.html @@ -0,0 +1,41 @@ + + + +execution::mapping_t::mapping_t (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr mapping_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload2.html new file mode 100644 index 0000000..9a0759f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload2.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::mapping_t (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr mapping_t(
+    thread_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload3.html new file mode 100644 index 0000000..1164dbc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload3.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::mapping_t (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr mapping_t(
+    new_thread_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload4.html new file mode 100644 index 0000000..8dfa93f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/mapping_t/overload4.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::mapping_t (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr mapping_t(
+    other_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/new_thread.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/new_thread.html new file mode 100644 index 0000000..7ad04dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/new_thread.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::new_thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::mapping_t::new_thread_t property. +

+
static constexpr new_thread_t new_thread;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/operator_eq__eq_.html new file mode 100644 index 0000000..f11f0c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +execution::mapping_t::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for equality. +

+
constexpr bool operator==(
+    const mapping_t & a,
+    const mapping_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/operator_not__eq_.html new file mode 100644 index 0000000..effb719 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +execution::mapping_t::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for inequality. +

+
constexpr bool operator!=(
+    const mapping_t & a,
+    const mapping_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/other.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/other.html new file mode 100644 index 0000000..48b55da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/other.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A special + value used for accessing the execution::mapping_t::other_t property. +

+
static constexpr other_t other;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..71cd551 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::mapping_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef mapping_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/thread.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/thread.html new file mode 100644 index 0000000..bfe8806 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t/thread.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A special + value used for accessing the execution::mapping_t::thread_t property. +

+
static constexpr thread_t thread;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t.html new file mode 100644 index 0000000..6784385 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t.html @@ -0,0 +1,198 @@ + + + +execution::mapping_t::new_thread_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that execution agents are mapped on to new + threads of execution. +

+
struct new_thread_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ new_thread_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The mapping_t::new_thread_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The mapping_t::new_thread_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The mapping_t::new_thread_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_applicable_property_v.html new file mode 100644 index 0000000..696ea56 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::mapping_t::new_thread_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::new_thread_t property applies + to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_preferable.html new file mode 100644 index 0000000..18305f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::new_thread_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::new_thread_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_requirable.html new file mode 100644 index 0000000..0f0b724 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::new_thread_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::new_thread_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/new_thread_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/new_thread_t.html new file mode 100644 index 0000000..246e2a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/new_thread_t.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::new_thread_t::new_thread_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr new_thread_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..9834b9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::mapping_t::new_thread_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef mapping_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/value.html new file mode 100644 index 0000000..922ccf3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__new_thread_t/value.html @@ -0,0 +1,50 @@ + + + +execution::mapping_t::new_thread_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr mapping_t value();
+
+
+ + Return + Value +
+

+ new_thread_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t.html new file mode 100644 index 0000000..5d136dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t.html @@ -0,0 +1,197 @@ + + + +execution::mapping_t::other_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that the mapping of execution agents is implementation-defined. +

+
struct other_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The mapping_t::other_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The mapping_t::other_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The mapping_t::other_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_applicable_property_v.html new file mode 100644 index 0000000..13b6803 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_applicable_property_v.html @@ -0,0 +1,43 @@ + + + +execution::mapping_t::other_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::other_t property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_preferable.html new file mode 100644 index 0000000..66a375c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::other_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::other_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_requirable.html new file mode 100644 index 0000000..82a8e32 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::other_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::other_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/other_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/other_t.html new file mode 100644 index 0000000..749feb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/other_t.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::other_t::other_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr other_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..253bda2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::mapping_t::other_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef mapping_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/value.html new file mode 100644 index 0000000..27b8c44 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__other_t/value.html @@ -0,0 +1,50 @@ + + + +execution::mapping_t::other_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr mapping_t value();
+
+
+ + Return + Value +
+

+ other_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t.html new file mode 100644 index 0000000..bf8cd29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t.html @@ -0,0 +1,198 @@ + + + +execution::mapping_t::thread_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that execution agents are mapped on to threads + of execution. +

+
struct thread_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ thread_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The mapping_t::thread_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The mapping_t::thread_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The mapping_t::thread_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_applicable_property_v.html new file mode 100644 index 0000000..0636114 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_applicable_property_v.html @@ -0,0 +1,43 @@ + + + +execution::mapping_t::thread_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::thread_t property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_preferable.html new file mode 100644 index 0000000..91d1495 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::thread_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::thread_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_requirable.html new file mode 100644 index 0000000..1de699a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::thread_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::mapping_t::thread_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..422ab29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::mapping_t::thread_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef mapping_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/mapping.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/thread_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/thread_t.html new file mode 100644 index 0000000..65c8a6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/thread_t.html @@ -0,0 +1,42 @@ + + + +execution::mapping_t::thread_t::thread_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr thread_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/value.html new file mode 100644 index 0000000..1d45bd0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__mapping_t__thread_t/value.html @@ -0,0 +1,50 @@ + + + +execution::mapping_t::thread_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr mapping_t value();
+
+
+ + Return + Value +
+

+ thread_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy.html b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy.html new file mode 100644 index 0000000..27eb675 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy.html @@ -0,0 +1,53 @@ + + + +execution::occupancy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::occupancy_t property. +

+
constexpr occupancy_t occupancy;
+
+
+ + Requirements +
+

+ Header: asio/execution/occupancy.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t.html new file mode 100644 index 0000000..23ac628 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t.html @@ -0,0 +1,149 @@ + + + +execution::occupancy_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property that gives an estimate of the number of execution agents that + should occupy the associated execution context. +

+
struct occupancy_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The occupancy_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The occupancy_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The occupancy_t property cannot be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/occupancy.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_applicable_property_v.html new file mode 100644 index 0000000..fb4dd4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::occupancy_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::occupancy_t + property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_preferable.html new file mode 100644 index 0000000..43ba8fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::occupancy_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::occupancy_t + property cannot be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_requirable.html new file mode 100644 index 0000000..7f4cb2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::occupancy_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::occupancy_t + property cannot be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..0675c3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__occupancy_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::occupancy_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef std::size_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/occupancy.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work.html new file mode 100644 index 0000000..d23f54a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work.html @@ -0,0 +1,53 @@ + + + +execution::outstanding_work + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::outstanding_work_t property. +

+
constexpr outstanding_work_t outstanding_work;
+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t.html new file mode 100644 index 0000000..c8cd69c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t.html @@ -0,0 +1,286 @@ + + + +execution::outstanding_work_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property to describe whether task submission is likely in the future. +

+
struct outstanding_work_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ tracked_t +

+ 		+

+ A sub-property that indicates that the executor represents likely + future submission of a function object. +

+
+

+ untracked_t +

+ 		+

+ A sub-property that indicates that the executor does not represent + likely future submission of a function object. +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ outstanding_work_t [constructor] +

+ 		+

+ Default constructor.
—
Construct from a sub-property + value. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The outstanding_work_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The top-level outstanding_work_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The top-level outstanding_work_t property cannot be required. +

+
+

+ tracked [static] +

+ 		+

+ A special value used for accessing the outstanding_work_t::tracked_t + property. +

+
+

+ untracked [static] +

+ 		+

+ A special value used for accessing the outstanding_work_t::untracked_t + property. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare property values for inequality. +

+
+

+ operator== +

+ 		+

+ Compare property values for equality. +

+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_applicable_property_v.html new file mode 100644 index 0000000..3b49998 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::outstanding_work_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::outstanding_work_t property applies + to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_preferable.html new file mode 100644 index 0000000..4e83e7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::outstanding_work_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::outstanding_work_t property cannot + be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_requirable.html new file mode 100644 index 0000000..7576248 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::outstanding_work_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::outstanding_work_t property cannot + be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/operator_eq__eq_.html new file mode 100644 index 0000000..da75370 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +execution::outstanding_work_t::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for equality. +

+
constexpr bool operator==(
+    const outstanding_work_t & a,
+    const outstanding_work_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/operator_not__eq_.html new file mode 100644 index 0000000..347e53e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +execution::outstanding_work_t::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for inequality. +

+
constexpr bool operator!=(
+    const outstanding_work_t & a,
+    const outstanding_work_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t.html new file mode 100644 index 0000000..e1389cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t.html @@ -0,0 +1,54 @@ + + + +execution::outstanding_work_t::outstanding_work_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr outstanding_work_t();
+  » more...
+
+

+ Construct from a sub-property value. +

+
constexpr outstanding_work_t(
+    untracked_t );
+  » more...
+
+constexpr outstanding_work_t(
+    tracked_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload1.html new file mode 100644 index 0000000..871a4d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload1.html @@ -0,0 +1,41 @@ + + + +execution::outstanding_work_t::outstanding_work_t (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr outstanding_work_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload2.html new file mode 100644 index 0000000..cf78c45 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload2.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::outstanding_work_t (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr outstanding_work_t(
+    untracked_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload3.html new file mode 100644 index 0000000..45e0d0a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/outstanding_work_t/overload3.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::outstanding_work_t (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr outstanding_work_t(
+    tracked_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..b742430 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::outstanding_work_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef outstanding_work_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/tracked.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/tracked.html new file mode 100644 index 0000000..63769e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/tracked.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::tracked + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::outstanding_work_t::tracked_t property. +

+
static constexpr tracked_t tracked;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/untracked.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/untracked.html new file mode 100644 index 0000000..acfdb43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t/untracked.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::untracked + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::outstanding_work_t::untracked_t property. +

+
static constexpr untracked_t untracked;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t.html new file mode 100644 index 0000000..2878b8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t.html @@ -0,0 +1,198 @@ + + + +execution::outstanding_work_t::tracked_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that the executor represents likely future + submission of a function object. +

+
struct tracked_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ tracked_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The outstanding_work_t::untracked_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The outstanding_work_t::tracked_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The outstanding_work_t::tracked_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_applicable_property_v.html new file mode 100644 index 0000000..76bfcd8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::outstanding_work_t::tracked_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::outstanding_work_t::untracked_t property applies to + executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_preferable.html new file mode 100644 index 0000000..c637329 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::tracked_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::outstanding_work_t::tracked_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_requirable.html new file mode 100644 index 0000000..1cfcc6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::tracked_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::outstanding_work_t::tracked_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..8da5673 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::outstanding_work_t::tracked_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef outstanding_work_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/tracked_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/tracked_t.html new file mode 100644 index 0000000..4460cda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/tracked_t.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::tracked_t::tracked_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr tracked_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/value.html new file mode 100644 index 0000000..e403381 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__tracked_t/value.html @@ -0,0 +1,50 @@ + + + +execution::outstanding_work_t::tracked_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr outstanding_work_t value();
+
+
+ + Return + Value +
+

+ tracked_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t.html new file mode 100644 index 0000000..4c25238 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t.html @@ -0,0 +1,198 @@ + + + +execution::outstanding_work_t::untracked_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that the executor does not represent likely + future submission of a function object. +

+
struct untracked_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ untracked_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The outstanding_work_t::untracked_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The outstanding_work_t::untracked_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The outstanding_work_t::untracked_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_applicable_property_v.html new file mode 100644 index 0000000..99e8ec4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::outstanding_work_t::untracked_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::outstanding_work_t::untracked_t property applies to + executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_preferable.html new file mode 100644 index 0000000..7e7948b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::untracked_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::outstanding_work_t::untracked_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_requirable.html new file mode 100644 index 0000000..00aa0aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::untracked_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::outstanding_work_t::untracked_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..f9bee00 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::outstanding_work_t::untracked_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef outstanding_work_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/outstanding_work.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/untracked_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/untracked_t.html new file mode 100644 index 0000000..562dbf1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/untracked_t.html @@ -0,0 +1,42 @@ + + + +execution::outstanding_work_t::untracked_t::untracked_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr untracked_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/value.html new file mode 100644 index 0000000..9ec2b88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__outstanding_work_t__untracked_t/value.html @@ -0,0 +1,50 @@ + + + +execution::outstanding_work_t::untracked_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr outstanding_work_t value();
+
+
+ + Return + Value +
+

+ untracked_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only.html b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only.html new file mode 100644 index 0000000..7883c18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only.html @@ -0,0 +1,153 @@ + + + +execution::prefer_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property adapter that is used with the polymorphic executor wrapper to + mark properties as preferable, but not requirable. +

+
template<
+    typename Property>
+struct prefer_only
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The prefer_only adapter applies to the same types as the nested + property. +

+
+

+ is_preferable [static] +

+ 		+

+ The context_t property can be preferred, it the underlying property + can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The context_t property cannot be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/prefer_only.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_applicable_property_v.html new file mode 100644 index 0000000..e149980 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_applicable_property_v.html @@ -0,0 +1,45 @@ + + + +execution::prefer_only::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::prefer_only + adapter applies to the same types as the nested property. +

+
template <typename T>
+static constexpr bool is_applicable_property_v =
+  is_applicable_property<T, Property>::value;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_preferable.html new file mode 100644 index 0000000..8390278 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_preferable.html @@ -0,0 +1,47 @@ + + + +execution::prefer_only::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_t + property can be preferred, it the underlying property can be preferred. +

+
static constexpr bool is_preferable = automatically_determined;
+
+

+ true if Property::is_preferable + is true, otherwise false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_requirable.html new file mode 100644 index 0000000..9e63668 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::prefer_only::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::context_t + property cannot be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/polymorphic_query_result_type.html new file mode 100644 index 0000000..9936a31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__prefer_only/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::prefer_only::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef Property::polymorphic_query_result_type polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/prefer_only.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship.html new file mode 100644 index 0000000..0c76d88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship.html @@ -0,0 +1,53 @@ + + + +execution::relationship + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used for accessing the execution::relationship_t property. +

+
constexpr relationship_t relationship;
+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t.html new file mode 100644 index 0000000..67e2709 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t.html @@ -0,0 +1,285 @@ + + + +execution::relationship_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A property to describe whether submitted tasks represent continuations of + the calling context. +

+
struct relationship_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ continuation_t +

+ 		+

+ A sub-property that indicates that the executor represents a continuation + of the calling context. +

+
+

+ fork_t +

+ 		+

+ A sub-property that indicates that the executor does not represent + a continuation of the calling context. +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ relationship_t [constructor] +

+ 		+

+ Default constructor.
—
Construct from a sub-property + value. +

+
+
+ + Data Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ continuation [static] +

+ 		+

+ A special value used for accessing the relationship_t::continuation_t + property. +

+
+

+ fork [static] +

+ 		+

+ A special value used for accessing the relationship_t::fork_t property. +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The relationship_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The top-level relationship_t property cannot be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The top-level relationship_t property cannot be required. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare property values for inequality. +

+
+

+ operator== +

+ 		+

+ Compare property values for equality. +

+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/continuation.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/continuation.html new file mode 100644 index 0000000..548a3ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/continuation.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::continuation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::relationship_t::continuation_t property. +

+
static constexpr continuation_t continuation;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/fork.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/fork.html new file mode 100644 index 0000000..3f7560c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/fork.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::fork + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + special value used for accessing the execution::relationship_t::fork_t property. +

+
static constexpr fork_t fork;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_applicable_property_v.html new file mode 100644 index 0000000..9616780 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::relationship_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::relationship_t property applies + to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_preferable.html new file mode 100644 index 0000000..f97b015 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::relationship_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::relationship_t property cannot + be preferred. +

+
static constexpr bool is_preferable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_requirable.html new file mode 100644 index 0000000..d3ce9a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::relationship_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + top-level execution::relationship_t property cannot + be required. +

+
static constexpr bool is_requirable = false;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/operator_eq__eq_.html new file mode 100644 index 0000000..4e19df9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +execution::relationship_t::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for equality. +

+
constexpr bool operator==(
+    const relationship_t & a,
+    const relationship_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/operator_not__eq_.html new file mode 100644 index 0000000..4f556cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +execution::relationship_t::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + property values for inequality. +

+
constexpr bool operator!=(
+    const relationship_t & a,
+    const relationship_t & b);
+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..0d3cc31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::relationship_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef relationship_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t.html new file mode 100644 index 0000000..3819e62 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t.html @@ -0,0 +1,54 @@ + + + +execution::relationship_t::relationship_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr relationship_t();
+  » more...
+
+

+ Construct from a sub-property value. +

+
constexpr relationship_t(
+    fork_t );
+  » more...
+
+constexpr relationship_t(
+    continuation_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload1.html new file mode 100644 index 0000000..699cc02 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload1.html @@ -0,0 +1,41 @@ + + + +execution::relationship_t::relationship_t (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr relationship_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload2.html new file mode 100644 index 0000000..dd6e815 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload2.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::relationship_t (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr relationship_t(
+    fork_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload3.html new file mode 100644 index 0000000..247d894 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t/relationship_t/overload3.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::relationship_t (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from a sub-property value. +

+
constexpr relationship_t(
+    continuation_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t.html new file mode 100644 index 0000000..7c25b06 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t.html @@ -0,0 +1,198 @@ + + + +execution::relationship_t::continuation_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that the executor represents a continuation + of the calling context. +

+
struct continuation_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ continuation_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The relationship_t::continuation_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The relationship_t::continuation_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The relationship_t::continuation_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/continuation_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/continuation_t.html new file mode 100644 index 0000000..5f67fc9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/continuation_t.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::continuation_t::continuation_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr continuation_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_applicable_property_v.html new file mode 100644 index 0000000..21595e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_applicable_property_v.html @@ -0,0 +1,44 @@ + + + +execution::relationship_t::continuation_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::relationship_t::continuation_t property applies + to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_preferable.html new file mode 100644 index 0000000..03a8738 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_preferable.html @@ -0,0 +1,43 @@ + + + +execution::relationship_t::continuation_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::relationship_t::continuation_t property can be + preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_requirable.html new file mode 100644 index 0000000..8e6394f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/is_requirable.html @@ -0,0 +1,43 @@ + + + +execution::relationship_t::continuation_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::relationship_t::continuation_t property can be + required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..4a97e4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::relationship_t::continuation_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef relationship_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/value.html new file mode 100644 index 0000000..298fd55 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__continuation_t/value.html @@ -0,0 +1,50 @@ + + + +execution::relationship_t::continuation_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr relationship_t value();
+
+
+ + Return + Value +
+

+ continuation_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t.html new file mode 100644 index 0000000..7f9e30d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t.html @@ -0,0 +1,198 @@ + + + +execution::relationship_t::fork_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A sub-property that indicates that the executor does not represent a continuation + of the calling context. +

+
struct fork_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ polymorphic_query_result_type +

+ 		+

+ The type returned by queries against an any_executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ fork_t [constructor] +

+ 		+

+ Default constructor. +

+
+

+ value [static] +

+ 		+

+ Get the value associated with a property object. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_applicable_property_v [static] +

+ 		+

+ The relationship_t::fork_t property applies to executors. +

+
+

+ is_preferable [static] +

+ 		+

+ The relationship_t::fork_t property can be preferred. +

+
+

+ is_requirable [static] +

+ 		+

+ The relationship_t::fork_t property can be required. +

+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/fork_t.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/fork_t.html new file mode 100644 index 0000000..2da064c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/fork_t.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::fork_t::fork_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr fork_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_applicable_property_v.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_applicable_property_v.html new file mode 100644 index 0000000..d51d87d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_applicable_property_v.html @@ -0,0 +1,43 @@ + + + +execution::relationship_t::fork_t::is_applicable_property_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::relationship_t::fork_t property applies to executors. +

+
template <typename T>
+static constexpr bool is_applicable_property_v = is_executor_v<T>;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_preferable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_preferable.html new file mode 100644 index 0000000..ed532cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_preferable.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::fork_t::is_preferable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::relationship_t::fork_t property can be preferred. +

+
static constexpr bool is_preferable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_requirable.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_requirable.html new file mode 100644 index 0000000..56d1a2d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/is_requirable.html @@ -0,0 +1,42 @@ + + + +execution::relationship_t::fork_t::is_requirable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + execution::relationship_t::fork_t property can be required. +

+
static constexpr bool is_requirable = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/polymorphic_query_result_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/polymorphic_query_result_type.html new file mode 100644 index 0000000..d3df3fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/polymorphic_query_result_type.html @@ -0,0 +1,52 @@ + + + +execution::relationship_t::fork_t::polymorphic_query_result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type returned by queries against an any_executor. +

+
typedef relationship_t polymorphic_query_result_type;
+
+
+ + Requirements +
+

+ Header: asio/execution/relationship.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/value.html b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/value.html new file mode 100644 index 0000000..45a80aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution__relationship_t__fork_t/value.html @@ -0,0 +1,50 @@ + + + +execution::relationship_t::fork_t::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the value associated with a property object. +

+
static constexpr relationship_t value();
+
+
+ + Return + Value +
+

+ fork_t(); +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context.html new file mode 100644 index 0000000..5e61dbc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context.html @@ -0,0 +1,430 @@ + + + +execution_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A context for function object execution. +

+
class execution_context :
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator +

+ 		+
+

+ allocator< void > +

+ 		+
+

+ allocator_impl_base +

+ 		+
+

+ id +

+ 		+

+ Class used to uniquely identify a service. +

+
+

+ service +

+ 		+

+ Base class for all execution context services. +

+
+

+ service_maker +

+ 		+

+ Base class for all execution context service makers. +

+
+

+ fork_event +

+ 		+

+ Fork-related event notifications. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ execution_context [constructor] +

+ 		+

+ Constructor. +

+
+

+ notify_fork +

+ 		+

+ Notify the execution_context of a fork-related event. +

+
+

+ ~execution_context [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ destroy +

+ 		+

+ Destroys all services in the context. +

+
+

+ shutdown +

+ 		+

+ Shuts down all services in the context. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ add_service +

+ 		+

+ (Deprecated: Use make_service().) Add a service object to the execution_context. +

+
+

+ has_service +

+ 		+

+ Determine if an execution_context contains a specified service + type. +

+
+

+ make_service +

+ 		+

+ Creates a service object and adds it to the execution_context. +

+
+

+ use_service +

+ 		+

+ Obtain the service object corresponding to the given type. +

+
+

+ An execution context represents a place where function objects will be executed. + An io_context is an example + of an execution context. +

+
+ + The + execution_context class and services +
+

+ Class execution_context + implements an extensible, type-safe, polymorphic set of services, indexed + by service type. +

+

+ Services exist to manage the resources that are shared across an execution + context. For example, timers may be implemented in terms of a single timer + queue, and this queue would be stored in a service. +

+

+ Access to the services of an execution_context is via three function + templates, use_service(), + add_service() + and has_service(). +

+

+ 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 execution_context, an object of + type Service is created and + added to the execution_context. A C++ program + can check if an execution_context implements a particular + service with the function template has_service<Service>(). +

+

+ Service objects may be explicitly added to an execution_context using the function + template add_service<Service>(). + If the Service is already + present, the service_already_exists exception + is thrown. If the owner of the service is not the same object as the execution_context + parameter, the invalid_service_owner exception + is thrown. +

+

+ Once a service reference is obtained from an execution_context object by calling + use_service(), + that reference remains usable as long as the owning execution_context object exists. +

+

+ All service implementations have execution_context::service as a public base class. + Custom services may be implemented by deriving from this class and then added + to an execution_context + using the facilities described above. +

+
+ + The + execution_context as a base class +
+

+ Class execution_context + may be used only as a base class for concrete execution context types. The + io_context is an example + of such a derived type. +

+

+ On destruction, a class that is derived from execution_context must perform + execution_context::shutdown() + followed by execution_context::destroy(). +

+

+ This destruction sequence 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: +

+
    +
  • + 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. +
    • +
  • + To shut down the whole program, the io_context function stop() is + called to terminate any run() calls as soon as possible. The io_context destructor calls + shutdown() + and destroy() + to destroy all pending handlers, causing all shared_ptr + references to all connection objects to be destroyed. +
    • +
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/_execution_context.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/_execution_context.html new file mode 100644 index 0000000..4959eee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/_execution_context.html @@ -0,0 +1,41 @@ + + + +execution_context::~execution_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~execution_context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/add_service.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/add_service.html new file mode 100644 index 0000000..269261d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/add_service.html @@ -0,0 +1,106 @@ + + + +execution_context::add_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +(Deprecated: + Use make_service().) + Add a service object to the execution_context. +

+
template<
+    typename Service>
+void add_service(
+    execution_context & e,
+    Service * svc);
+
+

+ This function is used to add a service to the execution_context. +

+
+ + Parameters +
+
+

+
+
e
+

+ The execution_context object + that owns the service. +

+
svc
+
+

+ The service object. On success, ownership of the service object is + transferred to the execution_context. When + the execution_context object + is destroyed, it will destroy the service object by performing: +

+
delete static_cast<execution_context::service*>(svc)
+
+
+
+
+
+ + Exceptions +
+
+

+
+
asio::service_already_exists
+

+ Thrown if a service of the given type is already present in the + execution_context. +

+
asio::invalid_service_owner
+

+ Thrown if the service's owning execution_context is not + the execution_context object + specified by the e + parameter. +

+
+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/destroy.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/destroy.html new file mode 100644 index 0000000..4cf51bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/destroy.html @@ -0,0 +1,51 @@ + + + +execution_context::destroy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + all services in the context. +

+
void destroy();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order * of the beginning of service object lifetime, performs + delete static_cast<execution_context::service*>(svc). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context.html new file mode 100644 index 0000000..dc84918 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context.html @@ -0,0 +1,61 @@ + + + +execution_context::execution_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
execution_context();
+  » more...
+
+template<
+    typename Allocator>
+execution_context(
+    allocator_arg_t ,
+    const Allocator & a);
+  » more...
+
+explicit execution_context(
+    const service_maker & initial_services);
+  » more...
+
+template<
+    typename Allocator>
+execution_context(
+    allocator_arg_t ,
+    const Allocator & a,
+    const service_maker & initial_services);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload1.html new file mode 100644 index 0000000..c269e0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload1.html @@ -0,0 +1,41 @@ + + + +execution_context::execution_context (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
execution_context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload2.html new file mode 100644 index 0000000..7de2424 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload2.html @@ -0,0 +1,60 @@ + + + +execution_context::execution_context (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename Allocator>
+execution_context(
+    allocator_arg_t ,
+    const Allocator & a);
+
+
+ + Parameters +
+
+

+
+
a
+

+ An allocator that will be used for allocating objects that are + associated with the context, such as services and internal state + for I/O objects. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload3.html new file mode 100644 index 0000000..73bcc32 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload3.html @@ -0,0 +1,60 @@ + + + +execution_context::execution_context (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
execution_context(
+    const service_maker & initial_services);
+
+

+ Construct with a service maker, to create an initial set of services + that will be installed into the execution context at construction time. +

+
+ + Parameters +
+
+

+
+
initial_services
+

+ Used to create the initial services. The make + function will be called once at the end of execution_context construction. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload4.html new file mode 100644 index 0000000..39b17ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/execution_context/overload4.html @@ -0,0 +1,70 @@ + + + +execution_context::execution_context (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename Allocator>
+execution_context(
+    allocator_arg_t ,
+    const Allocator & a,
+    const service_maker & initial_services);
+
+

+ Construct with a service maker, to create an initial set of services + that will be installed into the execution context at construction time. +

+
+ + Parameters +
+
+

+
+
a
+

+ An allocator that will be used for allocating objects that are + associated with the context, such as services and internal state + for I/O objects. +

+
initial_services
+

+ Used to create the initial services. The make + function will be called once at the end of execution_context construction. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/fork_event.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/fork_event.html new file mode 100644 index 0000000..d340ac8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/fork_event.html @@ -0,0 +1,68 @@ + + + +execution_context::fork_event + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Fork-related + event notifications. +

+
enum fork_event
+
+

+ + + +

+
+ + Values +
+
+

+
+
fork_prepare
+

+ Notify the context that the process is about to fork. +

+
fork_parent
+

+ Notify the context that the process has forked and is the parent. +

+
fork_child
+

+ Notify the context that the process has forked and is the child. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/has_service.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/has_service.html new file mode 100644 index 0000000..de712cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/has_service.html @@ -0,0 +1,83 @@ + + + +execution_context::has_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + if an execution_context + contains a specified service type. +

+
template<
+    typename Service>
+bool has_service(
+    execution_context & e);
+
+

+ This function is used to determine whether the execution_context contains a service + object corresponding to the given service type. +

+
+ + Parameters +
+
+

+
+
e
+

+ The execution_context object + that owns the service. +

+
+
+
+ + Return + Value +
+

+ A boolean indicating whether the execution_context contains the + service. +

+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/make_service.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/make_service.html new file mode 100644 index 0000000..5abcba0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/make_service.html @@ -0,0 +1,92 @@ + + + +execution_context::make_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Creates + a service object and adds it to the execution_context. +

+
template<
+    typename Service,
+    typename... Args>
+Service & make_service(
+    execution_context & e,
+    Args &&... args);
+
+

+ This function is used to add a service to the execution_context. +

+
+ + Parameters +
+
+

+
+
e
+

+ The execution_context object + that owns the service. +

+
args
+

+ Zero or more arguments to be passed to the service constructor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::service_already_exists
+

+ Thrown if a service of the given type is already present in the + execution_context. +

+
+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/notify_fork.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/notify_fork.html new file mode 100644 index 0000000..e699484 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/notify_fork.html @@ -0,0 +1,116 @@ + + + +execution_context::notify_fork + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Notify + the execution_context + of a fork-related event. +

+
void notify_fork(
+    fork_event event);
+
+

+ This function is used to inform the execution_context that the process + is about to fork, or has just forked. This allows the execution_context, 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 execution_context function, or + any function associated with the execution_context's derived class, + 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 execution_context + or its derived class. +

+
+ + Parameters +
+
+

+
+
event
+

+ A fork-related event. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the notification fails the execution_context object + should no longer be used and should be destroyed. +

+
+
+
+ + Example +
+

+ The following code illustrates how to incorporate the notify_fork() function: +

+
my_execution_context.notify_fork(execution_context::fork_prepare);
+if (fork() == 0)
+{
+  // This is the child process.
+  my_execution_context.notify_fork(execution_context::fork_child);
+}
+else
+{
+  // This is the parent process.
+  my_execution_context.notify_fork(execution_context::fork_parent);
+}
+
+
+ + Remarks +
+

+ For each service object svc + in the execution_context + set, performs svc->notify_fork();. + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/shutdown.html new file mode 100644 index 0000000..130f434 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/shutdown.html @@ -0,0 +1,51 @@ + + + +execution_context::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Shuts + down all services in the context. +

+
void shutdown();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order of the beginning of service object lifetime, performs + svc->shutdown(). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service.html new file mode 100644 index 0000000..22e9abc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service.html @@ -0,0 +1,52 @@ + + + +execution_context::use_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the service object corresponding to the given type. +

+
template<
+    typename Service>
+Service & use_service(
+    execution_context & e);
+  » more...
+
+template<
+    typename Service>
+Service & use_service(
+    io_context & ioc);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service/overload1.html new file mode 100644 index 0000000..b8c633c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service/overload1.html @@ -0,0 +1,83 @@ + + + +execution_context::use_service (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain the service object corresponding to the given type. +

+
template<
+    typename Service>
+Service & use_service(
+    execution_context & 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 execution_context will create + a new instance of the service. +

+
+ + Parameters +
+
+

+
+
e
+

+ The execution_context object + that owns the service. +

+
+
+
+ + Return + Value +
+

+ The service interface implementing the specified service type. Ownership + of the service interface is not transferred to the caller. +

+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service/overload2.html new file mode 100644 index 0000000..5305f2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context/use_service/overload2.html @@ -0,0 +1,91 @@ + + + +execution_context::use_service (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain the service object corresponding to the given type. +

+
template<
+    typename Service>
+Service & use_service(
+    io_context & ioc);
+
+

+ 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 io_context will create a new + instance of the service. +

+
+ + Parameters +
+
+

+
+
ioc
+

+ The io_context + object that owns the service. +

+
+
+
+ + Return + Value +
+

+ The service interface implementing the specified service type. Ownership + of the service interface is not transferred to the caller. +

+
+ + Remarks +
+

+ This overload is preserved for backwards compatibility with services + that inherit from io_context::service. +

+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator.html new file mode 100644 index 0000000..0c66e0b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator.html @@ -0,0 +1,187 @@ + + + +execution_context::allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename T>
+class allocator
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind +

+ 		+

+ Rebinds an allocator to another value type. +

+
+

+ value_type +

+ 		+

+ The type of objects that may be allocated by the allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate space for n objects of the allocator's value type. +

+
+

+ allocator [constructor] +

+ 		+

+ Construct an allocator that is associated with an execution context. +
—
Construct from another allocator for a different + value type. +

+
+

+ deallocate +

+ 		+

+ Deallocate space for n objects of the allocator's value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocate.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocate.html new file mode 100644 index 0000000..5844831 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocate.html @@ -0,0 +1,44 @@ + + + +execution_context::allocator::allocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Allocate + space for n objects of + the allocator's value type. +

+
T * allocate(
+    std::size_t n) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator.html new file mode 100644 index 0000000..5feeb2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator.html @@ -0,0 +1,54 @@ + + + +execution_context::allocator::allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an allocator that is associated with an execution context. +

+
explicit constexpr allocator(
+    execution_context & e);
+  » more...
+
+

+ Construct from another allocator + for a different value type. +

+
template<
+    typename U>
+constexpr allocator(
+    const allocator< U > & a);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator/overload1.html new file mode 100644 index 0000000..9baf45b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator/overload1.html @@ -0,0 +1,42 @@ + + + +execution_context::allocator::allocator (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an allocator that is associated with an execution context. +

+
constexpr allocator(
+    execution_context & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator/overload2.html new file mode 100644 index 0000000..8d02bac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/allocator/overload2.html @@ -0,0 +1,45 @@ + + + +execution_context::allocator::allocator (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from another allocator + for a different value type. +

+
template<
+    typename U>
+constexpr allocator(
+    const allocator< U > & a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/deallocate.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/deallocate.html new file mode 100644 index 0000000..c2702b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/deallocate.html @@ -0,0 +1,45 @@ + + + +execution_context::allocator::deallocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Deallocate + space for n objects of + the allocator's value type. +

+
void deallocate(
+    T * p,
+    std::size_t n) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/operator_eq__eq_.html new file mode 100644 index 0000000..cdf9c6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/operator_eq__eq_.html @@ -0,0 +1,43 @@ + + + +execution_context::allocator::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. +

+
constexpr bool operator==(
+    const allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/operator_not__eq_.html new file mode 100644 index 0000000..5683d10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/operator_not__eq_.html @@ -0,0 +1,43 @@ + + + +execution_context::allocator::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. +

+
constexpr bool operator!=(
+    const allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/value_type.html new file mode 100644 index 0000000..ec7f9eb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator/value_type.html @@ -0,0 +1,52 @@ + + + +execution_context::allocator::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of objects that may be allocated by the allocator. +

+
typedef T value_type;
+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator__rebind.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator__rebind.html new file mode 100644 index 0000000..e86a94c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator__rebind.html @@ -0,0 +1,89 @@ + + + +execution_context::allocator::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds an allocator to another value type. +

+
template<
+    typename U>
+struct rebind
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ Specifies the type of the rebound allocator. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator__rebind/other.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator__rebind/other.html new file mode 100644 index 0000000..11477f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator__rebind/other.html @@ -0,0 +1,187 @@ + + + +execution_context::allocator::rebind::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specifies + the type of the rebound allocator. +

+
typedef allocator< U > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind +

+ 		+

+ Rebinds an allocator to another value type. +

+
+

+ value_type +

+ 		+

+ The type of objects that may be allocated by the allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate space for n objects of the allocator's value type. +

+
+

+ allocator [constructor] +

+ 		+

+ Construct an allocator that is associated with an execution context. +
—
Construct from another allocator for a different + value type. +

+
+

+ deallocate +

+ 		+

+ Deallocate space for n objects of the allocator's value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl.html new file mode 100644 index 0000000..458d8b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl.html @@ -0,0 +1,114 @@ + + + +execution_context::allocator_impl + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename Allocator>
+class allocator_impl :
+  public execution_context::allocator_impl_base
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+
+

+ allocator_impl [constructor] +

+ 		+
+

+ deallocate +

+ 		+
+

+ destroy +

+ 		+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/allocate.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/allocate.html new file mode 100644 index 0000000..187734c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/allocate.html @@ -0,0 +1,42 @@ + + + +execution_context::allocator_impl::allocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
virtual void * allocate(
+    std::size_t size,
+    std::size_t align);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/allocator_impl.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/allocator_impl.html new file mode 100644 index 0000000..db1dffc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/allocator_impl.html @@ -0,0 +1,41 @@ + + + +execution_context::allocator_impl::allocator_impl + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
allocator_impl(
+    const Allocator & alloc);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/deallocate.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/deallocate.html new file mode 100644 index 0000000..2df6880 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/deallocate.html @@ -0,0 +1,43 @@ + + + +execution_context::allocator_impl::deallocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
virtual void deallocate(
+    void * ptr,
+    std::size_t size,
+    std::size_t align);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/destroy.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/destroy.html new file mode 100644 index 0000000..5819e8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl/destroy.html @@ -0,0 +1,40 @@ + + + +execution_context::allocator_impl::destroy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
virtual void destroy();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base.html new file mode 100644 index 0000000..ded52f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base.html @@ -0,0 +1,134 @@ + + + +execution_context::allocator_impl_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
class allocator_impl_base
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+
+

+ deallocate +

+ 		+
+

+ destroy +

+ 		+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~allocator_impl_base [destructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/_allocator_impl_base.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/_allocator_impl_base.html new file mode 100644 index 0000000..be4a9f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/_allocator_impl_base.html @@ -0,0 +1,40 @@ + + + +execution_context::allocator_impl_base::~allocator_impl_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
virtual ~allocator_impl_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/allocate.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/allocate.html new file mode 100644 index 0000000..3ae21b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/allocate.html @@ -0,0 +1,42 @@ + + + +execution_context::allocator_impl_base::allocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void * allocate(
+    std::size_t size,
+    std::size_t align);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/deallocate.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/deallocate.html new file mode 100644 index 0000000..96631a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/deallocate.html @@ -0,0 +1,43 @@ + + + +execution_context::allocator_impl_base::deallocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void deallocate(
+    void * ptr,
+    std::size_t size,
+    std::size_t align);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/destroy.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/destroy.html new file mode 100644 index 0000000..ce11a12 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_impl_base/destroy.html @@ -0,0 +1,40 @@ + + + +execution_context::allocator_impl_base::destroy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void destroy();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_.html new file mode 100644 index 0000000..17f362e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_.html @@ -0,0 +1,163 @@ + + + +execution_context::allocator< void > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+class allocator< void >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator< void >::rebind +

+ 		+

+ Rebinds an allocator to another value type. +

+
+

+ value_type +

+ 		+

+ void as no objects can be allocated through a proto-allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator +

+ 		+

+ Construct an allocator that is associated with an execution context. +
—
Construct from another allocator for a different + value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator.html new file mode 100644 index 0000000..a4d4a74 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator.html @@ -0,0 +1,54 @@ + + + +execution_context::allocator< void >::allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct an allocator that is associated with an execution context. +

+
explicit constexpr allocator(
+    execution_context & e);
+  » more...
+
+

+ Construct from another allocator + for a different value type. +

+
template<
+    typename U>
+constexpr allocator(
+    const allocator< U > & a);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator/overload1.html new file mode 100644 index 0000000..672eaca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator/overload1.html @@ -0,0 +1,42 @@ + + + +execution_context::allocator< void >::allocator (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an allocator that is associated with an execution context. +

+
constexpr allocator(
+    execution_context & e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator/overload2.html new file mode 100644 index 0000000..479bdc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/allocator/overload2.html @@ -0,0 +1,45 @@ + + + +execution_context::allocator< void >::allocator (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from another allocator + for a different value type. +

+
template<
+    typename U>
+constexpr allocator(
+    const allocator< U > & a);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/operator_eq__eq_.html new file mode 100644 index 0000000..278ab86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/operator_eq__eq_.html @@ -0,0 +1,43 @@ + + + +execution_context::allocator< void >::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality operator. +

+
constexpr bool operator==(
+    const allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/operator_not__eq_.html new file mode 100644 index 0000000..9610abc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/operator_not__eq_.html @@ -0,0 +1,43 @@ + + + +execution_context::allocator< void >::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality operator. +

+
constexpr bool operator!=(
+    const allocator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/value_type.html new file mode 100644 index 0000000..ec4fc43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt_/value_type.html @@ -0,0 +1,53 @@ + + + +execution_context::allocator< void >::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +void as no objects + can be allocated through a proto-allocator. +

+
typedef void value_type;
+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt___rebind.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt___rebind.html new file mode 100644 index 0000000..4b934e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt___rebind.html @@ -0,0 +1,89 @@ + + + +execution_context::allocator< void >::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds an allocator to another value type. +

+
template<>
+struct allocator< void >::rebind
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ Specifies the type of the rebound allocator. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt___rebind/other.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt___rebind/other.html new file mode 100644 index 0000000..6241357 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__allocator_lt__void__gt___rebind/other.html @@ -0,0 +1,187 @@ + + + +execution_context::allocator< void >::rebind::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specifies the type of the rebound allocator. +

+
typedef allocator< U > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind +

+ 		+

+ Rebinds an allocator to another value type. +

+
+

+ value_type +

+ 		+

+ The type of objects that may be allocated by the allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate space for n objects of the allocator's value type. +

+
+

+ allocator [constructor] +

+ 		+

+ Construct an allocator that is associated with an execution context. +
—
Construct from another allocator for a different + value type. +

+
+

+ deallocate +

+ 		+

+ Deallocate space for n objects of the allocator's value type. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. +

+
+

+ operator== +

+ 		+

+ Equality operator. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr.html new file mode 100644 index 0000000..34d5b6c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr.html @@ -0,0 +1,114 @@ + + + +execution_context::auto_allocator_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
struct auto_allocator_ptr
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~auto_allocator_ptr [destructor] +

+ 		+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ptr_ +

+ 		+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr/_auto_allocator_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr/_auto_allocator_ptr.html new file mode 100644 index 0000000..2ba4bed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr/_auto_allocator_ptr.html @@ -0,0 +1,40 @@ + + + +execution_context::auto_allocator_ptr::~auto_allocator_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
~auto_allocator_ptr();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr/ptr_.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr/ptr_.html new file mode 100644 index 0000000..7f51e10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__auto_allocator_ptr/ptr_.html @@ -0,0 +1,40 @@ + + + +execution_context::auto_allocator_ptr::ptr_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
allocator_impl_base * ptr_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__id.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__id.html new file mode 100644 index 0000000..26b8ede --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__id.html @@ -0,0 +1,88 @@ + + + +execution_context::id + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Class used to uniquely identify a service. +

+
class id :
+  noncopyable
+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ id [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__id/id.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__id/id.html new file mode 100644 index 0000000..fb6f243 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__id/id.html @@ -0,0 +1,41 @@ + + + +execution_context::id::id + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
id();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service.html new file mode 100644 index 0000000..278222b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service.html @@ -0,0 +1,188 @@ + + + +execution_context::service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Base class for all execution context services. +

+
class service :
+  noncopyable
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ context +

+ 		+

+ Get the context object that owns the service. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ service [constructor] +

+ 		+

+ Constructor. +

+
+

+ ~service [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Private + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ notify_fork +

+ 		+

+ Handle notification of a fork-related event to perform any necessary + housekeeping. +

+
+

+ shutdown +

+ 		+

+ Destroy all user-defined handler objects owned by the service. +

+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/_service.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/_service.html new file mode 100644 index 0000000..b8ee592 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/_service.html @@ -0,0 +1,41 @@ + + + +execution_context::service::~service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
virtual ~service();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/context.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/context.html new file mode 100644 index 0000000..0687050 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/context.html @@ -0,0 +1,42 @@ + + + +execution_context::service::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the context object that owns the service. +

+
execution_context & context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/notify_fork.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/notify_fork.html new file mode 100644 index 0000000..57eeb4d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/notify_fork.html @@ -0,0 +1,47 @@ + + + +execution_context::service::notify_fork + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Handle + notification of a fork-related event to perform any necessary housekeeping. +

+
virtual void notify_fork(
+    execution_context::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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/service.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/service.html new file mode 100644 index 0000000..f20dee5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/service.html @@ -0,0 +1,56 @@ + + + +execution_context::service::service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
service(
+    execution_context & owner);
+
+
+ + Parameters +
+
+

+
+
owner
+

+ The execution_context object + that owns the service. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/shutdown.html new file mode 100644 index 0000000..f3728b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service/shutdown.html @@ -0,0 +1,42 @@ + + + +execution_context::service::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroy + all user-defined handler objects owned by the service. +

+
void shutdown();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker.html new file mode 100644 index 0000000..b0812b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker.html @@ -0,0 +1,128 @@ + + + +execution_context::service_maker + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Base class for all execution context service makers. +

+
class service_maker :
+  noncopyable
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make +

+ 		+

+ Make services to be added to the execution context. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~service_maker [destructor] +

+ 		+

+ Destructor. +

+
+

+ A service maker is called by the execution context to create services that + need to be installed into the execution context at construction time. +

+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker/_service_maker.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker/_service_maker.html new file mode 100644 index 0000000..0a3e2c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker/_service_maker.html @@ -0,0 +1,41 @@ + + + +execution_context::service_maker::~service_maker + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
virtual ~service_maker();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker/make.html b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker/make.html new file mode 100644 index 0000000..595f093 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/execution_context__service_maker/make.html @@ -0,0 +1,43 @@ + + + +execution_context::service_maker::make + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Make + services to be added to the execution context. +

+
void make(
+    execution_context & context) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor.html b/Packages/asio-1.36.0/doc/asio/reference/executor.html new file mode 100644 index 0000000..cdb68bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor.html @@ -0,0 +1,335 @@ + + + +executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Polymorphic wrapper for executors. +

+
class executor
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ unspecified_bool_type_t +

+ 		+
+

+ unspecified_bool_type +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the executor to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the executor to invoke the given function object. +

+
+

+ executor + [constructor] +

+ 		+

+ Default constructor.
—
Construct from nullptr.
+ —
Copy constructor.
—
Move constructor.
+ —
Construct a polymorphic wrapper for the specified executor. +
—
Construct a polymorphic executor that points to the + same target as another polymorphic executor.
—
Construct + a polymorphic executor that moves the target from another polymorphic + executor.
—
Allocator-aware constructor to create a + polymorphic wrapper for the specified executor. +

+
+

+ on_work_finished +

+ 		+

+ Inform the executor that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the executor that it has some outstanding work to do. +

+
+

+ operator unspecified_bool_type +

+ 		+

+ Operator to test if the executor contains a valid target. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
+

+

+
—
Assignment operator for nullptr_t.
—
+ Assignment operator to create a polymorphic wrapper for the specified + executor. +

+
+

+ post +

+ 		+

+ Request the executor to invoke the given function object. +

+
+

+ target +

+ 		+

+ Obtain a pointer to the target executor object. +

+
+

+ target_type +

+ 		+

+ Obtain type information for the target executor object. +

+
+

+ unspecified_bool_true [static] +

+ 		+
+

+ ~executor + [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+
+ + Requirements +
+

+ Header: asio/executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/_executor.html b/Packages/asio-1.36.0/doc/asio/reference/executor/_executor.html new file mode 100644 index 0000000..c75a88f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/_executor.html @@ -0,0 +1,41 @@ + + + +executor::~executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/context.html b/Packages/asio-1.36.0/doc/asio/reference/executor/context.html new file mode 100644 index 0000000..5e08776 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/context.html @@ -0,0 +1,42 @@ + + + +executor::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain the underlying execution + context. +

+
execution_context & context() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/defer.html b/Packages/asio-1.36.0/doc/asio/reference/executor/defer.html new file mode 100644 index 0000000..64cfd28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/defer.html @@ -0,0 +1,76 @@ + + + +executor::defer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the executor to invoke + the given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void defer(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object is executed according to the rules of the target + executor object. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/executor/dispatch.html new file mode 100644 index 0000000..dd5c5e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/dispatch.html @@ -0,0 +1,76 @@ + + + +executor::dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the executor to + invoke the given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void dispatch(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object is executed according to the rules of the target + executor object. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor.html new file mode 100644 index 0000000..9abb494 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor.html @@ -0,0 +1,110 @@ + + + +executor::executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
executor();
+  » more...
+
+

+ Construct from nullptr. +

+
executor(
+    nullptr_t );
+  » more...
+
+

+ Copy constructor. +

+
executor(
+    const executor & other);
+  » more...
+
+

+ Move constructor. +

+
executor(
+    executor && other);
+  » more...
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+executor(
+    Executor e);
+  » more...
+
+

+ Construct a polymorphic executor that points to the same target as another + polymorphic executor. +

+
executor(
+    std::nothrow_t ,
+    const executor & other);
+  » more...
+
+

+ Construct a polymorphic executor that moves the target from another polymorphic + executor. +

+
executor(
+    std::nothrow_t ,
+    executor && other);
+  » more...
+
+template<
+    typename Executor>
+executor(
+    std::nothrow_t ,
+    Executor e);
+  » more...
+
+

+ Allocator-aware constructor to create a polymorphic wrapper for the specified + executor. +

+
template<
+    typename Executor,
+    typename Allocator>
+executor(
+    allocator_arg_t ,
+    const Allocator & a,
+    Executor e);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload1.html new file mode 100644 index 0000000..98c22e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload1.html @@ -0,0 +1,41 @@ + + + +executor::executor (1 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload2.html new file mode 100644 index 0000000..4dbe95c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload2.html @@ -0,0 +1,42 @@ + + + +executor::executor (2 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct from nullptr. +

+
executor(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload3.html new file mode 100644 index 0000000..6ed6ec4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload3.html @@ -0,0 +1,42 @@ + + + +executor::executor (3 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
executor(
+    const executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload4.html new file mode 100644 index 0000000..7539f10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload4.html @@ -0,0 +1,42 @@ + + + +executor::executor (4 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
executor(
+    executor && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload5.html new file mode 100644 index 0000000..eb1f2bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload5.html @@ -0,0 +1,44 @@ + + + +executor::executor (5 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+executor(
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload6.html new file mode 100644 index 0000000..e0f50f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload6.html @@ -0,0 +1,44 @@ + + + +executor::executor (6 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic executor that points to the same target as another + polymorphic executor. +

+
executor(
+    std::nothrow_t ,
+    const executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload7.html new file mode 100644 index 0000000..ab3028c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload7.html @@ -0,0 +1,44 @@ + + + +executor::executor (7 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic executor that moves the target from another polymorphic + executor. +

+
executor(
+    std::nothrow_t ,
+    executor && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload8.html new file mode 100644 index 0000000..7cf1feb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload8.html @@ -0,0 +1,45 @@ + + + +executor::executor (8 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+executor(
+    std::nothrow_t ,
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload9.html new file mode 100644 index 0000000..c874fd2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/executor/overload9.html @@ -0,0 +1,48 @@ + + + +executor::executor (9 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Allocator-aware constructor to create a polymorphic wrapper for the specified + executor. +

+
template<
+    typename Executor,
+    typename Allocator>
+executor(
+    allocator_arg_t ,
+    const Allocator & a,
+    Executor e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/on_work_finished.html b/Packages/asio-1.36.0/doc/asio/reference/executor/on_work_finished.html new file mode 100644 index 0000000..5ec3cf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/on_work_finished.html @@ -0,0 +1,42 @@ + + + +executor::on_work_finished + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the executor that some work is no longer outstanding. +

+
void on_work_finished() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/on_work_started.html b/Packages/asio-1.36.0/doc/asio/reference/executor/on_work_started.html new file mode 100644 index 0000000..02a42c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/on_work_started.html @@ -0,0 +1,42 @@ + + + +executor::on_work_started + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform the + executor that it has some outstanding work to do. +

+
void on_work_started() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_.html new file mode 100644 index 0000000..3c7759c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_.html @@ -0,0 +1,65 @@ + + + +executor::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment operator. +

+
executor & operator=(
+    const executor & other);
+  » more...
+
+
+
+executor & operator=(
+    executor && other);
+  » more...
+
+

+ Assignment operator for nullptr_t. +

+
executor & operator=(
+    nullptr_t );
+  » more...
+
+

+ Assignment operator to create a polymorphic wrapper for the specified executor. +

+
template<
+    typename Executor>
+executor & operator=(
+    Executor && e);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload1.html new file mode 100644 index 0000000..54e999e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +executor::operator= (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
executor & operator=(
+    const executor & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload2.html new file mode 100644 index 0000000..7e1bec2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload2.html @@ -0,0 +1,39 @@ + + + +executor::operator= (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
executor & operator=(
+    executor && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload3.html new file mode 100644 index 0000000..88cda01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload3.html @@ -0,0 +1,42 @@ + + + +executor::operator= (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator for nullptr_t. +

+
executor & operator=(
+    nullptr_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload4.html new file mode 100644 index 0000000..d3d7bba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq_/overload4.html @@ -0,0 +1,45 @@ + + + +executor::operator= (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator to create a polymorphic wrapper for the specified + executor. +

+
template<
+    typename Executor>
+executor & operator=(
+    Executor && e);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq__eq_.html new file mode 100644 index 0000000..e0d997e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +executor::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two executors + for equality. +

+
bool operator==(
+    const executor & a,
+    const executor & b);
+
+
+ + Requirements +
+

+ Header: asio/executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_not__eq_.html new file mode 100644 index 0000000..12b7692 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +executor::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two + executors for inequality. +

+
bool operator!=(
+    const executor & a,
+    const executor & b);
+
+
+ + Requirements +
+

+ Header: asio/executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/operator_unspecified_bool_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_unspecified_bool_type.html new file mode 100644 index 0000000..399a124 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/operator_unspecified_bool_type.html @@ -0,0 +1,43 @@ + + + +executor::operator unspecified_bool_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Operator + to test if the executor contains a valid target. +

+
operator unspecified_bool_type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/post.html b/Packages/asio-1.36.0/doc/asio/reference/executor/post.html new file mode 100644 index 0000000..83f7e2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/post.html @@ -0,0 +1,76 @@ + + + +executor::post + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the executor to invoke + the given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void post(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object is executed according to the rules of the target + executor object. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/target.html b/Packages/asio-1.36.0/doc/asio/reference/executor/target.html new file mode 100644 index 0000000..487917d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/target.html @@ -0,0 +1,50 @@ + + + +executor::target + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain a pointer to the target + executor object. +

+
template<
+    typename Executor>
+Executor * target();
+  » more...
+
+template<
+    typename Executor>
+const Executor * target() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/target/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/executor/target/overload1.html new file mode 100644 index 0000000..463c740 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/target/overload1.html @@ -0,0 +1,53 @@ + + + +executor::target (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a pointer to the target executor object. +

+
template<
+    typename Executor>
+Executor * target();
+
+
+ + Return + Value +
+

+ If target_type() + == typeid(T), a pointer to the stored executor target; + otherwise, a null pointer. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/target/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/executor/target/overload2.html new file mode 100644 index 0000000..9024183 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/target/overload2.html @@ -0,0 +1,53 @@ + + + +executor::target (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a pointer to the target executor object. +

+
template<
+    typename Executor>
+const Executor * target() const;
+
+
+ + Return + Value +
+

+ If target_type() + == typeid(T), a pointer to the stored executor target; + otherwise, a null pointer. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor/target_type.html new file mode 100644 index 0000000..7c07e36 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/target_type.html @@ -0,0 +1,53 @@ + + + +executor::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain type information + for the target executor object. +

+
const std::type_info & target_type() const;
+
+
+ + Return + Value +
+

+ If *this + has a target type of type T, + typeid(T); otherwise, + typeid(void). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/unspecified_bool_true.html b/Packages/asio-1.36.0/doc/asio/reference/executor/unspecified_bool_true.html new file mode 100644 index 0000000..f347946 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/unspecified_bool_true.html @@ -0,0 +1,41 @@ + + + +executor::unspecified_bool_true + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static void unspecified_bool_true(
+    unspecified_bool_type_t );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor/unspecified_bool_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor/unspecified_bool_type.html new file mode 100644 index 0000000..b94901f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor/unspecified_bool_type.html @@ -0,0 +1,50 @@ + + + +executor::unspecified_bool_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef void(* unspecified_bool_type;
+
+
+ + Requirements +
+

+ Header: asio/executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor__unspecified_bool_type_t.html b/Packages/asio-1.36.0/doc/asio/reference/executor__unspecified_bool_type_t.html new file mode 100644 index 0000000..08dce76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor__unspecified_bool_type_t.html @@ -0,0 +1,50 @@ + + + +executor::unspecified_bool_type_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
struct unspecified_bool_type_t
+
+
+ + Requirements +
+

+ Header: asio/executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_arg.html b/Packages/asio-1.36.0/doc/asio/reference/executor_arg.html new file mode 100644 index 0000000..d3564e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_arg.html @@ -0,0 +1,59 @@ + + + +executor_arg + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value, similar to std::nothrow, used to disambiguate constructors + that accept executor arguments. +

+
constexpr executor_arg_t executor_arg;
+
+

+ See executor_arg_t + and uses_executor + for more information. +

+
+ + Requirements +
+

+ Header: asio/uses_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_arg_t.html b/Packages/asio-1.36.0/doc/asio/reference/executor_arg_t.html new file mode 100644 index 0000000..54e0ab3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_arg_t.html @@ -0,0 +1,97 @@ + + + +executor_arg_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special type, similar to std::nothrow_t, used to disambiguate constructors + that accept executor arguments. +

+
struct executor_arg_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_arg_t [constructor] +

+ 		+

+ Constructor. +

+
+

+ The executor_arg_t + struct is an empty structure type used as a unique type to disambiguate constructor + and function overloading. Specifically, some types have constructors with + executor_arg_t + as the first argument, immediately followed by an argument of a type that + satisfies the Executor type requirements. +

+
+ + Requirements +
+

+ Header: asio/uses_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_arg_t/executor_arg_t.html b/Packages/asio-1.36.0/doc/asio/reference/executor_arg_t/executor_arg_t.html new file mode 100644 index 0000000..3795398 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_arg_t/executor_arg_t.html @@ -0,0 +1,41 @@ + + + +executor_arg_t::executor_arg_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
constexpr executor_arg_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder.html new file mode 100644 index 0000000..2250d46 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder.html @@ -0,0 +1,247 @@ + + + +executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A call wrapper type to bind an executor of type Executor + to an object of type T. +

+
template<
+    typename T,
+    typename Executor>
+class executor_binder
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ argument_type +

+ 		+

+ The type of the function's argument. +

+
+

+ executor_type +

+ 		+

+ The type of the associated executor. +

+
+

+ first_argument_type +

+ 		+

+ The type of the function's first argument. +

+
+

+ result_type +

+ 		+

+ The return type if a function. +

+
+

+ second_argument_type +

+ 		+

+ The type of the function's second argument. +

+
+

+ target_type +

+ 		+

+ The type of the target object. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_binder [constructor] +

+ 		+

+ Construct an executor wrapper for the specified object.
+ —
Copy constructor.
—
Construct a copy, but specify + a different executor.
—
Construct a copy of a different + executor wrapper type.
—
Construct a copy of a different + executor wrapper type, but specify a different executor.
+ —
Move constructor.
—
Move construct the target + object, but specify a different executor.
—
Move construct + from a different executor wrapper type.
—
Move construct + from a different executor wrapper type, but specify a different + executor. +

+
+

+ get +

+ 		+

+ Obtain a reference to the target object. +

+
+

+ get_executor +

+ 		+

+ Obtain the associated executor. +

+
+

+ operator() +

+ 		+

+ Forwarding function call operator. +

+
+

+ ~executor_binder [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/_executor_binder.html new file mode 100644 index 0000000..b7ebc66 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/_executor_binder.html @@ -0,0 +1,41 @@ + + + +executor_binder::~executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~executor_binder();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/argument_type.html new file mode 100644 index 0000000..9f4c60c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/argument_type.html @@ -0,0 +1,74 @@ + + + +executor_binder::argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's argument. +

+
typedef see_below argument_type;
+
+

+ The type of argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting a single argument, argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type argument_type, + then argument_type + is a synonym for T::argument_type; +
    • +
  • + otherwise argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder.html new file mode 100644 index 0000000..6c7b990 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder.html @@ -0,0 +1,132 @@ + + + +executor_binder::executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an executor wrapper for the specified object. +

+
template<
+    typename U>
+executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    U && u);
+  » more...
+
+

+ Copy constructor. +

+
executor_binder(
+    const executor_binder & other);
+  » more...
+
+

+ Construct a copy, but specify a different executor. +

+
executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    const executor_binder & other);
+  » more...
+
+

+ Construct a copy of a different executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    const executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Construct a copy of a different executor wrapper type, but specify a different + executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    const executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move constructor. +

+
executor_binder(
+    executor_binder && other);
+  » more...
+
+

+ Move construct the target object, but specify a different executor. +

+
executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    executor_binder && other);
+  » more...
+
+

+ Move construct from a different executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move construct from a different executor wrapper type, but specify a different + executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload1.html new file mode 100644 index 0000000..8908fad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload1.html @@ -0,0 +1,50 @@ + + + +executor_binder::executor_binder (1 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an executor wrapper for the specified object. +

+
template<
+    typename U>
+executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    U && u);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload2.html new file mode 100644 index 0000000..f0d5650 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload2.html @@ -0,0 +1,42 @@ + + + +executor_binder::executor_binder (2 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
executor_binder(
+    const executor_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload3.html new file mode 100644 index 0000000..6a1684e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload3.html @@ -0,0 +1,44 @@ + + + +executor_binder::executor_binder (3 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy, but specify a different executor. +

+
executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    const executor_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload4.html new file mode 100644 index 0000000..fa3eca3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload4.html @@ -0,0 +1,53 @@ + + + +executor_binder::executor_binder (4 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    const executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the Executor + type is constructible from type OtherExecutor, + and the type T is constructible + from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload5.html new file mode 100644 index 0000000..782f03a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload5.html @@ -0,0 +1,53 @@ + + + +executor_binder::executor_binder (5 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different executor wrapper type, but specify a + different executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    const executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload6.html new file mode 100644 index 0000000..640b390 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload6.html @@ -0,0 +1,42 @@ + + + +executor_binder::executor_binder (6 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
executor_binder(
+    executor_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload7.html new file mode 100644 index 0000000..5fa862a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload7.html @@ -0,0 +1,44 @@ + + + +executor_binder::executor_binder (7 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct the target object, but specify a different executor. +

+
executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    executor_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload8.html new file mode 100644 index 0000000..88f3be1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload8.html @@ -0,0 +1,47 @@ + + + +executor_binder::executor_binder (8 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload9.html new file mode 100644 index 0000000..0c36187 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_binder/overload9.html @@ -0,0 +1,49 @@ + + + +executor_binder::executor_binder (9 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different executor wrapper type, but specify a + different executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+executor_binder(
+    executor_arg_t ,
+    const executor_type & e,
+    executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_type.html new file mode 100644 index 0000000..623c4f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/executor_type.html @@ -0,0 +1,52 @@ + + + +executor_binder::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the associated executor. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/first_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/first_argument_type.html new file mode 100644 index 0000000..698271e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/first_argument_type.html @@ -0,0 +1,74 @@ + + + +executor_binder::first_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's first argument. +

+
typedef see_below first_argument_type;
+
+

+ The type of first_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, first_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then first_argument_type + is a synonym for T::first_argument_type; +
    • +
  • + otherwise first_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get.html new file mode 100644 index 0000000..e62faa9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get.html @@ -0,0 +1,46 @@ + + + +executor_binder::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain a reference + to the target object. +

+
target_type & get();
+  » more...
+
+const target_type & get() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get/overload1.html new file mode 100644 index 0000000..b70a8f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get/overload1.html @@ -0,0 +1,41 @@ + + + +executor_binder::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
target_type & get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get/overload2.html new file mode 100644 index 0000000..f1d1fd2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get/overload2.html @@ -0,0 +1,41 @@ + + + +executor_binder::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
const target_type & get() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get_executor.html new file mode 100644 index 0000000..c72b707 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/get_executor.html @@ -0,0 +1,42 @@ + + + +executor_binder::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the associated executor. +

+
executor_type get_executor() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_.html new file mode 100644 index 0000000..585bd47 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_.html @@ -0,0 +1,58 @@ + + + +executor_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwarding + function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..e396b5e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +executor_binder::operator() (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..a2f5c20 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload2.html @@ -0,0 +1,44 @@ + + + +executor_binder::operator() (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload3.html new file mode 100644 index 0000000..560b610 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/operator_lp__rp_/overload3.html @@ -0,0 +1,44 @@ + + + +executor_binder::operator() (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/result_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/result_type.html new file mode 100644 index 0000000..451f9ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/result_type.html @@ -0,0 +1,74 @@ + + + +executor_binder::result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + return type if a function. +

+
typedef see_below result_type;
+
+

+ The type of result_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + function type, result_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type result_type, + then result_type is + a synonym for T::result_type; +
    • +
  • + otherwise result_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/second_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/second_argument_type.html new file mode 100644 index 0000000..c651abb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/second_argument_type.html @@ -0,0 +1,74 @@ + + + +executor_binder::second_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's second argument. +

+
typedef see_below second_argument_type;
+
+

+ The type of second_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, second_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then second_argument_type + is a synonym for T::second_argument_type; +
    • +
  • + otherwise second_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_binder/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/target_type.html new file mode 100644 index 0000000..66cc8ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_binder/target_type.html @@ -0,0 +1,52 @@ + + + +executor_binder::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the target object. +

+
typedef T target_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard.html new file mode 100644 index 0000000..d44afe5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard.html @@ -0,0 +1,176 @@ + + + +executor_work_guard + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An object of type executor_work_guard + controls ownership of outstanding executor work within a scope. +

+
template<
+    typename Executor>
+class executor_work_guard
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+

+ The underlying executor type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_work_guard [constructor] +

+ 		+

+ Constructs a executor_work_guard object for the specified executor. +
—
Copy constructor.
—
Move constructor. +

+
+

+ get_executor +

+ 		+

+ Obtain the associated executor. +

+
+

+ owns_work +

+ 		+

+ Whether the executor_work_guard object owns some outstanding work. +

+
+

+ reset +

+ 		+

+ Indicate that the work is no longer outstanding. +

+
+

+ ~executor_work_guard [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/executor_work_guard.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/_executor_work_guard.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/_executor_work_guard.html new file mode 100644 index 0000000..1d2a742 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/_executor_work_guard.html @@ -0,0 +1,45 @@ + + + +executor_work_guard::~executor_work_guard + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~executor_work_guard();
+
+

+ Unless the object has already been reset, or is in a moved-from state, + calls on_work_finished() on the stored executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_type.html new file mode 100644 index 0000000..505c166 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_type.html @@ -0,0 +1,52 @@ + + + +executor_work_guard::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + underlying executor type. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/executor_work_guard.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard.html new file mode 100644 index 0000000..c1f29a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard.html @@ -0,0 +1,59 @@ + + + +executor_work_guard::executor_work_guard + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructs + a executor_work_guard object + for the specified executor. +

+
explicit executor_work_guard(
+    const executor_type & e);
+  » more...
+
+

+ Copy constructor. +

+
executor_work_guard(
+    const executor_work_guard & other);
+  » more...
+
+

+ Move constructor. +

+
executor_work_guard(
+    executor_work_guard && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload1.html new file mode 100644 index 0000000..a4d580e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload1.html @@ -0,0 +1,47 @@ + + + +executor_work_guard::executor_work_guard (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructs a executor_work_guard + object for the specified executor. +

+
executor_work_guard(
+    const executor_type & e);
+
+

+ Stores a copy of e and + calls on_work_started() on it. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload2.html new file mode 100644 index 0000000..4ec11e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload2.html @@ -0,0 +1,42 @@ + + + +executor_work_guard::executor_work_guard (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
executor_work_guard(
+    const executor_work_guard & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload3.html new file mode 100644 index 0000000..f0623ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/executor_work_guard/overload3.html @@ -0,0 +1,42 @@ + + + +executor_work_guard::executor_work_guard (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
executor_work_guard(
+    executor_work_guard && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/get_executor.html new file mode 100644 index 0000000..9c51fbf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/get_executor.html @@ -0,0 +1,42 @@ + + + +executor_work_guard::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the associated executor. +

+
executor_type get_executor() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/owns_work.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/owns_work.html new file mode 100644 index 0000000..68ca55f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/owns_work.html @@ -0,0 +1,43 @@ + + + +executor_work_guard::owns_work + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Whether + the executor_work_guard + object owns some outstanding work. +

+
bool owns_work() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/reset.html b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/reset.html new file mode 100644 index 0000000..e3dff3c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/executor_work_guard/reset.html @@ -0,0 +1,46 @@ + + + +executor_work_guard::reset + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Indicate + that the work is no longer outstanding. +

+
void reset();
+
+

+ Unless the object has already been reset, or is in a moved-from state, + calls on_work_finished() on the stored executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single.html new file mode 100644 index 0000000..89c9d48 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single.html @@ -0,0 +1,58 @@ + + + +experimental::as_single + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapt a completion + token to specify that the completion handler arguments should be combined + into a single argument. +

+
template<
+    typename CompletionToken>
+constexpr as_single_t< decay_t< CompletionToken > > as_single(
+    CompletionToken && completion_token);
+
+
+ + Requirements +
+

+ Header: asio/experimental/as_single.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t.html new file mode 100644 index 0000000..5f62d3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t.html @@ -0,0 +1,209 @@ + + + +experimental::as_single_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + adapter used to specify that the completion handler arguments should be combined + into a single argument. +

+
template<
+    typename CompletionToken>
+class as_single_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use as_single_t as its default + completion token type. +

+
+

+ default_constructor_tag +

+ 		+

+ Tag type used to prevent the "default" constructor from + being used for conversions. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the as_single_t completion token as the + default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use as_single_t as its + default completion token type. +

+
+

+ as_single_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor. +

+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ token_ +

+ 		+
+

+ The experimental::as_single_t class is used to indicate + that any arguments to the completion handler should be combined and passed + as a single argument. If there is already one argument, that argument is + passed as-is. If there is more than argument, the arguments are first moved + into a std::tuple and that tuple is then passed to + the completion handler. +

+
+ + Requirements +
+

+ Header: asio/experimental/as_single.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_default_on.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_default_on.html new file mode 100644 index 0000000..83923bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_default_on.html @@ -0,0 +1,46 @@ + + + +experimental::as_single_t::as_default_on + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + helper to adapt an I/O object to use as_single_t + as its default completion token type. +

+
template<
+    typename T>
+static decay_t< T >::template rebind_executor< executor_with_default< typenamedecay_t< T >::executor_type > >::other as_default_on(
+    T && object);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_default_on_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_default_on_t.html new file mode 100644 index 0000000..8105a0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_default_on_t.html @@ -0,0 +1,124 @@ + + + +experimental::as_single_t::as_default_on_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + alias to adapt an I/O object to use as_single_t + as its default completion token type. +

+
typedef typename T::template rebind_executor< executor_with_default< typename T::executor_type > >::other as_default_on_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify as_single_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +
—
Convert the specified executor to the inner executor + type, then use that to construct the adapted executor. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/as_single.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t.html new file mode 100644 index 0000000..99e704b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t.html @@ -0,0 +1,54 @@ + + + +experimental::as_single_t::as_single_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr as_single_t(
+    default_constructor_tag  = default_constructor_tag(),
+    CompletionToken token = CompletionToken());
+  » more...
+
+

+ Constructor. +

+
template<
+    typename T>
+explicit constexpr as_single_t(
+    T && completion_token);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t/overload1.html new file mode 100644 index 0000000..e540bdc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t/overload1.html @@ -0,0 +1,49 @@ + + + +experimental::as_single_t::as_single_t (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr as_single_t(
+    default_constructor_tag  = default_constructor_tag(),
+    CompletionToken token = CompletionToken());
+
+

+ This constructor is only valid if the underlying completion token is + default constructible and move constructible. The underlying completion + token is itself defaulted as an argument to allow it to capture a source + location. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t/overload2.html new file mode 100644 index 0000000..de5e427 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/as_single_t/overload2.html @@ -0,0 +1,44 @@ + + + +experimental::as_single_t::as_single_t (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename T>
+constexpr as_single_t(
+    T && completion_token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/token_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/token_.html new file mode 100644 index 0000000..04c489b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t/token_.html @@ -0,0 +1,40 @@ + + + +experimental::as_single_t::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__default_constructor_tag.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__default_constructor_tag.html new file mode 100644 index 0000000..3a44c3f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__default_constructor_tag.html @@ -0,0 +1,54 @@ + + + +experimental::as_single_t::default_constructor_tag + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Tag type used to prevent the "default" constructor from being used + for conversions. +

+
struct default_constructor_tag
+
+
+ + Requirements +
+

+ Header: asio/experimental/as_single.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default.html new file mode 100644 index 0000000..99f6782 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default.html @@ -0,0 +1,128 @@ + + + +experimental::as_single_t::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts an executor to add the as_single_t + completion token as the default. +

+
template<
+    typename InnerExecutor>
+struct executor_with_default :
+  public InnerExecutor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify as_single_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type.
+ —
Convert the specified executor to the inner executor type, + then use that to construct the adapted executor. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/as_single.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/default_completion_token_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/default_completion_token_type.html new file mode 100644 index 0000000..10e21b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/default_completion_token_type.html @@ -0,0 +1,206 @@ + + + +experimental::as_single_t::executor_with_default::default_completion_token_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + as_single_t as the default + completion token type. +

+
typedef as_single_t default_completion_token_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use as_single_t as its default + completion token type. +

+
+

+ default_constructor_tag +

+ 		+

+ Tag type used to prevent the "default" constructor + from being used for conversions. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the as_single_t completion token as + the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use as_single_t as + its default completion token type. +

+
+

+ as_single_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ token_ +

+ 		+
+

+ The experimental::as_single_t class is used to indicate + that any arguments to the completion handler should be combined and passed + as a single argument. If there is already one argument, that argument is + passed as-is. If there is more than argument, the arguments are first moved + into a std::tuple and that tuple is then passed to + the completion handler. +

+
+ + Requirements +
+

+ Header: asio/experimental/as_single.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default.html new file mode 100644 index 0000000..5c433c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default.html @@ -0,0 +1,55 @@ + + + +experimental::as_single_t::executor_with_default::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + the adapted executor from the inner executor type. +

+
executor_with_default(
+    const InnerExecutor & ex);
+  » more...
+
+

+ Convert the specified executor to the inner executor type, then use that + to construct the adapted executor. +

+
template<
+    typename OtherExecutor>
+executor_with_default(
+    const OtherExecutor & ex,
+    constraint_t< is_convertible< OtherExecutor, InnerExecutor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default/overload1.html new file mode 100644 index 0000000..e9270cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default/overload1.html @@ -0,0 +1,42 @@ + + + +experimental::as_single_t::executor_with_default::executor_with_default (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct the adapted executor from the inner executor type. +

+
executor_with_default(
+    const InnerExecutor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default/overload2.html new file mode 100644 index 0000000..ea17d4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__as_single_t__executor_with_default/executor_with_default/overload2.html @@ -0,0 +1,46 @@ + + + +experimental::as_single_t::executor_with_default::executor_with_default (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Convert the specified executor to the inner executor type, then use that + to construct the adapted executor. +

+
template<
+    typename OtherExecutor>
+executor_with_default(
+    const OtherExecutor & ex,
+    constraint_t< is_convertible< OtherExecutor, InnerExecutor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_.html new file mode 100644 index 0000000..fc9ff2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_.html @@ -0,0 +1,100 @@ + + + +experimental::awaitable_operators::operator&& + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wait for both operations to succeed. +

+
template<
+    typename Executor>
+awaitable< void, Executor > operator&&(
+    awaitable< void, Executor > t,
+    awaitable< void, Executor > u);
+  » more...
+
+template<
+    typename U,
+    typename Executor>
+awaitable< U, Executor > operator&&(
+    awaitable< void, Executor > t,
+    awaitable< U, Executor > u);
+  » more...
+
+template<
+    typename T,
+    typename Executor>
+awaitable< T, Executor > operator&&(
+    awaitable< T, Executor > t,
+    awaitable< void, Executor > u);
+  » more...
+
+template<
+    typename T,
+    typename U,
+    typename Executor>
+awaitable< std::tuple< T, U >, Executor > operator&&(
+    awaitable< T, Executor > t,
+    awaitable< U, Executor > u);
+  » more...
+
+template<
+    typename... T,
+    typename Executor>
+awaitable< std::tuple< T..., std::monostate >, Executor > operator&&(
+    awaitable< std::tuple< T... >, Executor > t,
+    awaitable< void, Executor > u);
+  » more...
+
+template<
+    typename... T,
+    typename U,
+    typename Executor>
+awaitable< std::tuple< T..., U >, Executor > operator&&(
+    awaitable< std::tuple< T... >, Executor > t,
+    awaitable< U, Executor > u);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/experimental/awaitable_operators.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload1.html new file mode 100644 index 0000000..5453895 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload1.html @@ -0,0 +1,49 @@ + + + +experimental::awaitable_operators::operator&& (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for both operations to succeed. +

+
template<
+    typename Executor>
+awaitable< void, Executor > operator&&(
+    awaitable< void, Executor > t,
+    awaitable< void, Executor > u);
+
+

+ If one operations fails, the other is cancelled as the AND-condition can + no longer be satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload2.html new file mode 100644 index 0000000..61f9968 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload2.html @@ -0,0 +1,50 @@ + + + +experimental::awaitable_operators::operator&& (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for both operations to succeed. +

+
template<
+    typename U,
+    typename Executor>
+awaitable< U, Executor > operator&&(
+    awaitable< void, Executor > t,
+    awaitable< U, Executor > u);
+
+

+ If one operations fails, the other is cancelled as the AND-condition can + no longer be satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload3.html new file mode 100644 index 0000000..49ab56a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload3.html @@ -0,0 +1,50 @@ + + + +experimental::awaitable_operators::operator&& (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for both operations to succeed. +

+
template<
+    typename T,
+    typename Executor>
+awaitable< T, Executor > operator&&(
+    awaitable< T, Executor > t,
+    awaitable< void, Executor > u);
+
+

+ If one operations fails, the other is cancelled as the AND-condition can + no longer be satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload4.html new file mode 100644 index 0000000..1060a36 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload4.html @@ -0,0 +1,51 @@ + + + +experimental::awaitable_operators::operator&& (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for both operations to succeed. +

+
template<
+    typename T,
+    typename U,
+    typename Executor>
+awaitable< std::tuple< T, U >, Executor > operator&&(
+    awaitable< T, Executor > t,
+    awaitable< U, Executor > u);
+
+

+ If one operations fails, the other is cancelled as the AND-condition can + no longer be satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload5.html new file mode 100644 index 0000000..e5ea13a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload5.html @@ -0,0 +1,50 @@ + + + +experimental::awaitable_operators::operator&& (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for both operations to succeed. +

+
template<
+    typename... T,
+    typename Executor>
+awaitable< std::tuple< T..., std::monostate >, Executor > operator&&(
+    awaitable< std::tuple< T... >, Executor > t,
+    awaitable< void, Executor > u);
+
+

+ If one operations fails, the other is cancelled as the AND-condition can + no longer be satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload6.html new file mode 100644 index 0000000..5d64e43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_amp__amp_/overload6.html @@ -0,0 +1,51 @@ + + + +experimental::awaitable_operators::operator&& (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for both operations to succeed. +

+
template<
+    typename... T,
+    typename U,
+    typename Executor>
+awaitable< std::tuple< T..., U >, Executor > operator&&(
+    awaitable< std::tuple< T... >, Executor > t,
+    awaitable< U, Executor > u);
+
+

+ If one operations fails, the other is cancelled as the AND-condition can + no longer be satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_.html new file mode 100644 index 0000000..ee01e97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_.html @@ -0,0 +1,100 @@ + + + +experimental::awaitable_operators::operator|| + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wait for one operation to succeed. +

+
template<
+    typename Executor>
+awaitable< std::variant< std::monostate, std::monostate >, Executor > operator||(
+    awaitable< void, Executor > t,
+    awaitable< void, Executor > u);
+  » more...
+
+template<
+    typename U,
+    typename Executor>
+awaitable< std::variant< std::monostate, U >, Executor > operator||(
+    awaitable< void, Executor > t,
+    awaitable< U, Executor > u);
+  » more...
+
+template<
+    typename T,
+    typename Executor>
+awaitable< std::variant< T, std::monostate >, Executor > operator||(
+    awaitable< T, Executor > t,
+    awaitable< void, Executor > u);
+  » more...
+
+template<
+    typename T,
+    typename U,
+    typename Executor>
+awaitable< std::variant< T, U >, Executor > operator||(
+    awaitable< T, Executor > t,
+    awaitable< U, Executor > u);
+  » more...
+
+template<
+    typename... T,
+    typename Executor>
+awaitable< std::variant< T..., std::monostate >, Executor > operator||(
+    awaitable< std::variant< T... >, Executor > t,
+    awaitable< void, Executor > u);
+  » more...
+
+template<
+    typename... T,
+    typename U,
+    typename Executor>
+awaitable< std::variant< T..., U >, Executor > operator||(
+    awaitable< std::variant< T... >, Executor > t,
+    awaitable< U, Executor > u);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/experimental/awaitable_operators.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload1.html new file mode 100644 index 0000000..e4a1cf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload1.html @@ -0,0 +1,49 @@ + + + +experimental::awaitable_operators::operator|| (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for one operation to succeed. +

+
template<
+    typename Executor>
+awaitable< std::variant< std::monostate, std::monostate >, Executor > operator||(
+    awaitable< void, Executor > t,
+    awaitable< void, Executor > u);
+
+

+ If one operations succeeds, the other is cancelled as the OR-condition + is already satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload2.html new file mode 100644 index 0000000..f044c79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload2.html @@ -0,0 +1,50 @@ + + + +experimental::awaitable_operators::operator|| (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for one operation to succeed. +

+
template<
+    typename U,
+    typename Executor>
+awaitable< std::variant< std::monostate, U >, Executor > operator||(
+    awaitable< void, Executor > t,
+    awaitable< U, Executor > u);
+
+

+ If one operations succeeds, the other is cancelled as the OR-condition + is already satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload3.html new file mode 100644 index 0000000..dd15b8f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload3.html @@ -0,0 +1,50 @@ + + + +experimental::awaitable_operators::operator|| (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for one operation to succeed. +

+
template<
+    typename T,
+    typename Executor>
+awaitable< std::variant< T, std::monostate >, Executor > operator||(
+    awaitable< T, Executor > t,
+    awaitable< void, Executor > u);
+
+

+ If one operations succeeds, the other is cancelled as the OR-condition + is already satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload4.html new file mode 100644 index 0000000..da4b03d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload4.html @@ -0,0 +1,51 @@ + + + +experimental::awaitable_operators::operator|| (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for one operation to succeed. +

+
template<
+    typename T,
+    typename U,
+    typename Executor>
+awaitable< std::variant< T, U >, Executor > operator||(
+    awaitable< T, Executor > t,
+    awaitable< U, Executor > u);
+
+

+ If one operations succeeds, the other is cancelled as the OR-condition + is already satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload5.html new file mode 100644 index 0000000..f3f9b22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload5.html @@ -0,0 +1,50 @@ + + + +experimental::awaitable_operators::operator|| (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for one operation to succeed. +

+
template<
+    typename... T,
+    typename Executor>
+awaitable< std::variant< T..., std::monostate >, Executor > operator||(
+    awaitable< std::variant< T... >, Executor > t,
+    awaitable< void, Executor > u);
+
+

+ If one operations succeeds, the other is cancelled as the OR-condition + is already satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload6.html new file mode 100644 index 0000000..b9f64c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__awaitable_operators__operator_pipe__pipe_/overload6.html @@ -0,0 +1,51 @@ + + + +experimental::awaitable_operators::operator|| (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for one operation to succeed. +

+
template<
+    typename... T,
+    typename U,
+    typename Executor>
+awaitable< std::variant< T..., U >, Executor > operator||(
+    awaitable< std::variant< T... >, Executor > t,
+    awaitable< U, Executor > u);
+
+

+ If one operations succeeds, the other is cancelled as the OR-condition + is already satisfied. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel.html new file mode 100644 index 0000000..d2e0476 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel.html @@ -0,0 +1,422 @@ + + + +experimental::basic_channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A channel for messages. +

+
template<
+    typename Executor,
+    typename Traits,
+    typename... Signatures>
+class basic_channel
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the channel type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the channel. +

+
+

+ traits_type +

+ 		+

+ The traits type associated with the channel. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_receive +

+ 		+

+ Asynchronously receive a message. +

+
+

+ async_send +

+ 		+

+ Asynchronously send a message. +

+
+

+ basic_channel [constructor] +

+ 		+

+ Construct a basic_channel.
—
Construct and open a basic_channel. +
—
Move-construct a basic_channel from another. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations waiting on the channel. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the channel's buffer. +

+
+

+ close +

+ 		+

+ Close the channel. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the channel is open. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_channel from another. +

+
+

+ ready +

+ 		+

+ Determine whether a message can be received without blocking. +

+
+

+ reset +

+ 		+

+ Reset the channel to its initial state. +

+
+

+ try_receive +

+ 		+

+ Try to receive a message without blocking. +

+
+

+ try_send +

+ 		+

+ Try to send a message without blocking. +

+
+

+ try_send_n +

+ 		+

+ Try to send a number of messages without blocking. +

+
+

+ try_send_n_via_dispatch +

+ 		+

+ Try to send a number of messages without blocking, using dispatch + semantics to call the receive operations' completion handlers. +

+
+

+ try_send_via_dispatch +

+ 		+

+ Try to send a message without blocking, using dispatch semantics + to call the receive operation's completion handler. +

+
+

+ ~basic_channel [destructor] +

+ 		+

+ Destructor. +

+
+

+ The experimental::basic_channel class template is + used for sending messages between different parts of the same application. + A message is defined as a collection of arguments to + be passed to a completion handler, and the set of messages supported by a + channel is specified by its Traits + and Signatures... + template parameters. Messages may be sent and received using asynchronous + or non-blocking synchronous operations. +

+

+ Unless customising the traits, applications will typically use the experimental::channel alias template. For example: +

+
void send_loop(int i, steady_timer& timer,
+    channel<void(error_code, int)>& ch)
+{
+  if (i < 10)
+  {
+    timer.expires_after(chrono::seconds(1));
+    timer.async_wait(
+        [i, &timer, &ch](error_code error)
+        {
+          if (!error)
+          {
+            ch.async_send(error_code(), i,
+                [i, &timer, &ch](error_code error)
+                {
+                  if (!error)
+                  {
+                    send_loop(i + 1, timer, ch);
+                  }
+                });
+          }
+        });
+  }
+  else
+  {
+    ch.close();
+  }
+}
+
+void receive_loop(channel<void(error_code, int)>& ch)
+{
+  ch.async_receive(
+      [&ch](error_code error, int i)
+      {
+        if (!error)
+        {
+          std::cout << "Received " << i << "\n";
+          receive_loop(ch);
+        }
+      });
+}
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ The experimental::basic_channel class template is + not thread-safe, and would typically be used for passing messages between + application code that runs on the same thread or in the same strand. Consider + using experimental::basic_concurrent_channel, and its + alias template experimental::concurrent_channel, + to pass messages between code running in different threads. +

+
+ + Requirements +
+

+ Header: asio/experimental/basic_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/_basic_channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/_basic_channel.html new file mode 100644 index 0000000..4bc8925 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/_basic_channel.html @@ -0,0 +1,41 @@ + + + +experimental::basic_channel::~basic_channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~basic_channel();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/async_receive.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/async_receive.html new file mode 100644 index 0000000..40ea5b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/async_receive.html @@ -0,0 +1,53 @@ + + + +experimental::basic_channel::async_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + receive a message. +

+
template<
+    typename CompletionToken = DEFAULT>
+DEDUCED async_receive(
+    CompletionToken && token = DEFAULT);
+
+
+ + Completion + Signature +
+

+ As determined by the Signatures... template parameter and the channel traits. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/async_send.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/async_send.html new file mode 100644 index 0000000..b5371a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/async_send.html @@ -0,0 +1,54 @@ + + + +experimental::basic_channel::async_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + send a message. +

+
template<
+    typename... Args,
+    typename CompletionToken = DEFAULT>
+DEDUCED async_send(
+    Args &&... args,
+    CompletionToken && token);
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel.html new file mode 100644 index 0000000..8117c80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel.html @@ -0,0 +1,70 @@ + + + +experimental::basic_channel::basic_channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a experimental::basic_channel. +

+
basic_channel(
+    const executor_type & ex,
+    std::size_t max_buffer_size = 0);
+  » more...
+
+

+ Construct and open a experimental::basic_channel. +

+
template<
+    typename ExecutionContext>
+basic_channel(
+    ExecutionContext & context,
+    std::size_t max_buffer_size = 0,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Move-construct a experimental::basic_channel from another. +

+
basic_channel(
+    basic_channel && other);
+  » more...
+
+template<
+    typename Executor1>
+basic_channel(
+    basic_channel< Executor1, Traits, Signatures... > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload1.html new file mode 100644 index 0000000..a0b8054 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload1.html @@ -0,0 +1,64 @@ + + + +experimental::basic_channel::basic_channel (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a experimental::basic_channel. +

+
basic_channel(
+    const executor_type & ex,
+    std::size_t max_buffer_size = 0);
+
+

+ This constructor creates and channel. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the channel will use, by default, to dispatch + handlers for any asynchronous operations performed on the channel. +

+
max_buffer_size
+

+ The maximum number of messages that may be buffered in the channel. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload2.html new file mode 100644 index 0000000..5c8d241 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload2.html @@ -0,0 +1,68 @@ + + + +experimental::basic_channel::basic_channel (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a experimental::basic_channel. +

+
template<
+    typename ExecutionContext>
+basic_channel(
+    ExecutionContext & context,
+    std::size_t max_buffer_size = 0,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates and opens a channel. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the channel + will use, by default, to dispatch handlers for any asynchronous + operations performed on the channel. +

+
max_buffer_size
+

+ The maximum number of messages that may be buffered in the channel. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload3.html new file mode 100644 index 0000000..8c46099 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload3.html @@ -0,0 +1,68 @@ + + + +experimental::basic_channel::basic_channel (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a experimental::basic_channel from another. +

+
basic_channel(
+    basic_channel && other);
+
+

+ This constructor moves a channel from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_channel object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload4.html new file mode 100644 index 0000000..84d5547 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/basic_channel/overload4.html @@ -0,0 +1,71 @@ + + + +experimental::basic_channel::basic_channel (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a experimental::basic_channel from another. +

+
template<
+    typename Executor1>
+basic_channel(
+    basic_channel< Executor1, Traits, Signatures... > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a channel from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_channel object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/cancel.html new file mode 100644 index 0000000..04232e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/cancel.html @@ -0,0 +1,46 @@ + + + +experimental::basic_channel::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations waiting on the channel. +

+
void cancel();
+
+

+ All outstanding send operations will complete with the error asio::experimental::error::channel_cancelled. Outstanding receive + operations complete with the result as determined by the channel traits. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/capacity.html new file mode 100644 index 0000000..6f7268e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/capacity.html @@ -0,0 +1,42 @@ + + + +experimental::basic_channel::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the capacity of the channel's buffer. +

+
std::size_t capacity();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/close.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/close.html new file mode 100644 index 0000000..6ea2bf7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/close.html @@ -0,0 +1,42 @@ + + + +experimental::basic_channel::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the channel. +

+
void close();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/executor_type.html new file mode 100644 index 0000000..324326e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/executor_type.html @@ -0,0 +1,52 @@ + + + +experimental::basic_channel::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the channel. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/basic_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/get_executor.html new file mode 100644 index 0000000..ea3ef30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/get_executor.html @@ -0,0 +1,42 @@ + + + +experimental::basic_channel::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/is_open.html new file mode 100644 index 0000000..c446736 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/is_open.html @@ -0,0 +1,42 @@ + + + +experimental::basic_channel::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the channel is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_.html new file mode 100644 index 0000000..166ceb6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_.html @@ -0,0 +1,50 @@ + + + +experimental::basic_channel::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a experimental::basic_channel from another. +

+
basic_channel & operator=(
+    basic_channel && other);
+  » more...
+
+template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_channel & > operator=(
+    basic_channel< Executor1, Traits, Signatures... > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_/overload1.html new file mode 100644 index 0000000..ff80626 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_/overload1.html @@ -0,0 +1,70 @@ + + + +experimental::basic_channel::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a experimental::basic_channel from another. +

+
basic_channel & operator=(
+    basic_channel && other);
+
+

+ This assignment operator moves a channel from one object to another. + Cancels any outstanding asynchronous operations associated with the target + object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_channel object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_/overload2.html new file mode 100644 index 0000000..61afb0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +experimental::basic_channel::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a experimental::basic_channel from another. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_channel & > operator=(
+    basic_channel< Executor1, Traits, Signatures... > && other);
+
+

+ This assignment operator moves a channel from one object to another. + Cancels any outstanding asynchronous operations associated with the target + object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_channel object from + which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/ready.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/ready.html new file mode 100644 index 0000000..82649ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/ready.html @@ -0,0 +1,42 @@ + + + +experimental::basic_channel::ready + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether a message can be received without blocking. +

+
bool ready() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/reset.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/reset.html new file mode 100644 index 0000000..66e55ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/reset.html @@ -0,0 +1,42 @@ + + + +experimental::basic_channel::reset + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Reset + the channel to its initial state. +

+
void reset();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/traits_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/traits_type.html new file mode 100644 index 0000000..bd11456 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/traits_type.html @@ -0,0 +1,52 @@ + + + +experimental::basic_channel::traits_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + traits type associated with the channel. +

+
typedef Traits::template rebind< Signatures... >::other traits_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/basic_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_receive.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_receive.html new file mode 100644 index 0000000..a04e122 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_receive.html @@ -0,0 +1,56 @@ + + + +experimental::basic_channel::try_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to receive a message without blocking. +

+
template<
+    typename Handler>
+bool try_receive(
+    Handler && handler);
+
+

+ Fails if the buffer is full and there are no waiting receive operations. +

+
+ + Return + Value +
+

+ true on success, false on failure. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send.html new file mode 100644 index 0000000..ca3adb2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send.html @@ -0,0 +1,56 @@ + + + +experimental::basic_channel::try_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a message without blocking. +

+
template<
+    typename... Args>
+bool try_send(
+    Args &&... args);
+
+

+ Fails if the buffer is full and there are no waiting receive operations. +

+
+ + Return + Value +
+

+ true on success, false on failure. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_n.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_n.html new file mode 100644 index 0000000..4fd0d89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_n.html @@ -0,0 +1,54 @@ + + + +experimental::basic_channel::try_send_n + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a number of messages without blocking. +

+
template<
+    typename... Args>
+std::size_t try_send_n(
+    std::size_t count,
+    Args &&... args);
+
+
+ + Return + Value +
+

+ The number of messages that were sent. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_n_via_dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_n_via_dispatch.html new file mode 100644 index 0000000..e485a30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_n_via_dispatch.html @@ -0,0 +1,59 @@ + + + +experimental::basic_channel::try_send_n_via_dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a number of messages without blocking, using dispatch semantics + to call the receive operations' completion handlers. +

+
template<
+    typename... Args>
+std::size_t try_send_n_via_dispatch(
+    std::size_t count,
+    Args &&... args);
+
+

+ The receive operations' completion handlers may be called from inside this + function. +

+
+ + Return + Value +
+

+ The number of messages that were sent. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_via_dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_via_dispatch.html new file mode 100644 index 0000000..2b45ad3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel/try_send_via_dispatch.html @@ -0,0 +1,61 @@ + + + +experimental::basic_channel::try_send_via_dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a message without blocking, using dispatch semantics to call the + receive operation's completion handler. +

+
template<
+    typename... Args>
+bool try_send_via_dispatch(
+    Args &&... args);
+
+

+ Fails if the buffer is full and there are no waiting receive operations. +

+

+ The receive operation's completion handler may be called from inside this + function. +

+
+ + Return + Value +
+

+ true on success, false on failure. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel__rebind_executor.html new file mode 100644 index 0000000..f8bbbb7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel__rebind_executor.html @@ -0,0 +1,89 @@ + + + +experimental::basic_channel::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the channel type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The channel type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/basic_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel__rebind_executor/other.html new file mode 100644 index 0000000..569c98e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_channel__rebind_executor/other.html @@ -0,0 +1,418 @@ + + + +experimental::basic_channel::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + channel type when rebound to the specified executor. +

+
typedef basic_channel< Executor1, Traits, Signatures... > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the channel type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the channel. +

+
+

+ traits_type +

+ 		+

+ The traits type associated with the channel. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_receive +

+ 		+

+ Asynchronously receive a message. +

+
+

+ async_send +

+ 		+

+ Asynchronously send a message. +

+
+

+ basic_channel [constructor] +

+ 		+

+ Construct a basic_channel.
—
Construct and open a + basic_channel.
—
Move-construct a basic_channel from + another. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations waiting on the channel. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the channel's buffer. +

+
+

+ close +

+ 		+

+ Close the channel. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the channel is open. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_channel from another. +

+
+

+ ready +

+ 		+

+ Determine whether a message can be received without blocking. +

+
+

+ reset +

+ 		+

+ Reset the channel to its initial state. +

+
+

+ try_receive +

+ 		+

+ Try to receive a message without blocking. +

+
+

+ try_send +

+ 		+

+ Try to send a message without blocking. +

+
+

+ try_send_n +

+ 		+

+ Try to send a number of messages without blocking. +

+
+

+ try_send_n_via_dispatch +

+ 		+

+ Try to send a number of messages without blocking, using dispatch + semantics to call the receive operations' completion handlers. +

+
+

+ try_send_via_dispatch +

+ 		+

+ Try to send a message without blocking, using dispatch semantics + to call the receive operation's completion handler. +

+
+

+ ~basic_channel [destructor] +

+ 		+

+ Destructor. +

+
+

+ The experimental::basic_channel class template is + used for sending messages between different parts of the same application. + A message is defined as a collection of arguments + to be passed to a completion handler, and the set of messages supported + by a channel is specified by its Traits + and Signatures... + template parameters. Messages may be sent and received using asynchronous + or non-blocking synchronous operations. +

+

+ Unless customising the traits, applications will typically use the experimental::channel alias template. For example: +

+
void send_loop(int i, steady_timer& timer,
+    channel<void(error_code, int)>& ch)
+{
+  if (i < 10)
+  {
+    timer.expires_after(chrono::seconds(1));
+    timer.async_wait(
+        [i, &timer, &ch](error_code error)
+        {
+          if (!error)
+          {
+            ch.async_send(error_code(), i,
+                [i, &timer, &ch](error_code error)
+                {
+                  if (!error)
+                  {
+                    send_loop(i + 1, timer, ch);
+                  }
+                });
+          }
+        });
+  }
+  else
+  {
+    ch.close();
+  }
+}
+
+void receive_loop(channel<void(error_code, int)>& ch)
+{
+  ch.async_receive(
+      [&ch](error_code error, int i)
+      {
+        if (!error)
+        {
+          std::cout << "Received " << i << "\n";
+          receive_loop(ch);
+        }
+      });
+}
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ The experimental::basic_channel class template is + not thread-safe, and would typically be used for passing messages between + application code that runs on the same thread or in the same strand. Consider + using experimental::basic_concurrent_channel, and + its alias template experimental::concurrent_channel, + to pass messages between code running in different threads. +

+
+ + Requirements +
+

+ Header: asio/experimental/basic_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel.html new file mode 100644 index 0000000..3ed048b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel.html @@ -0,0 +1,423 @@ + + + +experimental::basic_concurrent_channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A channel for messages. +

+
template<
+    typename Executor,
+    typename Traits,
+    typename... Signatures>
+class basic_concurrent_channel
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the channel type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the channel. +

+
+

+ traits_type +

+ 		+

+ The traits type associated with the channel. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_receive +

+ 		+

+ Asynchronously receive a message. +

+
+

+ async_send +

+ 		+

+ Asynchronously send a message. +

+
+

+ basic_concurrent_channel [constructor] +

+ 		+

+ Construct a basic_concurrent_channel.
—
Construct and + open a basic_concurrent_channel.
—
Move-construct a + basic_concurrent_channel from another. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations waiting on the channel. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the channel's buffer. +

+
+

+ close +

+ 		+

+ Close the channel. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the channel is open. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_concurrent_channel from another. +

+
+

+ ready +

+ 		+

+ Determine whether a message can be received without blocking. +

+
+

+ reset +

+ 		+

+ Reset the channel to its initial state. +

+
+

+ try_receive +

+ 		+

+ Try to receive a message without blocking. +

+
+

+ try_send +

+ 		+

+ Try to send a message without blocking. +

+
+

+ try_send_n +

+ 		+

+ Try to send a number of messages without blocking. +

+
+

+ try_send_n_via_dispatch +

+ 		+

+ Try to send a number of messages without blocking, using dispatch + semantics to call the receive operations' completion handlers. +

+
+

+ try_send_via_dispatch +

+ 		+

+ Try to send a message without blocking, using dispatch semantics + to call the receive operation's completion handler. +

+
+

+ ~basic_concurrent_channel [destructor] +

+ 		+

+ Destructor. +

+
+

+ The experimental::basic_concurrent_channel class template + is used for sending messages between different parts of the same application. + A message is defined as a collection of arguments to + be passed to a completion handler, and the set of messages supported by a + channel is specified by its Traits + and Signatures... + template parameters. Messages may be sent and received using asynchronous + or non-blocking synchronous operations. +

+

+ Unless customising the traits, applications will typically use the experimental::concurrent_channel alias template. For + example: +

+
void send_loop(int i, steady_timer& timer,
+    concurrent_channel<void(error_code, int)>& ch)
+{
+  if (i < 10)
+  {
+    timer.expires_after(chrono::seconds(1));
+    timer.async_wait(
+        [i, &timer, &ch](error_code error)
+        {
+          if (!error)
+          {
+            ch.async_send(error_code(), i,
+                [i, &timer, &ch](error_code error)
+                {
+                  if (!error)
+                  {
+                    send_loop(i + 1, timer, ch);
+                  }
+                });
+          }
+        });
+  }
+  else
+  {
+    ch.close();
+  }
+}
+
+void receive_loop(concurent_channel<void(error_code, int)>& ch)
+{
+  ch.async_receive(
+      [&ch](error_code error, int i)
+      {
+        if (!error)
+        {
+          std::cout << "Received " << i << "\n";
+          receive_loop(ch);
+        }
+      });
+}
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+

+ The experimental::basic_concurrent_channel class template + is thread-safe, and would typically be used for passing messages between + application code that run on different threads. Consider using experimental::basic_channel, and its alias template + experimental::channel, to pass messages between code + running in a single thread or on the same strand. +

+
+ + Requirements +
+

+ Header: asio/experimental/basic_concurrent_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/_basic_concurrent_channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/_basic_concurrent_channel.html new file mode 100644 index 0000000..ac0e535 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/_basic_concurrent_channel.html @@ -0,0 +1,41 @@ + + + +experimental::basic_concurrent_channel::~basic_concurrent_channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~basic_concurrent_channel();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/async_receive.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/async_receive.html new file mode 100644 index 0000000..5604ac6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/async_receive.html @@ -0,0 +1,45 @@ + + + +experimental::basic_concurrent_channel::async_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + receive a message. +

+
template<
+    typename CompletionToken = DEFAULT>
+DEDUCED async_receive(
+    CompletionToken && token = DEFAULT);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/async_send.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/async_send.html new file mode 100644 index 0000000..5b88959 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/async_send.html @@ -0,0 +1,47 @@ + + + +experimental::basic_concurrent_channel::async_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + send a message. +

+
template<
+    typename... Args,
+    typename CompletionToken = DEFAULT>
+DEDUCED async_send(
+    Args &&... args,
+    CompletionToken && token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel.html new file mode 100644 index 0000000..fb3dcc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel.html @@ -0,0 +1,71 @@ + + + +experimental::basic_concurrent_channel::basic_concurrent_channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a experimental::basic_concurrent_channel. +

+
basic_concurrent_channel(
+    const executor_type & ex,
+    std::size_t max_buffer_size = 0);
+  » more...
+
+

+ Construct and open a experimental::basic_concurrent_channel. +

+
template<
+    typename ExecutionContext>
+basic_concurrent_channel(
+    ExecutionContext & context,
+    std::size_t max_buffer_size = 0,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Move-construct a experimental::basic_concurrent_channel from + another. +

+
basic_concurrent_channel(
+    basic_concurrent_channel && other);
+  » more...
+
+template<
+    typename Executor1>
+basic_concurrent_channel(
+    basic_concurrent_channel< Executor1, Traits, Signatures... > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload1.html new file mode 100644 index 0000000..fd5c0c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload1.html @@ -0,0 +1,64 @@ + + + +experimental::basic_concurrent_channel::basic_concurrent_channel (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a experimental::basic_concurrent_channel. +

+
basic_concurrent_channel(
+    const executor_type & ex,
+    std::size_t max_buffer_size = 0);
+
+

+ This constructor creates and channel. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the channel will use, by default, to dispatch + handlers for any asynchronous operations performed on the channel. +

+
max_buffer_size
+

+ The maximum number of messages that may be buffered in the channel. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload2.html new file mode 100644 index 0000000..013db67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload2.html @@ -0,0 +1,68 @@ + + + +experimental::basic_concurrent_channel::basic_concurrent_channel (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct and open a experimental::basic_concurrent_channel. +

+
template<
+    typename ExecutionContext>
+basic_concurrent_channel(
+    ExecutionContext & context,
+    std::size_t max_buffer_size = 0,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates and opens a channel. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the channel + will use, by default, to dispatch handlers for any asynchronous + operations performed on the channel. +

+
max_buffer_size
+

+ The maximum number of messages that may be buffered in the channel. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload3.html new file mode 100644 index 0000000..2f704b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload3.html @@ -0,0 +1,69 @@ + + + +experimental::basic_concurrent_channel::basic_concurrent_channel (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a experimental::basic_concurrent_channel from + another. +

+
basic_concurrent_channel(
+    basic_concurrent_channel && other);
+
+

+ This constructor moves a channel from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_concurrent_channel + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_concurrent_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload4.html new file mode 100644 index 0000000..2d8e7ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/basic_concurrent_channel/overload4.html @@ -0,0 +1,72 @@ + + + +experimental::basic_concurrent_channel::basic_concurrent_channel (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a experimental::basic_concurrent_channel from + another. +

+
template<
+    typename Executor1>
+basic_concurrent_channel(
+    basic_concurrent_channel< Executor1, Traits, Signatures... > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a channel from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_concurrent_channel + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_concurrent_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/cancel.html new file mode 100644 index 0000000..4a9b29c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/cancel.html @@ -0,0 +1,46 @@ + + + +experimental::basic_concurrent_channel::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations waiting on the channel. +

+
void cancel();
+
+

+ All outstanding send operations will complete with the error asio::experimental::error::channel_cancelled. Outstanding receive + operations complete with the result as determined by the channel traits. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/capacity.html new file mode 100644 index 0000000..c350c9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/capacity.html @@ -0,0 +1,42 @@ + + + +experimental::basic_concurrent_channel::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the capacity of the channel's buffer. +

+
std::size_t capacity();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/close.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/close.html new file mode 100644 index 0000000..023c4cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/close.html @@ -0,0 +1,42 @@ + + + +experimental::basic_concurrent_channel::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the channel. +

+
void close();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/executor_type.html new file mode 100644 index 0000000..71ef674 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/executor_type.html @@ -0,0 +1,52 @@ + + + +experimental::basic_concurrent_channel::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the channel. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/basic_concurrent_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/get_executor.html new file mode 100644 index 0000000..febb15a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/get_executor.html @@ -0,0 +1,42 @@ + + + +experimental::basic_concurrent_channel::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/is_open.html new file mode 100644 index 0000000..1dd400c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/is_open.html @@ -0,0 +1,42 @@ + + + +experimental::basic_concurrent_channel::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the channel is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_.html new file mode 100644 index 0000000..8288355 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_.html @@ -0,0 +1,51 @@ + + + +experimental::basic_concurrent_channel::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a experimental::basic_concurrent_channel from + another. +

+
basic_concurrent_channel & operator=(
+    basic_concurrent_channel && other);
+  » more...
+
+template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_concurrent_channel & > operator=(
+    basic_concurrent_channel< Executor1, Traits, Signatures... > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_/overload1.html new file mode 100644 index 0000000..bb37fc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_/overload1.html @@ -0,0 +1,71 @@ + + + +experimental::basic_concurrent_channel::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a experimental::basic_concurrent_channel from + another. +

+
basic_concurrent_channel & operator=(
+    basic_concurrent_channel && other);
+
+

+ This assignment operator moves a channel from one object to another. + Cancels any outstanding asynchronous operations associated with the target + object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_concurrent_channel + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_concurrent_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_/overload2.html new file mode 100644 index 0000000..4404fc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/operator_eq_/overload2.html @@ -0,0 +1,73 @@ + + + +experimental::basic_concurrent_channel::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a experimental::basic_concurrent_channel from + another. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_concurrent_channel & > operator=(
+    basic_concurrent_channel< Executor1, Traits, Signatures... > && other);
+
+

+ This assignment operator moves a channel from one object to another. + Cancels any outstanding asynchronous operations associated with the target + object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other experimental::basic_concurrent_channel + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_concurrent_channel(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/ready.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/ready.html new file mode 100644 index 0000000..b3a8d37 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/ready.html @@ -0,0 +1,42 @@ + + + +experimental::basic_concurrent_channel::ready + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether a message can be received without blocking. +

+
bool ready() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/reset.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/reset.html new file mode 100644 index 0000000..074ce41 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/reset.html @@ -0,0 +1,42 @@ + + + +experimental::basic_concurrent_channel::reset + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Reset + the channel to its initial state. +

+
void reset();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/traits_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/traits_type.html new file mode 100644 index 0000000..3603fc9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/traits_type.html @@ -0,0 +1,52 @@ + + + +experimental::basic_concurrent_channel::traits_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + traits type associated with the channel. +

+
typedef Traits::template rebind< Signatures... >::other traits_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/basic_concurrent_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_receive.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_receive.html new file mode 100644 index 0000000..ba5c78d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_receive.html @@ -0,0 +1,56 @@ + + + +experimental::basic_concurrent_channel::try_receive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to receive a message without blocking. +

+
template<
+    typename Handler>
+bool try_receive(
+    Handler && handler);
+
+

+ Fails if the buffer is full and there are no waiting receive operations. +

+
+ + Return + Value +
+

+ true on success, false on failure. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send.html new file mode 100644 index 0000000..6da8235 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send.html @@ -0,0 +1,56 @@ + + + +experimental::basic_concurrent_channel::try_send + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a message without blocking. +

+
template<
+    typename... Args>
+bool try_send(
+    Args &&... args);
+
+

+ Fails if the buffer is full and there are no waiting receive operations. +

+
+ + Return + Value +
+

+ true on success, false on failure. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_n.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_n.html new file mode 100644 index 0000000..0507c22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_n.html @@ -0,0 +1,54 @@ + + + +experimental::basic_concurrent_channel::try_send_n + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a number of messages without blocking. +

+
template<
+    typename... Args>
+std::size_t try_send_n(
+    std::size_t count,
+    Args &&... args);
+
+
+ + Return + Value +
+

+ The number of messages that were sent. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_n_via_dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_n_via_dispatch.html new file mode 100644 index 0000000..c9e681a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_n_via_dispatch.html @@ -0,0 +1,59 @@ + + + +experimental::basic_concurrent_channel::try_send_n_via_dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a number of messages without blocking, using dispatch semantics + to call the receive operations' completion handlers. +

+
template<
+    typename... Args>
+std::size_t try_send_n_via_dispatch(
+    std::size_t count,
+    Args &&... args);
+
+

+ The receive operations' completion handlers may be called from inside this + function. +

+
+ + Return + Value +
+

+ The number of messages that were sent. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_via_dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_via_dispatch.html new file mode 100644 index 0000000..8c3debc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel/try_send_via_dispatch.html @@ -0,0 +1,61 @@ + + + +experimental::basic_concurrent_channel::try_send_via_dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Try + to send a message without blocking, using dispatch semantics to call the + receive operation's completion handler. +

+
template<
+    typename... Args>
+bool try_send_via_dispatch(
+    Args &&... args);
+
+

+ Fails if the buffer is full and there are no waiting receive operations. +

+

+ The receive operation's completion handler may be called from inside this + function. +

+
+ + Return + Value +
+

+ true on success, false on failure. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel__rebind_executor.html new file mode 100644 index 0000000..cd620a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel__rebind_executor.html @@ -0,0 +1,89 @@ + + + +experimental::basic_concurrent_channel::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the channel type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The channel type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/basic_concurrent_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel__rebind_executor/other.html new file mode 100644 index 0000000..6cb921f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__basic_concurrent_channel__rebind_executor/other.html @@ -0,0 +1,419 @@ + + + +experimental::basic_concurrent_channel::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + channel type when rebound to the specified executor. +

+
typedef basic_concurrent_channel< Executor1, Traits, Signatures... > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the channel type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the channel. +

+
+

+ traits_type +

+ 		+

+ The traits type associated with the channel. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_receive +

+ 		+

+ Asynchronously receive a message. +

+
+

+ async_send +

+ 		+

+ Asynchronously send a message. +

+
+

+ basic_concurrent_channel [constructor] +

+ 		+

+ Construct a basic_concurrent_channel.
—
Construct + and open a basic_concurrent_channel.
—
Move-construct + a basic_concurrent_channel from another. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations waiting on the channel. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the channel's buffer. +

+
+

+ close +

+ 		+

+ Close the channel. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the channel is open. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_concurrent_channel from another. +

+
+

+ ready +

+ 		+

+ Determine whether a message can be received without blocking. +

+
+

+ reset +

+ 		+

+ Reset the channel to its initial state. +

+
+

+ try_receive +

+ 		+

+ Try to receive a message without blocking. +

+
+

+ try_send +

+ 		+

+ Try to send a message without blocking. +

+
+

+ try_send_n +

+ 		+

+ Try to send a number of messages without blocking. +

+
+

+ try_send_n_via_dispatch +

+ 		+

+ Try to send a number of messages without blocking, using dispatch + semantics to call the receive operations' completion handlers. +

+
+

+ try_send_via_dispatch +

+ 		+

+ Try to send a message without blocking, using dispatch semantics + to call the receive operation's completion handler. +

+
+

+ ~basic_concurrent_channel [destructor] +

+ 		+

+ Destructor. +

+
+

+ The experimental::basic_concurrent_channel class + template is used for sending messages between different parts of the same + application. A message is defined as a collection + of arguments to be passed to a completion handler, and the set of messages + supported by a channel is specified by its Traits + and Signatures... + template parameters. Messages may be sent and received using asynchronous + or non-blocking synchronous operations. +

+

+ Unless customising the traits, applications will typically use the experimental::concurrent_channel alias template. For + example: +

+
void send_loop(int i, steady_timer& timer,
+    concurrent_channel<void(error_code, int)>& ch)
+{
+  if (i < 10)
+  {
+    timer.expires_after(chrono::seconds(1));
+    timer.async_wait(
+        [i, &timer, &ch](error_code error)
+        {
+          if (!error)
+          {
+            ch.async_send(error_code(), i,
+                [i, &timer, &ch](error_code error)
+                {
+                  if (!error)
+                  {
+                    send_loop(i + 1, timer, ch);
+                  }
+                });
+          }
+        });
+  }
+  else
+  {
+    ch.close();
+  }
+}
+
+void receive_loop(concurent_channel<void(error_code, int)>& ch)
+{
+  ch.async_receive(
+      [&ch](error_code error, int i)
+      {
+        if (!error)
+        {
+          std::cout << "Received " << i << "\n";
+          receive_loop(ch);
+        }
+      });
+}
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+

+ The experimental::basic_concurrent_channel class + template is thread-safe, and would typically be used for passing messages + between application code that run on different threads. Consider using + experimental::basic_channel, and its alias template + experimental::channel, to pass messages between code + running in a single thread or on the same strand. +

+
+ + Requirements +
+

+ Header: asio/experimental/basic_concurrent_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel.html new file mode 100644 index 0000000..cb7746e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel.html @@ -0,0 +1,417 @@ + + + +experimental::channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Template type alias for common use of channel. +

+
typedef basic_channel< specified_executor_or_any_io_executor, channel_traits<>, signatures... > channel;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the channel type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the channel. +

+
+

+ traits_type +

+ 		+

+ The traits type associated with the channel. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_receive +

+ 		+

+ Asynchronously receive a message. +

+
+

+ async_send +

+ 		+

+ Asynchronously send a message. +

+
+

+ basic_channel [constructor] +

+ 		+

+ Construct a basic_channel.
—
Construct and open a basic_channel. +
—
Move-construct a basic_channel from another. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations waiting on the channel. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the channel's buffer. +

+
+

+ close +

+ 		+

+ Close the channel. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the channel is open. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_channel from another. +

+
+

+ ready +

+ 		+

+ Determine whether a message can be received without blocking. +

+
+

+ reset +

+ 		+

+ Reset the channel to its initial state. +

+
+

+ try_receive +

+ 		+

+ Try to receive a message without blocking. +

+
+

+ try_send +

+ 		+

+ Try to send a message without blocking. +

+
+

+ try_send_n +

+ 		+

+ Try to send a number of messages without blocking. +

+
+

+ try_send_n_via_dispatch +

+ 		+

+ Try to send a number of messages without blocking, using dispatch + semantics to call the receive operations' completion handlers. +

+
+

+ try_send_via_dispatch +

+ 		+

+ Try to send a message without blocking, using dispatch semantics + to call the receive operation's completion handler. +

+
+

+ ~basic_channel [destructor] +

+ 		+

+ Destructor. +

+
+

+ The experimental::basic_channel class template is + used for sending messages between different parts of the same application. + A message is defined as a collection of arguments to + be passed to a completion handler, and the set of messages supported by a + channel is specified by its Traits + and Signatures... + template parameters. Messages may be sent and received using asynchronous + or non-blocking synchronous operations. +

+

+ Unless customising the traits, applications will typically use the experimental::channel alias template. For example: +

+
void send_loop(int i, steady_timer& timer,
+    channel<void(error_code, int)>& ch)
+{
+  if (i < 10)
+  {
+    timer.expires_after(chrono::seconds(1));
+    timer.async_wait(
+        [i, &timer, &ch](error_code error)
+        {
+          if (!error)
+          {
+            ch.async_send(error_code(), i,
+                [i, &timer, &ch](error_code error)
+                {
+                  if (!error)
+                  {
+                    send_loop(i + 1, timer, ch);
+                  }
+                });
+          }
+        });
+  }
+  else
+  {
+    ch.close();
+  }
+}
+
+void receive_loop(channel<void(error_code, int)>& ch)
+{
+  ch.async_receive(
+      [&ch](error_code error, int i)
+      {
+        if (!error)
+        {
+          std::cout << "Received " << i << "\n";
+          receive_loop(ch);
+        }
+      });
+}
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ The experimental::basic_channel class template is + not thread-safe, and would typically be used for passing messages between + application code that runs on the same thread or in the same strand. Consider + using experimental::basic_concurrent_channel, and its + alias template experimental::concurrent_channel, + to pass messages between code running in different threads. +

+
+ + Requirements +
+

+ Header: asio/experimental/channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits.html new file mode 100644 index 0000000..1f712bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits.html @@ -0,0 +1,173 @@ + + + +experimental::channel_traits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename... Signatures>
+struct channel_traits
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ container +

+ 		+

+ Determine the container for the specified elements. +

+
+

+ rebind +

+ 		+

+ Rebind the traits to a new set of signatures. +

+
+

+ receive_cancelled_signature +

+ 		+

+ The signature of a channel cancellation notification. +

+
+

+ receive_closed_signature +

+ 		+

+ The signature of a channel closed notification. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ invoke_receive_cancelled [static] +

+ 		+

+ Invoke the specified handler with a cancellation notification. +

+
+

+ invoke_receive_closed [static] +

+ 		+

+ Invoke the specified handler with a closed notification. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/invoke_receive_cancelled.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/invoke_receive_cancelled.html new file mode 100644 index 0000000..40ddd48 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/invoke_receive_cancelled.html @@ -0,0 +1,45 @@ + + + +experimental::channel_traits::invoke_receive_cancelled + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Invoke + the specified handler with a cancellation notification. +

+
template<
+    typename F>
+static void invoke_receive_cancelled(
+    F f);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/invoke_receive_closed.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/invoke_receive_closed.html new file mode 100644 index 0000000..452bce3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/invoke_receive_closed.html @@ -0,0 +1,45 @@ + + + +experimental::channel_traits::invoke_receive_closed + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Invoke + the specified handler with a closed notification. +

+
template<
+    typename F>
+static void invoke_receive_closed(
+    F f);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/receive_cancelled_signature.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/receive_cancelled_signature.html new file mode 100644 index 0000000..e13812a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/receive_cancelled_signature.html @@ -0,0 +1,52 @@ + + + +experimental::channel_traits::receive_cancelled_signature + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + signature of a channel cancellation notification. +

+
typedef void receive_cancelled_signature;
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/receive_closed_signature.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/receive_closed_signature.html new file mode 100644 index 0000000..12f0881 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits/receive_closed_signature.html @@ -0,0 +1,52 @@ + + + +experimental::channel_traits::receive_closed_signature + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + signature of a channel closed notification. +

+
typedef void receive_closed_signature;
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__container.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__container.html new file mode 100644 index 0000000..7a93eb0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__container.html @@ -0,0 +1,90 @@ + + + +experimental::channel_traits::container + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Determine the container for the specified elements. +

+
template<
+    typename Element>
+struct container
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+

+ This nested structure must have a single nested type other + that aliases a container type for the specified element type. +

+
+ + Requirements +
+

+ Header: asio/experimental/channel_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__container/type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__container/type.html new file mode 100644 index 0000000..932f58b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__container/type.html @@ -0,0 +1,50 @@ + + + +experimental::channel_traits::container::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef user_defined type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__rebind.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__rebind.html new file mode 100644 index 0000000..975b004 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__rebind.html @@ -0,0 +1,90 @@ + + + +experimental::channel_traits::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebind the traits to a new set of signatures. +

+
template<
+    typename... NewSignatures>
+struct rebind
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+
+

+ This nested structure must have a single nested type other + that aliases a traits type with the specified set of signatures. +

+
+ + Requirements +
+

+ Header: asio/experimental/channel_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__rebind/other.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__rebind/other.html new file mode 100644 index 0000000..9be2651 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__channel_traits__rebind/other.html @@ -0,0 +1,50 @@ + + + +experimental::channel_traits::rebind::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef user_defined other;
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn.html new file mode 100644 index 0000000..01c983a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn.html @@ -0,0 +1,102 @@ + + + +experimental::co_spawn + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Spawn a resumable coroutine. +

+
template<
+    typename T,
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void, T, Executor > c,
+    CompletionToken && token);
+  » more...
+
+template<
+    typename T,
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void(), T, Executor > c,
+    CompletionToken && token);
+  » more...
+
+template<
+    typename T,
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void() noexcept, T, Executor > c,
+    CompletionToken && token);
+  » more...
+
+template<
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void, void, Executor > c,
+    CompletionToken && token);
+  » more...
+
+template<
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void(), void, Executor > c,
+    CompletionToken && token);
+  » more...
+
+template<
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void() noexcept, void, Executor > c,
+    CompletionToken && token);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/experimental/co_spawn.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload1.html new file mode 100644 index 0000000..beec917 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload1.html @@ -0,0 +1,76 @@ + + + +experimental::co_spawn (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a resumable coroutine. +

+
template<
+    typename T,
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void, T, Executor > c,
+    CompletionToken && token);
+
+

+ This function spawns the coroutine for execution on its executor. It binds + the lifetime of the coroutine to the executor. +

+
+ + Parameters +
+
+

+
+
c
+

+ The coroutine +

+
token
+

+ The completion token +

+
+
+
+ + Return + Value +
+

+ Implementation defined +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload2.html new file mode 100644 index 0000000..26a25d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload2.html @@ -0,0 +1,76 @@ + + + +experimental::co_spawn (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a resumable coroutine. +

+
template<
+    typename T,
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void(), T, Executor > c,
+    CompletionToken && token);
+
+

+ This function spawns the coroutine for execution on its executor. It binds + the lifetime of the coroutine to the executor. +

+
+ + Parameters +
+
+

+
+
c
+

+ The coroutine +

+
token
+

+ The completion token +

+
+
+
+ + Return + Value +
+

+ Implementation defined +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload3.html new file mode 100644 index 0000000..578abec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload3.html @@ -0,0 +1,76 @@ + + + +experimental::co_spawn (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a resumable coroutine. +

+
template<
+    typename T,
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void() noexcept, T, Executor > c,
+    CompletionToken && token);
+
+

+ This function spawns the coroutine for execution on its executor. It binds + the lifetime of the coroutine to the executor. +

+
+ + Parameters +
+
+

+
+
c
+

+ The coroutine +

+
token
+

+ The completion token +

+
+
+
+ + Return + Value +
+

+ Implementation defined +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload4.html new file mode 100644 index 0000000..162bf71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload4.html @@ -0,0 +1,75 @@ + + + +experimental::co_spawn (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a resumable coroutine. +

+
template<
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void, void, Executor > c,
+    CompletionToken && token);
+
+

+ This function spawns the coroutine for execution on its executor. It binds + the lifetime of the coroutine to the executor. +

+
+ + Parameters +
+
+

+
+
c
+

+ The coroutine +

+
token
+

+ The completion token +

+
+
+
+ + Return + Value +
+

+ Implementation defined +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload5.html new file mode 100644 index 0000000..fa6bfc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload5.html @@ -0,0 +1,75 @@ + + + +experimental::co_spawn (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a resumable coroutine. +

+
template<
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void(), void, Executor > c,
+    CompletionToken && token);
+
+

+ This function spawns the coroutine for execution on its executor. It binds + the lifetime of the coroutine to the executor. +

+
+ + Parameters +
+
+

+
+
c
+

+ The coroutine +

+
token
+

+ The completion token +

+
+
+
+ + Return + Value +
+

+ Implementation defined +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload6.html new file mode 100644 index 0000000..2ca5acc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__co_spawn/overload6.html @@ -0,0 +1,75 @@ + + + +experimental::co_spawn (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Spawn a resumable coroutine. +

+
template<
+    typename Executor,
+    typename CompletionToken>
+DEDUCED co_spawn(
+    coro< void() noexcept, void, Executor > c,
+    CompletionToken && token);
+
+

+ This function spawns the coroutine for execution on its executor. It binds + the lifetime of the coroutine to the executor. +

+
+ + Parameters +
+
+

+
+
c
+

+ The coroutine +

+
token
+

+ The completion token +

+
+
+
+ + Return + Value +
+

+ Implementation defined +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__concurrent_channel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__concurrent_channel.html new file mode 100644 index 0000000..208d230 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__concurrent_channel.html @@ -0,0 +1,419 @@ + + + +experimental::concurrent_channel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Template type alias for common use of channel. +

+
typedef basic_concurrent_channel< specified_executor_or_any_io_executor, channel_traits<>, signatures... > concurrent_channel;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the channel type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the channel. +

+
+

+ traits_type +

+ 		+

+ The traits type associated with the channel. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_receive +

+ 		+

+ Asynchronously receive a message. +

+
+

+ async_send +

+ 		+

+ Asynchronously send a message. +

+
+

+ basic_concurrent_channel [constructor] +

+ 		+

+ Construct a basic_concurrent_channel.
—
Construct and + open a basic_concurrent_channel.
—
Move-construct a + basic_concurrent_channel from another. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations waiting on the channel. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the channel's buffer. +

+
+

+ close +

+ 		+

+ Close the channel. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the channel is open. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_concurrent_channel from another. +

+
+

+ ready +

+ 		+

+ Determine whether a message can be received without blocking. +

+
+

+ reset +

+ 		+

+ Reset the channel to its initial state. +

+
+

+ try_receive +

+ 		+

+ Try to receive a message without blocking. +

+
+

+ try_send +

+ 		+

+ Try to send a message without blocking. +

+
+

+ try_send_n +

+ 		+

+ Try to send a number of messages without blocking. +

+
+

+ try_send_n_via_dispatch +

+ 		+

+ Try to send a number of messages without blocking, using dispatch + semantics to call the receive operations' completion handlers. +

+
+

+ try_send_via_dispatch +

+ 		+

+ Try to send a message without blocking, using dispatch semantics + to call the receive operation's completion handler. +

+
+

+ ~basic_concurrent_channel [destructor] +

+ 		+

+ Destructor. +

+
+

+ The experimental::basic_concurrent_channel class template + is used for sending messages between different parts of the same application. + A message is defined as a collection of arguments to + be passed to a completion handler, and the set of messages supported by a + channel is specified by its Traits + and Signatures... + template parameters. Messages may be sent and received using asynchronous + or non-blocking synchronous operations. +

+

+ Unless customising the traits, applications will typically use the experimental::concurrent_channel alias template. For + example: +

+
void send_loop(int i, steady_timer& timer,
+    concurrent_channel<void(error_code, int)>& ch)
+{
+  if (i < 10)
+  {
+    timer.expires_after(chrono::seconds(1));
+    timer.async_wait(
+        [i, &timer, &ch](error_code error)
+        {
+          if (!error)
+          {
+            ch.async_send(error_code(), i,
+                [i, &timer, &ch](error_code error)
+                {
+                  if (!error)
+                  {
+                    send_loop(i + 1, timer, ch);
+                  }
+                });
+          }
+        });
+  }
+  else
+  {
+    ch.close();
+  }
+}
+
+void receive_loop(concurent_channel<void(error_code, int)>& ch)
+{
+  ch.async_receive(
+      [&ch](error_code error, int i)
+      {
+        if (!error)
+        {
+          std::cout << "Received " << i << "\n";
+          receive_loop(ch);
+        }
+      });
+}
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+

+ The experimental::basic_concurrent_channel class template + is thread-safe, and would typically be used for passing messages between + application code that run on different threads. Consider using experimental::basic_channel, and its alias template + experimental::channel, to pass messages between code + running in a single thread or on the same strand. +

+
+ + Requirements +
+

+ Header: asio/experimental/concurrent_channel.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro.html new file mode 100644 index 0000000..eed82f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro.html @@ -0,0 +1,404 @@ + + + +experimental::coro + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The main type of a resumable coroutine. +

+
template<
+    typename Yield = void,
+    typename Return = void,
+    typename Executor = any_io_executor,
+    typename Allocator = std::allocator<void>>
+struct coro
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. +

+
+

+ completion_handler +

+ 		+

+ Completion handler type used by async_resume. +

+
+

+ error_type +

+ 		+

+ The error type of the coroutine. Void for noexcept. +

+
+

+ executor_type +

+ 		+

+ The executor type. +

+
+

+ input_type +

+ 		+

+ The value that can be passed into a symmetrical cororoutine. void + if asymmetrical. +

+
+

+ promise_type +

+ 		+

+ The internal promise-type of the coroutine. +

+
+

+ result_type +

+ 		+

+ The type received by a co_await or async_resume. Its a combination + of yield and return. +

+
+

+ return_type +

+ 		+

+ The type that can be passed out through a co_return. +

+
+

+ signature_type +

+ 		+

+ The signature used by the async_resume. +

+
+

+ traits +

+ 		+

+ The traits of the coroutine. See asio::experimental::coro_traits + for details. +

+
+

+ yield_type +

+ 		+

+ The type that can be passed out through a co_yield. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_resume +

+ 		+

+ Resume the coroutine. +

+
+

+ coro [constructor] +

+ 		+

+ The default constructor, gives an invalid coroutine.
—
+ Move constructor.
—
+

+
+

+ get_allocator +

+ 		+

+ Get the used allocator. +

+
+

+ get_executor +

+ 		+

+ Get the used executor. +

+
+

+ is_open +

+ 		+

+ Check whether the coroutine is open, i.e. can be resumed. +

+
+

+ operator bool +

+ 		+

+ Check whether the coroutine is open, i.e. can be resumed. +

+
+

+ operator co_await +

+ 		+

+ Operator used for coroutines without input value. +

+
+

+ operator() +

+ 		+

+ Operator used for coroutines with input value. +

+
+

+ operator= +

+ 		+

+ Move assignment. +

+
+

+ ~coro [destructor] +

+ 		+

+ Destructor. Destroys the coroutine, if it holds a valid one. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_noexcept [static] +

+ 		+

+ Whether or not the coroutine is noexcept. +

+
+

+ Template parameter Yield + specifies type or signature used by co_yield, Return + specifies the type used for co_return, and Executor + specifies the underlying executor type. +

+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/_coro.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/_coro.html new file mode 100644 index 0000000..d248bc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/_coro.html @@ -0,0 +1,51 @@ + + + +experimental::coro::~coro + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. + Destroys the coroutine, if it holds a valid one. +

+
~coro();
+
+
+ + Remarks +
+

+ This does not cancel an active coroutine. Destructing a resumable coroutine, + i.e. one with a call to async_resume that has not completed, is undefined + behaviour. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/allocator_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/allocator_type.html new file mode 100644 index 0000000..6a02b03 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/allocator_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::allocator_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + allocator type. +

+
typedef Allocator allocator_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume.html new file mode 100644 index 0000000..9068542 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume.html @@ -0,0 +1,54 @@ + + + +experimental::coro::async_resume + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Resume + the coroutine. +

+
template<
+    typename CompletionToken>
+DEDUCED async_resume(
+    CompletionToken && token);
+  » more...
+
+template<
+    typename CompletionToken,
+    detail::convertible_to< input_type > T>
+DEDUCED async_resume(
+    T && ip,
+    CompletionToken && token);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume/overload1.html new file mode 100644 index 0000000..a8f9c28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume/overload1.html @@ -0,0 +1,71 @@ + + + +experimental::coro::async_resume (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Resume the coroutine. +

+
template<
+    typename CompletionToken>
+DEDUCED async_resume(
+    CompletionToken && token);
+
+
+ + Parameters +
+
+

+
+
token
+

+ The completion token of the async resume. +

+
+
+
+ + Attention +
+

+ Calling an invalid coroutine with a noexcept signature is undefined behaviour. +

+
+ + Remarks +
+

+ This overload is only available for coroutines without an input value. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume/overload2.html new file mode 100644 index 0000000..fab545d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/async_resume/overload2.html @@ -0,0 +1,73 @@ + + + +experimental::coro::async_resume (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Resume the coroutine. +

+
template<
+    typename CompletionToken,
+    detail::convertible_to< input_type > T>
+DEDUCED async_resume(
+    T && ip,
+    CompletionToken && token);
+
+
+ + Parameters +
+
+

+
+
token
+

+ The completion token of the async resume. +

+
+
+
+ + Attention +
+

+ Calling an invalid coroutine with a noexcept signature is undefined behaviour. +

+
+ + Remarks +
+

+ This overload is only available for coroutines with an input value. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/completion_handler.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/completion_handler.html new file mode 100644 index 0000000..1a3783a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/completion_handler.html @@ -0,0 +1,52 @@ + + + +experimental::coro::completion_handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Completion + handler type used by async_resume. +

+
typedef typename traits::completion_handler completion_handler;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro.html new file mode 100644 index 0000000..68838fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro.html @@ -0,0 +1,56 @@ + + + +experimental::coro::coro + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The default + constructor, gives an invalid coroutine. +

+
coro();
+  » more...
+
+

+ Move constructor. +

+
coro(
+    coro && lhs);
+  » more...
+
+
+
+coro(
+    const coro & );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload1.html new file mode 100644 index 0000000..26602bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload1.html @@ -0,0 +1,41 @@ + + + +experimental::coro::coro (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The default constructor, gives an invalid coroutine. +

+
coro();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload2.html new file mode 100644 index 0000000..aa5419f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload2.html @@ -0,0 +1,42 @@ + + + +experimental::coro::coro (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
coro(
+    coro && lhs);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload3.html new file mode 100644 index 0000000..f2dc236 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/coro/overload3.html @@ -0,0 +1,39 @@ + + + +experimental::coro::coro (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
coro(
+    const coro & );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/error_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/error_type.html new file mode 100644 index 0000000..4716f97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/error_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::error_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + error type of the coroutine. Void for noexcept. +

+
typedef typename traits::error_type error_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/executor_type.html new file mode 100644 index 0000000..b742bf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/executor_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + executor type. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/get_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/get_allocator.html new file mode 100644 index 0000000..64ce11d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/get_allocator.html @@ -0,0 +1,42 @@ + + + +experimental::coro::get_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the used allocator. +

+
allocator_type get_allocator() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/get_executor.html new file mode 100644 index 0000000..ef9cd0b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/get_executor.html @@ -0,0 +1,42 @@ + + + +experimental::coro::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the used executor. +

+
executor_type get_executor() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/input_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/input_type.html new file mode 100644 index 0000000..90094a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/input_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::input_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + value that can be passed into a symmetrical cororoutine. void if asymmetrical. +

+
typedef typename traits::input_type input_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/is_noexcept.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/is_noexcept.html new file mode 100644 index 0000000..00e4ee3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/is_noexcept.html @@ -0,0 +1,42 @@ + + + +experimental::coro::is_noexcept + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Whether + or not the coroutine is noexcept. +

+
static constexpr bool is_noexcept = traits::is_noexcept;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/is_open.html new file mode 100644 index 0000000..469eca9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/is_open.html @@ -0,0 +1,42 @@ + + + +experimental::coro::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Check + whether the coroutine is open, i.e. can be resumed. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_bool.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_bool.html new file mode 100644 index 0000000..f32371a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_bool.html @@ -0,0 +1,43 @@ + + + +experimental::coro::operator bool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Check + whether the coroutine is open, i.e. can be resumed. +

+
operator bool() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_co_await.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_co_await.html new file mode 100644 index 0000000..b55b458 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_co_await.html @@ -0,0 +1,43 @@ + + + +experimental::coro::operator co_await + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Operator + used for coroutines without input value. +

+
auto operator co_await();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_.html new file mode 100644 index 0000000..d1ea7b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_.html @@ -0,0 +1,48 @@ + + + +experimental::coro::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move + assignment. +

+
coro & operator=(
+    coro && lhs);
+  » more...
+
+coro & operator=(
+    const coro & );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_/overload1.html new file mode 100644 index 0000000..dd2ea18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +experimental::coro::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment. +

+
coro & operator=(
+    coro && lhs);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_/overload2.html new file mode 100644 index 0000000..00cfe33 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_eq_/overload2.html @@ -0,0 +1,39 @@ + + + +experimental::coro::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
coro & operator=(
+    const coro & );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_lp__rp_.html new file mode 100644 index 0000000..3f74661 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/operator_lp__rp_.html @@ -0,0 +1,71 @@ + + + +experimental::coro::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Operator + used for coroutines with input value. +

+
template<
+    detail::convertible_to< input_type > T>
+auto operator()(
+    T && ip);
+
+
+ + Parameters +
+
+

+
+
ip
+

+ The input value +

+
+
+
+ + Return + Value +
+

+ An awaitable handle. +

+
coro<void> push_values(coro<double(int)> c)
+{
+   std::optional<double> res = co_await c(42);
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/promise_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/promise_type.html new file mode 100644 index 0000000..6097643 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/promise_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::promise_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + internal promise-type of the coroutine. +

+
typedef detail::coro_promise< Yield, Return, Executor, Allocator > promise_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/result_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/result_type.html new file mode 100644 index 0000000..fb83feb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/result_type.html @@ -0,0 +1,53 @@ + + + +experimental::coro::result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type received by a co_await or async_resume. Its a combination of yield + and return. +

+
typedef typename traits::result_type result_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/return_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/return_type.html new file mode 100644 index 0000000..7d44d35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/return_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::return_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type that can be passed out through a co_return. +

+
typedef typename traits::return_type return_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/signature_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/signature_type.html new file mode 100644 index 0000000..272b019 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/signature_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::signature_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + signature used by the async_resume. +

+
typedef typename traits::signature_type signature_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/traits.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/traits.html new file mode 100644 index 0000000..2963305 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/traits.html @@ -0,0 +1,202 @@ + + + +experimental::coro::traits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The traits + of the coroutine. See experimental::coro_traits for details. +

+
typedef coro_traits< Yield, Return, Executor > traits;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ completion_handler +

+ 		+

+ Completion handler type used by async_resume. +

+
+

+ error_type +

+ 		+

+ The error type of the coroutine. void for noexcept. +

+
+

+ input_type +

+ 		+

+ The value that can be passed into a symmetrical cororoutine. + void if asymmetrical. +

+
+

+ result_type +

+ 		+

+ The type received by a co_await or async_resume. It's a combination + of yield and return. +

+
+

+ return_type +

+ 		+

+ The type that can be passed out through a co_return. +

+
+

+ signature_type +

+ 		+

+ The signature used by the async_resume. +

+
+

+ yield_type +

+ 		+

+ The type that can be passed out through a co_yield. +

+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_noexcept [static] +

+ 		+

+ Whether or not the coroutine is noexcept. +

+
+

+ Template parameter Yield + specifies type or signature used by co_yield, Return + specifies the type used for co_return, and Executor + specifies the underlying executor type. +

+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/yield_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/yield_type.html new file mode 100644 index 0000000..4ff4841 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro/yield_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro::yield_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type that can be passed out through a co_yield. +

+
typedef typename traits::yield_type yield_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits.html new file mode 100644 index 0000000..6d14533 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits.html @@ -0,0 +1,207 @@ + + + +experimental::coro_traits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The traits describing the resumable coroutine behaviour. +

+
template<
+    typename Yield,
+    typename Return,
+    typename Executor>
+struct coro_traits
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ completion_handler +

+ 		+

+ Completion handler type used by async_resume. +

+
+

+ error_type +

+ 		+

+ The error type of the coroutine. void for noexcept. +

+
+

+ input_type +

+ 		+

+ The value that can be passed into a symmetrical cororoutine. void + if asymmetrical. +

+
+

+ result_type +

+ 		+

+ The type received by a co_await or async_resume. It's a combination + of yield and return. +

+
+

+ return_type +

+ 		+

+ The type that can be passed out through a co_return. +

+
+

+ signature_type +

+ 		+

+ The signature used by the async_resume. +

+
+

+ yield_type +

+ 		+

+ The type that can be passed out through a co_yield. +

+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_noexcept [static] +

+ 		+

+ Whether or not the coroutine is noexcept. +

+
+

+ Template parameter Yield + specifies type or signature used by co_yield, Return + specifies the type used for co_return, and Executor + specifies the underlying executor type. +

+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/completion_handler.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/completion_handler.html new file mode 100644 index 0000000..f3fdb4d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/completion_handler.html @@ -0,0 +1,52 @@ + + + +experimental::coro_traits::completion_handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Completion + handler type used by async_resume. +

+
typedef argument_dependent completion_handler;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/error_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/error_type.html new file mode 100644 index 0000000..2f73bfc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/error_type.html @@ -0,0 +1,53 @@ + + + +experimental::coro_traits::error_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + error type of the coroutine. void + for noexcept. +

+
typedef argument_dependent error_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/input_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/input_type.html new file mode 100644 index 0000000..01f2854 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/input_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro_traits::input_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + value that can be passed into a symmetrical cororoutine. void if asymmetrical. +

+
typedef argument_dependent input_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/is_noexcept.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/is_noexcept.html new file mode 100644 index 0000000..05d2409 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/is_noexcept.html @@ -0,0 +1,42 @@ + + + +experimental::coro_traits::is_noexcept + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Whether + or not the coroutine is noexcept. +

+
static constexpr bool is_noexcept = argument_dependent;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/result_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/result_type.html new file mode 100644 index 0000000..4275835 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/result_type.html @@ -0,0 +1,53 @@ + + + +experimental::coro_traits::result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type received by a co_await or async_resume. It's a combination of yield + and return. +

+
typedef argument_dependent result_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/return_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/return_type.html new file mode 100644 index 0000000..c436caa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/return_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro_traits::return_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type that can be passed out through a co_return. +

+
typedef argument_dependent return_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/signature_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/signature_type.html new file mode 100644 index 0000000..46394c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/signature_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro_traits::signature_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + signature used by the async_resume. +

+
typedef argument_dependent signature_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/yield_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/yield_type.html new file mode 100644 index 0000000..669656f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__coro_traits/yield_type.html @@ -0,0 +1,52 @@ + + + +experimental::coro_traits::yield_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type that can be passed out through a co_yield. +

+
typedef argument_dependent yield_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/coro_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_category.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_category.html new file mode 100644 index 0000000..e3d23dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_category.html @@ -0,0 +1,50 @@ + + + +experimental::error::channel_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const asio::error_category & channel_category = asio::experimental::error::get_channel_category();
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_error.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors.html new file mode 100644 index 0000000..8a9f04e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors.html @@ -0,0 +1,71 @@ + + + +experimental::error::channel_errors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
enum channel_errors
+
+

+ + +

+
+ + Values +
+
+

+
+
channel_closed
+

+ The channel was closed. +

+
channel_cancelled
+

+ The channel was cancelled. +

+
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_error.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors__gt_.html new file mode 100644 index 0000000..3bbfba4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors__gt_.html @@ -0,0 +1,84 @@ + + + +experimental::error::channel_errors > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct is_error_code_enum< asio::experimental::error::channel_errors >
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_error.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors__gt_/value.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors__gt_/value.html new file mode 100644 index 0000000..c864fc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__channel_errors__gt_/value.html @@ -0,0 +1,41 @@ + + + +experimental::error::channel_errors >::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const bool value = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__error__get_channel_category.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__get_channel_category.html new file mode 100644 index 0000000..fd43c52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__get_channel_category.html @@ -0,0 +1,50 @@ + + + +experimental::error::get_channel_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const asio::error_category & get_channel_category();
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_error.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__error__make_error_code.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__make_error_code.html new file mode 100644 index 0000000..553b222 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__error__make_error_code.html @@ -0,0 +1,51 @@ + + + +experimental::error::make_error_code + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
asio::error_code make_error_code(
+    channel_errors e);
+
+
+ + Requirements +
+

+ Header: asio/experimental/channel_error.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__generator.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__generator.html new file mode 100644 index 0000000..18b6b53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__generator.html @@ -0,0 +1,399 @@ + + + +experimental::generator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A generator is a coro that returns void and yields value. +

+
typedef coro< T, void, Executor, Allocator > generator;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. +

+
+

+ completion_handler +

+ 		+

+ Completion handler type used by async_resume. +

+
+

+ error_type +

+ 		+

+ The error type of the coroutine. Void for noexcept. +

+
+

+ executor_type +

+ 		+

+ The executor type. +

+
+

+ input_type +

+ 		+

+ The value that can be passed into a symmetrical cororoutine. void + if asymmetrical. +

+
+

+ promise_type +

+ 		+

+ The internal promise-type of the coroutine. +

+
+

+ result_type +

+ 		+

+ The type received by a co_await or async_resume. Its a combination + of yield and return. +

+
+

+ return_type +

+ 		+

+ The type that can be passed out through a co_return. +

+
+

+ signature_type +

+ 		+

+ The signature used by the async_resume. +

+
+

+ traits +

+ 		+

+ The traits of the coroutine. See asio::experimental::coro_traits + for details. +

+
+

+ yield_type +

+ 		+

+ The type that can be passed out through a co_yield. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_resume +

+ 		+

+ Resume the coroutine. +

+
+

+ coro [constructor] +

+ 		+

+ The default constructor, gives an invalid coroutine.
—
+ Move constructor.
—
+

+
+

+ get_allocator +

+ 		+

+ Get the used allocator. +

+
+

+ get_executor +

+ 		+

+ Get the used executor. +

+
+

+ is_open +

+ 		+

+ Check whether the coroutine is open, i.e. can be resumed. +

+
+

+ operator bool +

+ 		+

+ Check whether the coroutine is open, i.e. can be resumed. +

+
+

+ operator co_await +

+ 		+

+ Operator used for coroutines without input value. +

+
+

+ operator() +

+ 		+

+ Operator used for coroutines with input value. +

+
+

+ operator= +

+ 		+

+ Move assignment. +

+
+

+ ~coro [destructor] +

+ 		+

+ Destructor. Destroys the coroutine, if it holds a valid one. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_noexcept [static] +

+ 		+

+ Whether or not the coroutine is noexcept. +

+
+

+ Template parameter Yield + specifies type or signature used by co_yield, Return + specifies the type used for co_return, and Executor + specifies the underlying executor type. +

+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__is_async_operation_range.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_async_operation_range.html new file mode 100644 index 0000000..bf05dd2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_async_operation_range.html @@ -0,0 +1,92 @@ + + + +experimental::is_async_operation_range + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Type trait used to determine whether a type is a range of asynchronous operations + that can be used with with make_parallel_group. +

+
template<
+    typename T>
+struct is_async_operation_range
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+

+ The value member is true if the type may be used as a range of + asynchronous operations. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/parallel_group.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__is_async_operation_range/value.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_async_operation_range/value.html new file mode 100644 index 0000000..6c7333e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_async_operation_range/value.html @@ -0,0 +1,43 @@ + + + +experimental::is_async_operation_range::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + value member is true if the type may be used as a range of asynchronous + operations. +

+
static const bool value;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise.html new file mode 100644 index 0000000..4deeacf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise.html @@ -0,0 +1,53 @@ + + + +experimental::is_promise + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename T>
+struct is_promise :
+  public std::false_type
+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise_lt__promise_lt__Ts_ellipsis___gt___gt_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise_lt__promise_lt__Ts_ellipsis___gt___gt_.html new file mode 100644 index 0000000..28d4ccd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise_lt__promise_lt__Ts_ellipsis___gt___gt_.html @@ -0,0 +1,54 @@ + + + +experimental::is_promise< promise< Ts... > > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename ... Ts>
+struct is_promise< promise< Ts... > > :
+  public std::true_type
+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise_v.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise_v.html new file mode 100644 index 0000000..c382110 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__is_promise_v.html @@ -0,0 +1,50 @@ + + + +experimental::is_promise_v + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr bool is_promise_v = is_promise<T>::value;
+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group.html new file mode 100644 index 0000000..11b3bac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group.html @@ -0,0 +1,74 @@ + + + +experimental::make_parallel_group + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a group of operations that may be launched in parallel. +

+
template<
+    typename... Ops>
+parallel_group< Ops... > make_parallel_group(
+    Ops... ops);
+  » more...
+
+template<
+    typename Range>
+ranged_parallel_group< decay_t< Range > > make_parallel_group(
+    Range && range,
+    constraint_t< is_async_operation_range< decay_t< Range > >::value >  = 0);
+  » more...
+
+template<
+    typename Allocator,
+    typename Range>
+ranged_parallel_group< decay_t< Range >, Allocator > make_parallel_group(
+    allocator_arg_t ,
+    const Allocator & allocator,
+    Range && range,
+    constraint_t< is_async_operation_range< decay_t< Range > >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/experimental/parallel_group.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload1.html new file mode 100644 index 0000000..00d5fb1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload1.html @@ -0,0 +1,111 @@ + + + +experimental::make_parallel_group (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a group of operations that may be launched in parallel. +

+
template<
+    typename... Ops>
+parallel_group< Ops... > make_parallel_group(
+    Ops... ops);
+
+

+ For example: +

+
asio::experimental::make_parallel_group(
+  in.async_read_some(asio::buffer(data)),
+  timer.async_wait()
+).async_wait(
+  asio::experimental::wait_for_all(),
+  [](
+      std::array<std::size_t, 2> completion_order,
+      std::error_code ec1, std::size_t n1,
+      std::error_code ec2
+  )
+  {
+    switch (completion_order[0])
+    {
+    case 0:
+      {
+        std::cout << "descriptor finished: " << ec1 << ", " << n1 << "\n";
+      }
+      break;
+    case 1:
+      {
+        std::cout << "timer finished: " << ec2 << "\n";
+      }
+      break;
+    }
+  }
+);
+
+

+ If preferred, the asynchronous operations may be explicitly packaged as + function objects: +

+
asio::experimental::make_parallel_group(
+  [&](auto token)
+  {
+    return in.async_read_some(asio::buffer(data), token);
+  },
+  [&](auto token)
+  {
+    return timer.async_wait(token);
+  }
+).async_wait(
+  asio::experimental::wait_for_all(),
+  [](
+      std::array<std::size_t, 2> completion_order,
+      std::error_code ec1, std::size_t n1,
+      std::error_code ec2
+  )
+  {
+    switch (completion_order[0])
+    {
+    case 0:
+      {
+        std::cout << "descriptor finished: " << ec1 << ", " << n1 << "\n";
+      }
+      break;
+    case 1:
+      {
+        std::cout << "timer finished: " << ec2 << "\n";
+      }
+      break;
+    }
+  }
+);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload2.html new file mode 100644 index 0000000..cb9cfbb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload2.html @@ -0,0 +1,85 @@ + + + +experimental::make_parallel_group (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a group of operations that may be launched in parallel. +

+
template<
+    typename Range>
+ranged_parallel_group< decay_t< Range > > make_parallel_group(
+    Range && range,
+    constraint_t< is_async_operation_range< decay_t< Range > >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
range
+

+ A range containing the operations to be launched. +

+
+
+

+ For example: +

+
using op_type =
+  decltype(socket1.async_read_some(asio::buffer(data1)));
+
+std::vector<op_type> ops;
+ops.push_back(socket1.async_read_some(asio::buffer(data1)));
+ops.push_back(socket2.async_read_some(asio::buffer(data2)));
+
+asio::experimental::make_parallel_group(ops).async_wait(
+    asio::experimental::wait_for_all(),
+    [](
+        std::vector<std::size_t> completion_order,
+        std::vector<std::error_code> e,
+        std::vector<std::size_t> n
+      )
+    {
+      for (std::size_t i = 0; i < completion_order.size(); ++i)
+      {
+        std::size_t idx = completion_order[i];
+        std::cout << "socket " << idx << " finished: ";
+        std::cout << e[idx] << ", " << n[idx] << "\n";
+      }
+    }
+  );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload3.html new file mode 100644 index 0000000..60f7dc5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__make_parallel_group/overload3.html @@ -0,0 +1,96 @@ + + + +experimental::make_parallel_group (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a group of operations that may be launched in parallel. +

+
template<
+    typename Allocator,
+    typename Range>
+ranged_parallel_group< decay_t< Range >, Allocator > make_parallel_group(
+    allocator_arg_t ,
+    const Allocator & allocator,
+    Range && range,
+    constraint_t< is_async_operation_range< decay_t< Range > >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
allocator
+

+ Specifies the allocator to be used with the result vectors. +

+
range
+

+ A range containing the operations to be launched. +

+
+
+

+ For example: +

+
using op_type =
+  decltype(socket1.async_read_some(asio::buffer(data1)));
+
+std::vector<op_type> ops;
+ops.push_back(socket1.async_read_some(asio::buffer(data1)));
+ops.push_back(socket2.async_read_some(asio::buffer(data2)));
+
+asio::experimental::make_parallel_group(
+    std::allocator_arg_t,
+    my_allocator,
+    ops
+  ).async_wait(
+    asio::experimental::wait_for_all(),
+    [](
+        std::vector<std::size_t> completion_order,
+        std::vector<std::error_code> e,
+        std::vector<std::size_t> n
+      )
+    {
+      for (std::size_t i = 0; i < completion_order.size(); ++i)
+      {
+        std::size_t idx = completion_order[i];
+        std::cout << "socket " << idx << " finished: ";
+        std::cout << e[idx] << ", " << n[idx] << "\n";
+      }
+    }
+  );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group.html new file mode 100644 index 0000000..4a56ad0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group.html @@ -0,0 +1,142 @@ + + + +experimental::parallel_group + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A group of asynchronous operations that may be launched in parallel. +

+
template<
+    typename... Ops>
+class parallel_group
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ signature +

+ 		+

+ The completion signature for the group of operations. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Initiate an asynchronous wait for the group of operations. +

+
+

+ parallel_group [constructor] +

+ 		+

+ Constructor. +

+
+

+ See the documentation for experimental::make_parallel_group for a usage + example. +

+
+ + Requirements +
+

+ Header: asio/experimental/parallel_group.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/async_wait.html new file mode 100644 index 0000000..1be8058 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/async_wait.html @@ -0,0 +1,93 @@ + + + +experimental::parallel_group::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Initiate + an asynchronous wait for the group of operations. +

+
template<
+    typename CancellationCondition,
+    typename CompletionToken>
+DEDUCED async_wait(
+    CancellationCondition cancellation_condition,
+    CompletionToken && token);
+
+

+ Launches the group and asynchronously waits for completion. +

+
+ + Parameters +
+
+

+
+
cancellation_condition
+

+ A function object, called on completion of an operation within the + group, that is used to determine whether to cancel the remaining + operations. The function object is passed the arguments of the completed + operation's handler. To trigger cancellation of the remaining operations, + it must return a cancellation_type value + other than asio::cancellation_type::none. +

+
token
+

+ A completion + token whose signature is comprised of a std::array<std::size_t, N> indicating the completion order + of the operations, followed by all operations' completion handler + arguments. +

+
+
+

+ The library provides the following cancellation_condition + types: +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/parallel_group.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/parallel_group.html new file mode 100644 index 0000000..2c2a624 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/parallel_group.html @@ -0,0 +1,42 @@ + + + +experimental::parallel_group::parallel_group + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
parallel_group(
+    Ops... ops);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/signature.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/signature.html new file mode 100644 index 0000000..2675a00 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__parallel_group/signature.html @@ -0,0 +1,52 @@ + + + +experimental::parallel_group::signature + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + completion signature for the group of operations. +

+
typedef detail::parallel_group_signature< sizeof...(Ops), completion_signature_of_t< Ops >... >::type signature;
+
+
+ + Requirements +
+

+ Header: asio/experimental/parallel_group.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise.html new file mode 100644 index 0000000..2d716d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise.html @@ -0,0 +1,213 @@ + + + +experimental::promise + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A disposable handle for an eager operation. +

+
template<
+    typename Signature = void(),
+    typename Executor = asio::any_io_executor,
+    typename Allocator = std::allocator<void>>
+struct promise
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value_type +

+ 		+

+ The value that's returned by the promise. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel +

+ 		+

+ Cancel the promise. Usually done through the destructor. +

+
+

+ completed +

+ 		+

+ Check if the promise is completed already. +

+
+

+ operator() +

+ 		+

+ Wait for the promise to become ready. +

+
+

+ promise [constructor] +

+ 		+
+

+ ~promise [destructor] +

+ 		+

+ Destruct the promise and cancel the operation. +

+
+
+

+
+
Signature
+

+ The signature of the operation. +

+
Executor
+

+ The executor to be used by the promise (taken from the operation). +

+
Allocator
+

+ The allocator used for the promise. Can be set through use_allocator. +

+
+
+

+ A promise can be used to initiate an asynchronous option that can be completed + later. If the promise gets destroyed before completion, the operation gets + a cancel signal and the result is ignored. +

+

+ A promise fulfills the requirements of async_operation. +

+
+ + Examples +
+

+ Reading and writing from one coroutine. +

+
awaitable<void> read_write_some(asio::ip::tcp::socket & sock,
+    asio::mutable_buffer read_buf, asio::const_buffer to_write)
+{
+  auto p = asio::async_read(read_buf,
+      asio::experimental::use_promise);
+  co_await asio::async_write_some(to_write);
+  co_await p;
+}
+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/_promise.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/_promise.html new file mode 100644 index 0000000..4be9e12 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/_promise.html @@ -0,0 +1,45 @@ + + + +experimental::promise::~promise + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destruct + the promise and cancel the operation. +

+
~promise();
+
+

+ It is safe to destruct a promise of a promise that didn't complete. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/cancel.html new file mode 100644 index 0000000..cfc1903 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/cancel.html @@ -0,0 +1,43 @@ + + + +experimental::promise::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + the promise. Usually done through the destructor. +

+
void cancel(
+    cancellation_type level = cancellation_type::all);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/completed.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/completed.html new file mode 100644 index 0000000..fc72e30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/completed.html @@ -0,0 +1,42 @@ + + + +experimental::promise::completed + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Check + if the promise is completed already. +

+
bool completed() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/operator_lp__rp_.html new file mode 100644 index 0000000..5a1c67f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/operator_lp__rp_.html @@ -0,0 +1,45 @@ + + + +experimental::promise::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait + for the promise to become ready. +

+
template<
+    typename CompletionToken>
+DEDUCED operator()(
+    CompletionToken && token);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise.html new file mode 100644 index 0000000..f8dfcd9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise.html @@ -0,0 +1,49 @@ + + + +experimental::promise::promise + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
promise();
+  » more...
+
+promise(
+    const promise & );
+  » more...
+
+promise(
+    promise && );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload1.html new file mode 100644 index 0000000..aa8f698 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload1.html @@ -0,0 +1,38 @@ + + + +experimental::promise::promise (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
promise();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload2.html new file mode 100644 index 0000000..159d686 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload2.html @@ -0,0 +1,39 @@ + + + +experimental::promise::promise (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
promise(
+    const promise & );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload3.html new file mode 100644 index 0000000..ebc4428 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/promise/overload3.html @@ -0,0 +1,39 @@ + + + +experimental::promise::promise (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
promise(
+    promise && );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/value_type.html new file mode 100644 index 0000000..bfb5b2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise/value_type.html @@ -0,0 +1,83 @@ + + + +experimental::promise::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + value that's returned by the promise. +

+
typedef typename promise_value_type< Ts... >::type value_type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type.html new file mode 100644 index 0000000..3344851 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type.html @@ -0,0 +1,83 @@ + + + +experimental::promise_value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename ... Ts>
+struct promise_value_type
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type/type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type/type.html new file mode 100644 index 0000000..f93c2de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type/type.html @@ -0,0 +1,50 @@ + + + +experimental::promise_value_type::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef std::tuple< Ts... > type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__T__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__T__gt_.html new file mode 100644 index 0000000..0269d8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__T__gt_.html @@ -0,0 +1,84 @@ + + + +experimental::promise_value_type< T > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename T>
+struct promise_value_type< T >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__T__gt_/type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__T__gt_/type.html new file mode 100644 index 0000000..0975b2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__T__gt_/type.html @@ -0,0 +1,51 @@ + + + +experimental::promise_value_type< T >::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef T type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__gt_.html new file mode 100644 index 0000000..11e706d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__gt_.html @@ -0,0 +1,82 @@ + + + +experimental::promise_value_type<> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct promise_value_type<>
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__gt_/type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__gt_/type.html new file mode 100644 index 0000000..f0575f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__promise_value_type_lt__gt_/type.html @@ -0,0 +1,50 @@ + + + +experimental::promise_value_type<>::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef std::tuple<> type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group.html new file mode 100644 index 0000000..3da0b26 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group.html @@ -0,0 +1,140 @@ + + + +experimental::ranged_parallel_group + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A range-based group of asynchronous operations that may be launched in parallel. +

+
template<
+    typename Range,
+    typename Allocator = std::allocator<void>>
+class ranged_parallel_group
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ signature +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Initiate an asynchronous wait for the group of operations. +

+
+

+ ranged_parallel_group [constructor] +

+ 		+

+ Constructor. +

+
+

+ See the documentation for experimental::make_parallel_group for a usage + example. +

+
+ + Requirements +
+

+ Header: asio/experimental/parallel_group.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/async_wait.html new file mode 100644 index 0000000..2e7c749 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/async_wait.html @@ -0,0 +1,93 @@ + + + +experimental::ranged_parallel_group::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Initiate + an asynchronous wait for the group of operations. +

+
template<
+    typename CancellationCondition,
+    typename CompletionToken>
+DEDUCED async_wait(
+    CancellationCondition cancellation_condition,
+    CompletionToken && token);
+
+

+ Launches the group and asynchronously waits for completion. +

+
+ + Parameters +
+
+

+
+
cancellation_condition
+

+ A function object, called on completion of an operation within the + group, that is used to determine whether to cancel the remaining + operations. The function object is passed the arguments of the completed + operation's handler. To trigger cancellation of the remaining operations, + it must return a cancellation_type value + other than asio::cancellation_type::none. +

+
token
+

+ A completion + token whose signature is comprised of a std::vector<std::size_t, Allocator> indicating the completion order + of the operations, followed by a vector for each of the completion + signature's arguments. +

+
+
+

+ The library provides the following cancellation_condition + types: +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/ranged_parallel_group.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/ranged_parallel_group.html new file mode 100644 index 0000000..648655c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/ranged_parallel_group.html @@ -0,0 +1,43 @@ + + + +experimental::ranged_parallel_group::ranged_parallel_group + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
ranged_parallel_group(
+    Range range,
+    const Allocator & allocator = Allocator());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/signature.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/signature.html new file mode 100644 index 0000000..de05fa6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__ranged_parallel_group/signature.html @@ -0,0 +1,50 @@ + + + +experimental::ranged_parallel_group::signature + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef Allocator ::type signature;
+
+
+ + Requirements +
+

+ Header: asio/experimental/parallel_group.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__task.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__task.html new file mode 100644 index 0000000..524fdc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__task.html @@ -0,0 +1,399 @@ + + + +experimental::task + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A task is a coro that does not yield values. +

+
typedef coro< void(), T, Executor, Allocator > task;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. +

+
+

+ completion_handler +

+ 		+

+ Completion handler type used by async_resume. +

+
+

+ error_type +

+ 		+

+ The error type of the coroutine. Void for noexcept. +

+
+

+ executor_type +

+ 		+

+ The executor type. +

+
+

+ input_type +

+ 		+

+ The value that can be passed into a symmetrical cororoutine. void + if asymmetrical. +

+
+

+ promise_type +

+ 		+

+ The internal promise-type of the coroutine. +

+
+

+ result_type +

+ 		+

+ The type received by a co_await or async_resume. Its a combination + of yield and return. +

+
+

+ return_type +

+ 		+

+ The type that can be passed out through a co_return. +

+
+

+ signature_type +

+ 		+

+ The signature used by the async_resume. +

+
+

+ traits +

+ 		+

+ The traits of the coroutine. See asio::experimental::coro_traits + for details. +

+
+

+ yield_type +

+ 		+

+ The type that can be passed out through a co_yield. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_resume +

+ 		+

+ Resume the coroutine. +

+
+

+ coro [constructor] +

+ 		+

+ The default constructor, gives an invalid coroutine.
—
+ Move constructor.
—
+

+
+

+ get_allocator +

+ 		+

+ Get the used allocator. +

+
+

+ get_executor +

+ 		+

+ Get the used executor. +

+
+

+ is_open +

+ 		+

+ Check whether the coroutine is open, i.e. can be resumed. +

+
+

+ operator bool +

+ 		+

+ Check whether the coroutine is open, i.e. can be resumed. +

+
+

+ operator co_await +

+ 		+

+ Operator used for coroutines without input value. +

+
+

+ operator() +

+ 		+

+ Operator used for coroutines with input value. +

+
+

+ operator= +

+ 		+

+ Move assignment. +

+
+

+ ~coro [destructor] +

+ 		+

+ Destructor. Destroys the coroutine, if it holds a valid one. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ is_noexcept [static] +

+ 		+

+ Whether or not the coroutine is noexcept. +

+
+

+ Template parameter Yield + specifies type or signature used by co_yield, Return + specifies the type used for co_return, and Executor + specifies the underlying executor type. +

+
+ + Requirements +
+

+ Header: asio/experimental/coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro.html new file mode 100644 index 0000000..2ed0e09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro.html @@ -0,0 +1,57 @@ + + + +experimental::use_coro + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + object that represents the currently executing resumable coroutine. +

+
constexpr use_coro_t use_coro;
+
+

+ See the documentation for asio::use_coro_t for a usage example. +

+
+ + Requirements +
+

+ Header: asio/experimental/use_coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t.html new file mode 100644 index 0000000..e73352a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t.html @@ -0,0 +1,218 @@ + + + +experimental::use_coro_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + that creates another coro for the task completion. +

+
template<
+    typename Allocator = std::allocator<void>>
+struct use_coro_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. The allocator is used when constructing the + std::promise object for a given asynchronous operation. +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use use_coro_t as its default + completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the use_coro_t completion token as the + default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use use_coro_t as its + default completion token type. +

+
+

+ get_allocator +

+ 		+

+ Obtain allocator. +

+
+

+ rebind +

+ 		+

+ Specify an alternate allocator. +

+
+

+ use_coro_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor used to specify + file name, line, and function name. +

+
+

+ The use_coro_t class, with + its value use_coro, is used + to represent an operation that can be awaited by the current resumable coroutine. + This completion token may be passed as a handler to an asynchronous operation. + For example: +

+
coro<void> my_coroutine(tcp::socket my_socket)
+{
+  std::size_t n = co_await my_socket.async_read_some(buffer, use_coro);
+  ...
+}
+
+

+ When used with co_await, the initiating function (async_read_some + in the above example) suspends the current coroutine. The coroutine is resumed + when the asynchronous operation completes, and the result of the operation + is returned. +

+

+ Note that this token is not the most efficient (use the default completion + token asio::deferred for that) but does provide type + erasure, as it will always return a coro. +

+
+ + Requirements +
+

+ Header: asio/experimental/use_coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/allocator_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/allocator_type.html new file mode 100644 index 0000000..ed2e955 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/allocator_type.html @@ -0,0 +1,53 @@ + + + +experimental::use_coro_t::allocator_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + allocator type. The allocator is used when constructing the std::promise object for a given asynchronous + operation. +

+
typedef Allocator allocator_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/use_coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/as_default_on.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/as_default_on.html new file mode 100644 index 0000000..7669881 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/as_default_on.html @@ -0,0 +1,46 @@ + + + +experimental::use_coro_t::as_default_on + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + helper to adapt an I/O object to use use_coro_t + as its default completion token type. +

+
template<
+    typename T>
+static decay_t< T >::template rebind_executor< executor_with_default< typenamedecay_t< T >::executor_type > >::other as_default_on(
+    T && object);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/as_default_on_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/as_default_on_t.html new file mode 100644 index 0000000..2618f4e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/as_default_on_t.html @@ -0,0 +1,122 @@ + + + +experimental::use_coro_t::as_default_on_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + alias to adapt an I/O object to use use_coro_t + as its default completion token type. +

+
typedef typename T::template rebind_executor< executor_with_default< typename T::executor_type > >::other as_default_on_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify use_coro_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/use_coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/get_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/get_allocator.html new file mode 100644 index 0000000..fcd60f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/get_allocator.html @@ -0,0 +1,42 @@ + + + +experimental::use_coro_t::get_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + allocator. +

+
allocator_type get_allocator() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/rebind.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/rebind.html new file mode 100644 index 0000000..2866465 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/rebind.html @@ -0,0 +1,45 @@ + + + +experimental::use_coro_t::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + an alternate allocator. +

+
template<
+    typename OtherAllocator>
+use_coro_t< OtherAllocator > rebind(
+    const OtherAllocator & allocator) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t.html new file mode 100644 index 0000000..0993aa0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t.html @@ -0,0 +1,54 @@ + + + +experimental::use_coro_t::use_coro_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr use_coro_t(
+    allocator_type allocator = allocator_type{});
+  » more...
+
+

+ Constructor used to specify file name, line, and function name. +

+
constexpr use_coro_t(
+    const char * file_name,
+    int line,
+    const char * function_name,
+    allocator_type allocator = allocator_type{});
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t/overload1.html new file mode 100644 index 0000000..323039b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t/overload1.html @@ -0,0 +1,42 @@ + + + +experimental::use_coro_t::use_coro_t (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr use_coro_t(
+    allocator_type allocator = allocator_type{});
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t/overload2.html new file mode 100644 index 0000000..8e10cfa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t/use_coro_t/overload2.html @@ -0,0 +1,45 @@ + + + +experimental::use_coro_t::use_coro_t (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor used to specify file name, line, and function name. +

+
constexpr use_coro_t(
+    const char * file_name,
+    int line,
+    const char * function_name,
+    allocator_type allocator = allocator_type{});
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default.html new file mode 100644 index 0000000..227f03e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default.html @@ -0,0 +1,126 @@ + + + +experimental::use_coro_t::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts an executor to add the use_coro_t + completion token as the default. +

+
template<
+    typename InnerExecutor>
+struct executor_with_default :
+  public InnerExecutor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify use_coro_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/use_coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default/default_completion_token_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default/default_completion_token_type.html new file mode 100644 index 0000000..ba9f1c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default/default_completion_token_type.html @@ -0,0 +1,215 @@ + + + +experimental::use_coro_t::executor_with_default::default_completion_token_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + use_coro_t as the default + completion token type. +

+
typedef use_coro_t default_completion_token_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. The allocator is used when constructing the + std::promise object for a given asynchronous operation. +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use use_coro_t as its default + completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the use_coro_t completion token as + the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use use_coro_t as its + default completion token type. +

+
+

+ get_allocator +

+ 		+

+ Obtain allocator. +

+
+

+ rebind +

+ 		+

+ Specify an alternate allocator. +

+
+

+ use_coro_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor used to specify + file name, line, and function name. +

+
+

+ The use_coro_t class, with + its value use_coro, is + used to represent an operation that can be awaited by the current resumable + coroutine. This completion token may be passed as a handler to an asynchronous + operation. For example: +

+
coro<void> my_coroutine(tcp::socket my_socket)
+{
+  std::size_t n = co_await my_socket.async_read_some(buffer, use_coro);
+  ...
+}
+
+

+ When used with co_await, the initiating function (async_read_some + in the above example) suspends the current coroutine. The coroutine is + resumed when the asynchronous operation completes, and the result of the + operation is returned. +

+

+ Note that this token is not the most efficient (use the default completion + token asio::deferred for that) but does provide type + erasure, as it will always return a coro. +

+
+ + Requirements +
+

+ Header: asio/experimental/use_coro.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default/executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default/executor_with_default.html new file mode 100644 index 0000000..68045d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_coro_t__executor_with_default/executor_with_default.html @@ -0,0 +1,46 @@ + + + +experimental::use_coro_t::executor_with_default::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + the adapted executor from the inner executor type. +

+
template<
+    typename InnerExecutor1>
+executor_with_default(
+    const InnerExecutor1 & ex,
+    constraint_t< conditional_t< !is_same< InnerExecutor1, executor_with_default >::value, is_convertible< InnerExecutor1, InnerExecutor >, false_type >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise.html new file mode 100644 index 0000000..ab28f81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise.html @@ -0,0 +1,50 @@ + + + +experimental::use_promise + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr use_promise_t use_promise;
+
+
+ + Requirements +
+

+ Header: asio/experimental/use_promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t.html new file mode 100644 index 0000000..0d057de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t.html @@ -0,0 +1,177 @@ + + + +experimental::use_promise_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename Allocator = std::allocator<void>>
+struct use_promise_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. The allocator is used when constructing the + promise object for a given asynchronous operation. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the use_promise_t completion token as + the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use use_promise_t as + its default completion token type. +

+
+

+ get_allocator +

+ 		+

+ Obtain allocator. +

+
+

+ rebind +

+ 		+

+ Specify an alternate allocator. +

+
+

+ use_promise_t [constructor] +

+ 		+

+ Construct using default-constructed allocator.
—
Construct + using specified allocator. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/use_promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/allocator_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/allocator_type.html new file mode 100644 index 0000000..496ed54 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/allocator_type.html @@ -0,0 +1,53 @@ + + + +experimental::use_promise_t::allocator_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + allocator type. The allocator is used when constructing the promise object for a given asynchronous + operation. +

+
typedef Allocator allocator_type;
+
+
+ + Requirements +
+

+ Header: asio/experimental/use_promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/as_default_on.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/as_default_on.html new file mode 100644 index 0000000..233f87d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/as_default_on.html @@ -0,0 +1,46 @@ + + + +experimental::use_promise_t::as_default_on + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + helper to adapt an I/O object to use use_promise_t + as its default completion token type. +

+
template<
+    typename T>
+static decay_t< T >::template rebind_executor< executor_with_default< typenamedecay_t< T >::executor_type > >::other as_default_on(
+    T && object);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/get_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/get_allocator.html new file mode 100644 index 0000000..b257825 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/get_allocator.html @@ -0,0 +1,42 @@ + + + +experimental::use_promise_t::get_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + allocator. +

+
allocator_type get_allocator() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/rebind.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/rebind.html new file mode 100644 index 0000000..0e4a21f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/rebind.html @@ -0,0 +1,45 @@ + + + +experimental::use_promise_t::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + an alternate allocator. +

+
template<
+    typename OtherAllocator>
+use_promise_t< OtherAllocator > rebind(
+    const OtherAllocator & allocator) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t.html new file mode 100644 index 0000000..9865591 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t.html @@ -0,0 +1,50 @@ + + + +experimental::use_promise_t::use_promise_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + using default-constructed allocator. +

+
constexpr use_promise_t();
+  » more...
+
+

+ Construct using specified allocator. +

+
explicit use_promise_t(
+    const Allocator & allocator);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t/overload1.html new file mode 100644 index 0000000..da98160 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t/overload1.html @@ -0,0 +1,41 @@ + + + +experimental::use_promise_t::use_promise_t (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct using default-constructed allocator. +

+
constexpr use_promise_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t/overload2.html new file mode 100644 index 0000000..ed7d5c3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t/use_promise_t/overload2.html @@ -0,0 +1,42 @@ + + + +experimental::use_promise_t::use_promise_t (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct using specified allocator. +

+
use_promise_t(
+    const Allocator & allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default.html new file mode 100644 index 0000000..e03ce75 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default.html @@ -0,0 +1,128 @@ + + + +experimental::use_promise_t::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts an executor to add the use_promise_t + completion token as the default. +

+
template<
+    typename InnerExecutor>
+struct executor_with_default :
+  public InnerExecutor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify use_promise_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type.
+ —
Convert the specified executor to the inner executor type, + then use that to construct the adapted executor. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/use_promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/default_completion_token_type.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/default_completion_token_type.html new file mode 100644 index 0000000..9d60178 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/default_completion_token_type.html @@ -0,0 +1,178 @@ + + + +experimental::use_promise_t::executor_with_default::default_completion_token_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + use_promise_t as the default + completion token type. +

+
typedef use_promise_t< Allocator > default_completion_token_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. The allocator is used when constructing the + promise object for a given asynchronous operation. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the use_promise_t completion token + as the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use use_promise_t as + its default completion token type. +

+
+

+ get_allocator +

+ 		+

+ Obtain allocator. +

+
+

+ rebind +

+ 		+

+ Specify an alternate allocator. +

+
+

+ use_promise_t [constructor] +

+ 		+

+ Construct using default-constructed allocator.
—
+ Construct using specified allocator. +

+
+
+ + Requirements +
+

+ Header: asio/experimental/use_promise.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default.html new file mode 100644 index 0000000..a299ddc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default.html @@ -0,0 +1,55 @@ + + + +experimental::use_promise_t::executor_with_default::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + the adapted executor from the inner executor type. +

+
executor_with_default(
+    const InnerExecutor & ex);
+  » more...
+
+

+ Convert the specified executor to the inner executor type, then use that + to construct the adapted executor. +

+
template<
+    typename OtherExecutor>
+executor_with_default(
+    const OtherExecutor & ex,
+    constraint_t< is_convertible< OtherExecutor, InnerExecutor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default/overload1.html new file mode 100644 index 0000000..df7506f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default/overload1.html @@ -0,0 +1,42 @@ + + + +experimental::use_promise_t::executor_with_default::executor_with_default (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct the adapted executor from the inner executor type. +

+
executor_with_default(
+    const InnerExecutor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default/overload2.html new file mode 100644 index 0000000..c329234 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__use_promise_t__executor_with_default/executor_with_default/overload2.html @@ -0,0 +1,46 @@ + + + +experimental::use_promise_t::executor_with_default::executor_with_default (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Convert the specified executor to the inner executor type, then use that + to construct the adapted executor. +

+
template<
+    typename OtherExecutor>
+executor_with_default(
+    const OtherExecutor & ex,
+    constraint_t< is_convertible< OtherExecutor, InnerExecutor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_all.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_all.html new file mode 100644 index 0000000..eb2f1c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_all.html @@ -0,0 +1,85 @@ + + + +experimental::wait_for_all + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wait for all operations to complete. +

+
class wait_for_all
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+
+ + Requirements +
+

+ Header: asio/experimental/cancellation_condition.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_all/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_all/operator_lp__rp_.html new file mode 100644 index 0000000..ffcc2e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_all/operator_lp__rp_.html @@ -0,0 +1,43 @@ + + + +experimental::wait_for_all::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename... Args>
+constexpr cancellation_type_t operator()(
+    Args && ...) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one.html new file mode 100644 index 0000000..10cd4c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one.html @@ -0,0 +1,96 @@ + + + +experimental::wait_for_one + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wait until an operation completes, then cancel the others. +

+
class wait_for_one
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+

+ wait_for_one [constructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/experimental/cancellation_condition.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one/operator_lp__rp_.html new file mode 100644 index 0000000..65d350f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one/operator_lp__rp_.html @@ -0,0 +1,43 @@ + + + +experimental::wait_for_one::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename... Args>
+constexpr cancellation_type_t operator()(
+    Args && ...) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one/wait_for_one.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one/wait_for_one.html new file mode 100644 index 0000000..856411a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one/wait_for_one.html @@ -0,0 +1,41 @@ + + + +experimental::wait_for_one::wait_for_one + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr wait_for_one(
+    cancellation_type_t cancel_type = cancellation_type::all);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error.html new file mode 100644 index 0000000..a0218fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error.html @@ -0,0 +1,99 @@ + + + +experimental::wait_for_one_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wait until an operation completes with an error, then cancel the others. +

+
class wait_for_one_error
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+

+ wait_for_one_error [constructor] +

+ 		+
+

+ If no operation completes with an error, waits for completion of all operations. +

+
+ + Requirements +
+

+ Header: asio/experimental/cancellation_condition.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_.html new file mode 100644 index 0000000..4308535 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_.html @@ -0,0 +1,57 @@ + + + +experimental::wait_for_one_error::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr cancellation_type_t operator()() const;
+  » more...
+
+template<
+    typename E,
+    typename... Args>
+constexpr constraint_t<!is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & ,
+    Args && ...) const;
+  » more...
+
+template<
+    typename E,
+    typename... Args>
+constexpr constraint_t< is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & e,
+    Args && ...) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..e3dd18f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload1.html @@ -0,0 +1,38 @@ + + + +experimental::wait_for_one_error::operator() (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
constexpr cancellation_type_t operator()() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..a653f18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload2.html @@ -0,0 +1,43 @@ + + + +experimental::wait_for_one_error::operator() (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename E,
+    typename... Args>
+constexpr constraint_t<!is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & ,
+    Args && ...) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload3.html new file mode 100644 index 0000000..056bdf6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/operator_lp__rp_/overload3.html @@ -0,0 +1,43 @@ + + + +experimental::wait_for_one_error::operator() (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename E,
+    typename... Args>
+constexpr constraint_t< is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & e,
+    Args && ...) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/wait_for_one_error.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/wait_for_one_error.html new file mode 100644 index 0000000..05b791f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_error/wait_for_one_error.html @@ -0,0 +1,41 @@ + + + +experimental::wait_for_one_error::wait_for_one_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr wait_for_one_error(
+    cancellation_type_t cancel_type = cancellation_type::all);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success.html new file mode 100644 index 0000000..00823f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success.html @@ -0,0 +1,99 @@ + + + +experimental::wait_for_one_success + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wait until an operation completes without an error, then cancel the others. +

+
class wait_for_one_success
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+

+ wait_for_one_success [constructor] +

+ 		+
+

+ If no operation completes without an error, waits for completion of all operations. +

+
+ + Requirements +
+

+ Header: asio/experimental/cancellation_condition.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_.html new file mode 100644 index 0000000..42bb482 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_.html @@ -0,0 +1,57 @@ + + + +experimental::wait_for_one_success::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr cancellation_type_t operator()() const;
+  » more...
+
+template<
+    typename E,
+    typename... Args>
+constexpr constraint_t<!is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & ,
+    Args && ...) const;
+  » more...
+
+template<
+    typename E,
+    typename... Args>
+constexpr constraint_t< is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & e,
+    Args && ...) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..8b44a00 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload1.html @@ -0,0 +1,38 @@ + + + +experimental::wait_for_one_success::operator() (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
constexpr cancellation_type_t operator()() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..508efaf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload2.html @@ -0,0 +1,43 @@ + + + +experimental::wait_for_one_success::operator() (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename E,
+    typename... Args>
+constexpr constraint_t<!is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & ,
+    Args && ...) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload3.html new file mode 100644 index 0000000..d10d3a2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/operator_lp__rp_/overload3.html @@ -0,0 +1,43 @@ + + + +experimental::wait_for_one_success::operator() (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename E,
+    typename... Args>
+constexpr constraint_t< is_disposition< E >::value, cancellation_type_t > operator()(
+    const E & e,
+    Args && ...) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/wait_for_one_success.html b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/wait_for_one_success.html new file mode 100644 index 0000000..37c1d9f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/experimental__wait_for_one_success/wait_for_one_success.html @@ -0,0 +1,41 @@ + + + +experimental::wait_for_one_success::wait_for_one_success + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr wait_for_one_success(
+    cancellation_type_t cancel_type = cancellation_type::all);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base.html b/Packages/asio-1.36.0/doc/asio/reference/file_base.html new file mode 100644 index 0000000..c5b813e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base.html @@ -0,0 +1,268 @@ + + + +file_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The file_base + class is used as a base for the basic_stream_file and basic_random_access_file class templates + so that we have a common place to define flags. +

+
class file_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~file_base + [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append + [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create + [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive + [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only + [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write + [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate + [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only + [static] +

+ 		+

+ Open the file for writing. +

+
+
+ + Requirements +
+

+ Header: asio/file_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/_file_base.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/_file_base.html new file mode 100644 index 0000000..6cfd55f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/_file_base.html @@ -0,0 +1,42 @@ + + + +file_base::~file_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected destructor + to prevent deletion through this type. +

+
~file_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/append.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/append.html new file mode 100644 index 0000000..0c2bbf8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/append.html @@ -0,0 +1,41 @@ + + + +file_base::append + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the file in append mode. +

+
static const flags append = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/create.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/create.html new file mode 100644 index 0000000..b7b6fd1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/create.html @@ -0,0 +1,42 @@ + + + +file_base::create + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create the file if it does + not exist. +

+
static const flags create = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/exclusive.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/exclusive.html new file mode 100644 index 0000000..f356149 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/exclusive.html @@ -0,0 +1,42 @@ + + + +file_base::exclusive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Ensure a new file is + created. Must be combined with create. +

+
static const flags exclusive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/flags.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/flags.html new file mode 100644 index 0000000..7e7e501 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/flags.html @@ -0,0 +1,51 @@ + + + +file_base::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A bitmask type (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/file_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/read_only.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/read_only.html new file mode 100644 index 0000000..51d385e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/read_only.html @@ -0,0 +1,41 @@ + + + +file_base::read_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the file for reading. +

+
static const flags read_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/read_write.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/read_write.html new file mode 100644 index 0000000..fa5bddf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/read_write.html @@ -0,0 +1,42 @@ + + + +file_base::read_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the file for + reading and writing. +

+
static const flags read_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/seek_basis.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/seek_basis.html new file mode 100644 index 0000000..0c2cae5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/seek_basis.html @@ -0,0 +1,68 @@ + + + +file_base::seek_basis + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Basis for seeking + in a file. +

+
enum seek_basis
+
+

+ + + +

+
+ + Values +
+
+

+
+
seek_set
+

+ Seek to an absolute position. +

+
seek_cur
+

+ Seek to an offset relative to the current file position. +

+
seek_end
+

+ Seek to an offset relative to the end of the file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/sync_all_on_write.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/sync_all_on_write.html new file mode 100644 index 0000000..43f9698 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/sync_all_on_write.html @@ -0,0 +1,43 @@ + + + +file_base::sync_all_on_write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open + the file so that write operations automatically synchronise the file data + and metadata to disk. +

+
static const flags sync_all_on_write = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/truncate.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/truncate.html new file mode 100644 index 0000000..9473ecd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/truncate.html @@ -0,0 +1,42 @@ + + + +file_base::truncate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the file with any + existing contents truncated. +

+
static const flags truncate = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/file_base/write_only.html b/Packages/asio-1.36.0/doc/asio/reference/file_base/write_only.html new file mode 100644 index 0000000..3647604 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/file_base/write_only.html @@ -0,0 +1,42 @@ + + + +file_base::write_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Open the file for + writing. +

+
static const flags write_only = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint.html new file mode 100644 index 0000000..4aab675 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint.html @@ -0,0 +1,335 @@ + + + +generic::basic_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Describes an endpoint for any socket type. +

+
template<
+    typename Protocol>
+class basic_endpoint
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on the + underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint from the + specified socket address.
—
Construct an endpoint from + the specific endpoint type.
—
Copy constructor.
+ —
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from another + endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ The generic::basic_endpoint class template describes + an endpoint that may be associated with any socket type. +

+
+ + Remarks +
+

+ The socket types sockaddr type must be able to fit into a sockaddr_storage + structure. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint.html new file mode 100644 index 0000000..e7421fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint.html @@ -0,0 +1,75 @@ + + + +generic::basic_endpoint::basic_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
basic_endpoint();
+  » more...
+
+

+ Construct an endpoint from the specified socket address. +

+
basic_endpoint(
+    const void * socket_address,
+    std::size_t socket_address_size,
+    int socket_protocol = 0);
+  » more...
+
+

+ Construct an endpoint from the specific endpoint type. +

+
template<
+    typename Endpoint>
+basic_endpoint(
+    const Endpoint & endpoint);
+  » more...
+
+

+ Copy constructor. +

+
basic_endpoint(
+    const basic_endpoint & other);
+  » more...
+
+

+ Move constructor. +

+
basic_endpoint(
+    basic_endpoint && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload1.html new file mode 100644 index 0000000..976f4b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload1.html @@ -0,0 +1,41 @@ + + + +generic::basic_endpoint::basic_endpoint (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
basic_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload2.html new file mode 100644 index 0000000..5b11ffb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload2.html @@ -0,0 +1,44 @@ + + + +generic::basic_endpoint::basic_endpoint (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an endpoint from the specified socket address. +

+
basic_endpoint(
+    const void * socket_address,
+    std::size_t socket_address_size,
+    int socket_protocol = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload3.html new file mode 100644 index 0000000..91a0a49 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload3.html @@ -0,0 +1,44 @@ + + + +generic::basic_endpoint::basic_endpoint (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an endpoint from the specific endpoint type. +

+
template<
+    typename Endpoint>
+basic_endpoint(
+    const Endpoint & endpoint);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload4.html new file mode 100644 index 0000000..2dac795 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload4.html @@ -0,0 +1,42 @@ + + + +generic::basic_endpoint::basic_endpoint (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_endpoint(
+    const basic_endpoint & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload5.html new file mode 100644 index 0000000..a1162f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/basic_endpoint/overload5.html @@ -0,0 +1,42 @@ + + + +generic::basic_endpoint::basic_endpoint (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_endpoint(
+    basic_endpoint && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/capacity.html new file mode 100644 index 0000000..e3ad560 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/capacity.html @@ -0,0 +1,42 @@ + + + +generic::basic_endpoint::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the capacity of the endpoint in the native type. +

+
std::size_t capacity() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data.html new file mode 100644 index 0000000..ee7a3cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data.html @@ -0,0 +1,46 @@ + + + +generic::basic_endpoint::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the underlying endpoint in the native type. +

+
data_type * data();
+  » more...
+
+const data_type * data() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data/overload1.html new file mode 100644 index 0000000..ccc363f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data/overload1.html @@ -0,0 +1,41 @@ + + + +generic::basic_endpoint::data (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying endpoint in the native type. +

+
data_type * data();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data/overload2.html new file mode 100644 index 0000000..aa71a25 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data/overload2.html @@ -0,0 +1,41 @@ + + + +generic::basic_endpoint::data (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying endpoint in the native type. +

+
const data_type * data() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data_type.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data_type.html new file mode 100644 index 0000000..8b27f35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/data_type.html @@ -0,0 +1,53 @@ + + + +generic::basic_endpoint::data_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the endpoint structure. This type is dependent on the underlying + implementation of the socket layer. +

+
typedef implementation_defined data_type;
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_.html new file mode 100644 index 0000000..059af37 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_.html @@ -0,0 +1,51 @@ + + + +generic::basic_endpoint::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + from another endpoint. +

+
basic_endpoint & operator=(
+    const basic_endpoint & other);
+  » more...
+
+

+ Move-assign from another endpoint. +

+
basic_endpoint & operator=(
+    basic_endpoint && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_/overload1.html new file mode 100644 index 0000000..6c88467 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +generic::basic_endpoint::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another endpoint. +

+
basic_endpoint & operator=(
+    const basic_endpoint & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_/overload2.html new file mode 100644 index 0000000..951f4be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +generic::basic_endpoint::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another endpoint. +

+
basic_endpoint & operator=(
+    basic_endpoint && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq__eq_.html new file mode 100644 index 0000000..d3442e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +generic::basic_endpoint::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two endpoints for equality. +

+
bool operator==(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_gt_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_gt_.html new file mode 100644 index 0000000..243b103 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_gt_.html @@ -0,0 +1,54 @@ + + + +generic::basic_endpoint::operator> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator>(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_gt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_gt__eq_.html new file mode 100644 index 0000000..1069b01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_gt__eq_.html @@ -0,0 +1,54 @@ + + + +generic::basic_endpoint::operator>= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator>=(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_lt_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_lt_.html new file mode 100644 index 0000000..0c23d35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_lt_.html @@ -0,0 +1,54 @@ + + + +generic::basic_endpoint::operator< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator<(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_lt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_lt__eq_.html new file mode 100644 index 0000000..ddfd799 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_lt__eq_.html @@ -0,0 +1,54 @@ + + + +generic::basic_endpoint::operator<= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator<=(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_not__eq_.html new file mode 100644 index 0000000..0cf6173 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +generic::basic_endpoint::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two endpoints for inequality. +

+
bool operator!=(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/protocol.html new file mode 100644 index 0000000..1929467 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/protocol.html @@ -0,0 +1,42 @@ + + + +generic::basic_endpoint::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol associated with the endpoint. +

+
protocol_type protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/protocol_type.html new file mode 100644 index 0000000..1463e9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/protocol_type.html @@ -0,0 +1,52 @@ + + + +generic::basic_endpoint::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type associated with the endpoint. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/generic/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/resize.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/resize.html new file mode 100644 index 0000000..e23a0f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/resize.html @@ -0,0 +1,43 @@ + + + +generic::basic_endpoint::resize + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the underlying size of the endpoint in the native type. +

+
void resize(
+    std::size_t new_size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/size.html b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/size.html new file mode 100644 index 0000000..851c1af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__basic_endpoint/size.html @@ -0,0 +1,42 @@ + + + +generic::basic_endpoint::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the underlying size of the endpoint in the native type. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol.html new file mode 100644 index 0000000..4cbe208 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol.html @@ -0,0 +1,253 @@ + + + +generic::datagram_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for a generic datagram-oriented socket. +

+
class datagram_protocol
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint +

+ 		+

+ The type of an endpoint. +

+
+

+ socket +

+ 		+

+ The generic socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ datagram_protocol [constructor] +

+ 		+

+ Construct a protocol object for a specific address family and protocol. +
—
Construct a generic protocol object from a specific + protocol. +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two protocols for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two protocols for equality. +

+
+

+ The generic::datagram_protocol class contains + flags necessary for datagram-oriented sockets of any address family and protocol. +

+
+ + Examples +
+

+ Constructing using a native address family and socket protocol: +

+
datagram_protocol p(AF_INET, IPPROTO_UDP);
+
+

+ Constructing from a specific protocol type: +

+
datagram_protocol p(asio::ip::udp::v4());
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/generic/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol.html new file mode 100644 index 0000000..6f71bb9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol.html @@ -0,0 +1,54 @@ + + + +generic::datagram_protocol::datagram_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a protocol object for a specific address family and protocol. +

+
datagram_protocol(
+    int address_family,
+    int socket_protocol);
+  » more...
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+datagram_protocol(
+    const Protocol & source_protocol);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol/overload1.html new file mode 100644 index 0000000..20ff222 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol/overload1.html @@ -0,0 +1,43 @@ + + + +generic::datagram_protocol::datagram_protocol (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a protocol object for a specific address family and protocol. +

+
datagram_protocol(
+    int address_family,
+    int socket_protocol);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol/overload2.html new file mode 100644 index 0000000..f6c6d58 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/datagram_protocol/overload2.html @@ -0,0 +1,58 @@ + + + +generic::datagram_protocol::datagram_protocol (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+datagram_protocol(
+    const Protocol & source_protocol);
+
+
+ + Exceptions +
+
+

+
+
+
+
+
+

+ c bad_cast Thrown if the source protocol is not datagram-oriented. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/endpoint.html new file mode 100644 index 0000000..8bf46f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/endpoint.html @@ -0,0 +1,332 @@ + + + +generic::datagram_protocol::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of an endpoint. +

+
typedef basic_endpoint< datagram_protocol > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint from + the specified socket address.
—
Construct an endpoint + from the specific endpoint type.
—
Copy constructor. +
—
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ The generic::basic_endpoint class template + describes an endpoint that may be associated with any socket type. +

+
+ + Remarks +
+

+ The socket types sockaddr type must be able to fit into a sockaddr_storage structure. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/generic/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/family.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/family.html new file mode 100644 index 0000000..a003e2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/family.html @@ -0,0 +1,42 @@ + + + +generic::datagram_protocol::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/operator_eq__eq_.html new file mode 100644 index 0000000..09b8c7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +generic::datagram_protocol::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for equality. +

+
bool operator==(
+    const datagram_protocol & p1,
+    const datagram_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/operator_not__eq_.html new file mode 100644 index 0000000..389bebd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +generic::datagram_protocol::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for inequality. +

+
bool operator!=(
+    const datagram_protocol & p1,
+    const datagram_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/protocol.html new file mode 100644 index 0000000..1df7c4e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/protocol.html @@ -0,0 +1,42 @@ + + + +generic::datagram_protocol::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/socket.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/socket.html new file mode 100644 index 0000000..4d1a2a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/socket.html @@ -0,0 +1,913 @@ + + + +generic::datagram_protocol::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + generic socket type. +

+
typedef basic_datagram_socket< datagram_protocol > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_datagram_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_datagram_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_datagram_socket from another.
—
+ Move-assign a basic_datagram_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive a datagram with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send a datagram to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_datagram_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_datagram_socket class template + provides asynchronous and blocking datagram-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/generic/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/type.html b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/type.html new file mode 100644 index 0000000..e921bf6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__datagram_protocol/type.html @@ -0,0 +1,42 @@ + + + +generic::datagram_protocol::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the type of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol.html new file mode 100644 index 0000000..6626552 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol.html @@ -0,0 +1,253 @@ + + + +generic::raw_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for a generic raw socket. +

+
class raw_protocol
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint +

+ 		+

+ The type of an endpoint. +

+
+

+ socket +

+ 		+

+ The generic socket type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ raw_protocol [constructor] +

+ 		+

+ Construct a protocol object for a specific address family and protocol. +
—
Construct a generic protocol object from a specific + protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two protocols for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two protocols for equality. +

+
+

+ The generic::raw_protocol + class contains flags necessary for raw sockets of any address family and + protocol. +

+
+ + Examples +
+

+ Constructing using a native address family and socket protocol: +

+
raw_protocol p(AF_INET, IPPROTO_ICMP);
+
+

+ Constructing from a specific protocol type: +

+
raw_protocol p(asio::ip::icmp::v4());
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/generic/raw_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/endpoint.html new file mode 100644 index 0000000..513594b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/endpoint.html @@ -0,0 +1,332 @@ + + + +generic::raw_protocol::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of an endpoint. +

+
typedef basic_endpoint< raw_protocol > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint from + the specified socket address.
—
Construct an endpoint + from the specific endpoint type.
—
Copy constructor. +
—
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ The generic::basic_endpoint class template + describes an endpoint that may be associated with any socket type. +

+
+ + Remarks +
+

+ The socket types sockaddr type must be able to fit into a sockaddr_storage structure. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/generic/raw_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/family.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/family.html new file mode 100644 index 0000000..94b7f5a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/family.html @@ -0,0 +1,42 @@ + + + +generic::raw_protocol::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/operator_eq__eq_.html new file mode 100644 index 0000000..bfb142a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +generic::raw_protocol::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for equality. +

+
bool operator==(
+    const raw_protocol & p1,
+    const raw_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/raw_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/operator_not__eq_.html new file mode 100644 index 0000000..800d7b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +generic::raw_protocol::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for inequality. +

+
bool operator!=(
+    const raw_protocol & p1,
+    const raw_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/raw_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/protocol.html new file mode 100644 index 0000000..b9de2b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/protocol.html @@ -0,0 +1,42 @@ + + + +generic::raw_protocol::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol.html new file mode 100644 index 0000000..9d82f04 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol.html @@ -0,0 +1,54 @@ + + + +generic::raw_protocol::raw_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a protocol object for a specific address family and protocol. +

+
raw_protocol(
+    int address_family,
+    int socket_protocol);
+  » more...
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+raw_protocol(
+    const Protocol & source_protocol);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol/overload1.html new file mode 100644 index 0000000..a9804d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol/overload1.html @@ -0,0 +1,43 @@ + + + +generic::raw_protocol::raw_protocol (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a protocol object for a specific address family and protocol. +

+
raw_protocol(
+    int address_family,
+    int socket_protocol);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol/overload2.html new file mode 100644 index 0000000..1c71053 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/raw_protocol/overload2.html @@ -0,0 +1,58 @@ + + + +generic::raw_protocol::raw_protocol (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+raw_protocol(
+    const Protocol & source_protocol);
+
+
+ + Exceptions +
+
+

+
+
+
+
+
+

+ c bad_cast Thrown if the source protocol is not raw-oriented. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/socket.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/socket.html new file mode 100644 index 0000000..18bb6a4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/socket.html @@ -0,0 +1,912 @@ + + + +generic::raw_protocol::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + generic socket type. +

+
typedef basic_raw_socket< raw_protocol > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_raw_socket [constructor] +

+ 		+

+ Construct a basic_raw_socket without opening it.
—
+ Construct and open a basic_raw_socket.
—
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.
—
Move-construct a basic_raw_socket + from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_raw_socket from another.
—
Move-assign + a basic_raw_socket from a socket of another protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive raw data with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send raw data to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_raw_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_raw_socket + class template provides asynchronous and blocking raw-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/generic/raw_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/type.html b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/type.html new file mode 100644 index 0000000..bffcdf9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__raw_protocol/type.html @@ -0,0 +1,42 @@ + + + +generic::raw_protocol::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the type of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol.html new file mode 100644 index 0000000..422fa5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol.html @@ -0,0 +1,249 @@ + + + +generic::seq_packet_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for a generic sequenced packet socket. +

+
class seq_packet_protocol
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint +

+ 		+

+ The type of an endpoint. +

+
+

+ socket +

+ 		+

+ The generic socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ seq_packet_protocol [constructor] +

+ 		+

+ Construct a protocol object for a specific address family and protocol. +
—
Construct a generic protocol object from a specific + protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two protocols for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two protocols for equality. +

+
+

+ The generic::seq_packet_protocol class contains + flags necessary for seq_packet-oriented sockets of any address family and + protocol. +

+
+ + Examples +
+

+ Constructing using a native address family and socket protocol: +

+
seq_packet_protocol p(AF_INET, IPPROTO_SCTP);
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/generic/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/endpoint.html new file mode 100644 index 0000000..736236f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/endpoint.html @@ -0,0 +1,332 @@ + + + +generic::seq_packet_protocol::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of an endpoint. +

+
typedef basic_endpoint< seq_packet_protocol > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint from + the specified socket address.
—
Construct an endpoint + from the specific endpoint type.
—
Copy constructor. +
—
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ The generic::basic_endpoint class template + describes an endpoint that may be associated with any socket type. +

+
+ + Remarks +
+

+ The socket types sockaddr type must be able to fit into a sockaddr_storage structure. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/generic/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/family.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/family.html new file mode 100644 index 0000000..864df64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/family.html @@ -0,0 +1,42 @@ + + + +generic::seq_packet_protocol::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/operator_eq__eq_.html new file mode 100644 index 0000000..d930f9d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +generic::seq_packet_protocol::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for equality. +

+
bool operator==(
+    const seq_packet_protocol & p1,
+    const seq_packet_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/operator_not__eq_.html new file mode 100644 index 0000000..f884db0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +generic::seq_packet_protocol::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for inequality. +

+
bool operator!=(
+    const seq_packet_protocol & p1,
+    const seq_packet_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/protocol.html new file mode 100644 index 0000000..66c017e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/protocol.html @@ -0,0 +1,42 @@ + + + +generic::seq_packet_protocol::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol.html new file mode 100644 index 0000000..a56df30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol.html @@ -0,0 +1,54 @@ + + + +generic::seq_packet_protocol::seq_packet_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a protocol object for a specific address family and protocol. +

+
seq_packet_protocol(
+    int address_family,
+    int socket_protocol);
+  » more...
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+seq_packet_protocol(
+    const Protocol & source_protocol);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol/overload1.html new file mode 100644 index 0000000..a037678 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol/overload1.html @@ -0,0 +1,43 @@ + + + +generic::seq_packet_protocol::seq_packet_protocol (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a protocol object for a specific address family and protocol. +

+
seq_packet_protocol(
+    int address_family,
+    int socket_protocol);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol/overload2.html new file mode 100644 index 0000000..ba21f77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/seq_packet_protocol/overload2.html @@ -0,0 +1,59 @@ + + + +generic::seq_packet_protocol::seq_packet_protocol (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+seq_packet_protocol(
+    const Protocol & source_protocol);
+
+
+ + Exceptions +
+
+

+
+
+
+
+
+

+ c bad_cast Thrown if the source protocol is not based around sequenced + packets. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/socket.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/socket.html new file mode 100644 index 0000000..db51f73 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/socket.html @@ -0,0 +1,866 @@ + + + +generic::seq_packet_protocol::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + generic socket type. +

+
typedef basic_seq_packet_socket< seq_packet_protocol > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_seq_packet_socket [constructor] +

+ 		+

+ Construct a basic_seq_packet_socket without opening it.
+ —
Construct and open a basic_seq_packet_socket.
— +
Construct a basic_seq_packet_socket, opening it and binding + it to the given local endpoint.
—
Construct a basic_seq_packet_socket + on an existing native socket.
—
Move-construct a + basic_seq_packet_socket from another.
—
Move-construct + a basic_seq_packet_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_seq_packet_socket from another.
—
+ Move-assign a basic_seq_packet_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_seq_packet_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_seq_packet_socket class + template provides asynchronous and blocking sequenced packet socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single socket object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/generic/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/type.html b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/type.html new file mode 100644 index 0000000..b99f440 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__seq_packet_protocol/type.html @@ -0,0 +1,42 @@ + + + +generic::seq_packet_protocol::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the type of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol.html new file mode 100644 index 0000000..4595ec5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol.html @@ -0,0 +1,264 @@ + + + +generic::stream_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for a generic stream-oriented socket. +

+
class stream_protocol
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint +

+ 		+

+ The type of an endpoint. +

+
+

+ iostream +

+ 		+

+ The generic socket iostream type. +

+
+

+ socket +

+ 		+

+ The generic socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ stream_protocol [constructor] +

+ 		+

+ Construct a protocol object for a specific address family and protocol. +
—
Construct a generic protocol object from a specific + protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two protocols for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two protocols for equality. +

+
+

+ The generic::stream_protocol class contains flags + necessary for stream-oriented sockets of any address family and protocol. +

+
+ + Examples +
+

+ Constructing using a native address family and socket protocol: +

+
stream_protocol p(AF_INET, IPPROTO_TCP);
+
+

+ Constructing from a specific protocol type: +

+
stream_protocol p(asio::ip::tcp::v4());
+
+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/generic/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/endpoint.html new file mode 100644 index 0000000..4478c5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/endpoint.html @@ -0,0 +1,332 @@ + + + +generic::stream_protocol::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of an endpoint. +

+
typedef basic_endpoint< stream_protocol > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint from + the specified socket address.
—
Construct an endpoint + from the specific endpoint type.
—
Copy constructor. +
—
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ The generic::basic_endpoint class template + describes an endpoint that may be associated with any socket type. +

+
+ + Remarks +
+

+ The socket types sockaddr type must be able to fit into a sockaddr_storage structure. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/generic/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/family.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/family.html new file mode 100644 index 0000000..12da035 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/family.html @@ -0,0 +1,42 @@ + + + +generic::stream_protocol::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/iostream.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/iostream.html new file mode 100644 index 0000000..37e93d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/iostream.html @@ -0,0 +1,286 @@ + + + +generic::stream_protocol::iostream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + generic socket iostream type. +

+
typedef basic_socket_iostream< stream_protocol > iostream;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ time_point +

+ 		+

+ The time type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_socket_iostream [constructor] +

+ 		+

+ Construct a basic_socket_iostream without establishing a connection. +
—
Construct a basic_socket_iostream from the supplied + socket.
—
Move-construct a basic_socket_iostream + from another.
—
Establish a connection to an endpoint + corresponding to a resolver query. +

+
+

+ close +

+ 		+

+ Close the connection. +

+
+

+ connect +

+ 		+

+ Establish a connection to an endpoint corresponding to a resolver + query. +

+
+

+ error +

+ 		+

+ Get the last error associated with the stream. +

+
+

+ expires_after +

+ 		+

+ Set the stream's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the stream's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the stream's expiry time as an absolute time. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_iostream from another. +

+
+

+ rdbuf +

+ 		+

+ Return a pointer to the underlying streambuf. +

+
+

+ socket +

+ 		+

+ Get a reference to the underlying socket. +

+
+
+ + Requirements +
+

+ Header: asio/generic/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/operator_eq__eq_.html new file mode 100644 index 0000000..94748ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +generic::stream_protocol::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for equality. +

+
bool operator==(
+    const stream_protocol & p1,
+    const stream_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/operator_not__eq_.html new file mode 100644 index 0000000..e71caf7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +generic::stream_protocol::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two protocols for inequality. +

+
bool operator!=(
+    const stream_protocol & p1,
+    const stream_protocol & p2);
+
+
+ + Requirements +
+

+ Header: asio/generic/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/protocol.html new file mode 100644 index 0000000..ee342f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/protocol.html @@ -0,0 +1,42 @@ + + + +generic::stream_protocol::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/socket.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/socket.html new file mode 100644 index 0000000..7994b28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/socket.html @@ -0,0 +1,915 @@ + + + +generic::stream_protocol::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + generic socket type. +

+
typedef basic_stream_socket< stream_protocol > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_stream_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_stream_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_socket from another.
—
+ Move-assign a basic_stream_socket from a socket of another protocol + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the socket. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the socket. +

+
+

+ ~basic_stream_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_stream_socket + class template provides asynchronous and blocking stream-oriented socket + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single socket object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/generic/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol.html new file mode 100644 index 0000000..06a368f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol.html @@ -0,0 +1,54 @@ + + + +generic::stream_protocol::stream_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a protocol object for a specific address family and protocol. +

+
stream_protocol(
+    int address_family,
+    int socket_protocol);
+  » more...
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+stream_protocol(
+    const Protocol & source_protocol);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol/overload1.html new file mode 100644 index 0000000..b68d50f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol/overload1.html @@ -0,0 +1,43 @@ + + + +generic::stream_protocol::stream_protocol (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a protocol object for a specific address family and protocol. +

+
stream_protocol(
+    int address_family,
+    int socket_protocol);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol/overload2.html new file mode 100644 index 0000000..a4d89d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/stream_protocol/overload2.html @@ -0,0 +1,58 @@ + + + +generic::stream_protocol::stream_protocol (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a generic protocol object from a specific protocol. +

+
template<
+    typename Protocol>
+stream_protocol(
+    const Protocol & source_protocol);
+
+
+ + Exceptions +
+
+

+
+
+
+
+
+

+ c bad_cast Thrown if the source protocol is not stream-oriented. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/type.html b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/type.html new file mode 100644 index 0000000..c4605f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/generic__stream_protocol/type.html @@ -0,0 +1,42 @@ + + + +generic::stream_protocol::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the type of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator.html new file mode 100644 index 0000000..4bdec18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator.html @@ -0,0 +1,65 @@ + + + +get_associated_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper function to obtain an object's associated allocator. +

+
template<
+    typename T>
+associated_allocator< T >::type get_associated_allocator(
+    const T & t);
+  » more...
+
+template<
+    typename T,
+    typename Allocator>
+auto get_associated_allocator(
+    const T & t,
+    const Allocator & a);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/associated_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator/overload1.html new file mode 100644 index 0000000..5f429f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator/overload1.html @@ -0,0 +1,52 @@ + + + +get_associated_allocator (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated allocator. +

+
template<
+    typename T>
+associated_allocator< T >::type get_associated_allocator(
+    const T & t);
+
+
+ + Return + Value +
+

+ associated_allocator<T>::get(t) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator/overload2.html new file mode 100644 index 0000000..c1ff992 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_allocator/overload2.html @@ -0,0 +1,55 @@ + + + +get_associated_allocator (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated allocator. +

+
template<
+    typename T,
+    typename Allocator>
+auto get_associated_allocator(
+    const T & t,
+    const Allocator & a);
+
+
+ + Return + Value +
+

+ associated_allocator<T, Allocator>::get(t, + a) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot.html new file mode 100644 index 0000000..8ee41c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot.html @@ -0,0 +1,65 @@ + + + +get_associated_cancellation_slot + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper function to obtain an object's associated cancellation_slot. +

+
template<
+    typename T>
+associated_cancellation_slot< T >::type get_associated_cancellation_slot(
+    const T & t);
+  » more...
+
+template<
+    typename T,
+    typename CancellationSlot>
+auto get_associated_cancellation_slot(
+    const T & t,
+    const CancellationSlot & st);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/associated_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot/overload1.html new file mode 100644 index 0000000..6857549 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot/overload1.html @@ -0,0 +1,52 @@ + + + +get_associated_cancellation_slot (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated cancellation_slot. +

+
template<
+    typename T>
+associated_cancellation_slot< T >::type get_associated_cancellation_slot(
+    const T & t);
+
+
+ + Return + Value +
+

+ associated_cancellation_slot<T>::get(t) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot/overload2.html new file mode 100644 index 0000000..8da12db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_cancellation_slot/overload2.html @@ -0,0 +1,55 @@ + + + +get_associated_cancellation_slot (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated cancellation_slot. +

+
template<
+    typename T,
+    typename CancellationSlot>
+auto get_associated_cancellation_slot(
+    const T & t,
+    const CancellationSlot & st);
+
+
+ + Return + Value +
+

+ associated_cancellation_slot<T, CancellationSlot>::get(t, + st) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor.html new file mode 100644 index 0000000..96a367e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor.html @@ -0,0 +1,75 @@ + + + +get_associated_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper function to obtain an object's associated executor. +

+
template<
+    typename T>
+associated_executor< T >::type get_associated_executor(
+    const T & t);
+  » more...
+
+template<
+    typename T,
+    typename Executor>
+auto get_associated_executor(
+    const T & t,
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename T,
+    typename ExecutionContext>
+associated_executor< T, typenameExecutionContext::executor_type >::type get_associated_executor(
+    const T & t,
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/associated_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload1.html new file mode 100644 index 0000000..48c2ba6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload1.html @@ -0,0 +1,52 @@ + + + +get_associated_executor (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated executor. +

+
template<
+    typename T>
+associated_executor< T >::type get_associated_executor(
+    const T & t);
+
+
+ + Return + Value +
+

+ associated_executor<T>::get(t) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload2.html new file mode 100644 index 0000000..adacb13 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload2.html @@ -0,0 +1,56 @@ + + + +get_associated_executor (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated executor. +

+
template<
+    typename T,
+    typename Executor>
+auto get_associated_executor(
+    const T & t,
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+ + Return + Value +
+

+ associated_executor<T, Executor>::get(t, + ex) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload3.html new file mode 100644 index 0000000..42e5d20 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_executor/overload3.html @@ -0,0 +1,56 @@ + + + +get_associated_executor (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated executor. +

+
template<
+    typename T,
+    typename ExecutionContext>
+associated_executor< T, typenameExecutionContext::executor_type >::type get_associated_executor(
+    const T & t,
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Return + Value +
+

+ associated_executor<T, typename + ExecutionContext::executor_type>::get(t, ctx.get_executor()) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor.html new file mode 100644 index 0000000..16fe8c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor.html @@ -0,0 +1,69 @@ + + + +get_associated_immediate_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper function to obtain an object's associated executor. +

+
template<
+    typename T,
+    typename Executor>
+auto get_associated_immediate_executor(
+    const T & t,
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename T,
+    typename ExecutionContext>
+associated_immediate_executor< T, typenameExecutionContext::executor_type >::type get_associated_immediate_executor(
+    const T & t,
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/associated_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor/overload1.html new file mode 100644 index 0000000..d67af55 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor/overload1.html @@ -0,0 +1,56 @@ + + + +get_associated_immediate_executor (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated executor. +

+
template<
+    typename T,
+    typename Executor>
+auto get_associated_immediate_executor(
+    const T & t,
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+ + Return + Value +
+

+ associated_immediate_executor<T, Executor>::get(t, + ex) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor/overload2.html new file mode 100644 index 0000000..13ec812 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/get_associated_immediate_executor/overload2.html @@ -0,0 +1,55 @@ + + + +get_associated_immediate_executor (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Helper function to obtain an object's associated executor. +

+
template<
+    typename T,
+    typename ExecutionContext>
+associated_immediate_executor< T, typenameExecutionContext::executor_type >::type get_associated_immediate_executor(
+    const T & t,
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Return + Value +
+

+ associated_immediate_executor<T, typename ExecutionContext::executor_type>::get(t, ctx.get_executor()) +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/high_resolution_timer.html b/Packages/asio-1.36.0/doc/asio/reference/high_resolution_timer.html new file mode 100644 index 0000000..46f194b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/high_resolution_timer.html @@ -0,0 +1,428 @@ + + + +high_resolution_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for a timer based on the high resolution clock. +

+
typedef basic_waitable_timer< chrono::high_resolution_clock > high_resolution_timer;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type of the clock. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_point +

+ 		+

+ The time point type of the clock. +

+
+

+ traits_type +

+ 		+

+ The wait traits type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_waitable_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a particular + expiry time relative to now.
—
Move-construct a basic_waitable_timer + from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_after +

+ 		+

+ Set the timer's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the timer's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the timer's expiry time as an absolute time. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_waitable_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_waitable_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ 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 one of the steady_timer, system_timer or high_resolution_timer typedefs. +

+
+ + Remarks +
+

+ This waitable timer functionality is for use with the C++11 standard library's + <chrono> facility, or with the Boost.Chrono library. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait (C++11): +

+
// Construct a timer without setting an expiry time.
+asio::steady_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_after(std::chrono::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait (C++11): +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::steady_timer timer(my_context,
+    std::chrono::steady_clock::now() + std::chrono::seconds(60));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + 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: +

+
void on_some_event()
+{
+  if (my_timer.expires_after(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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The asio::basic_waitable_timer::expires_after() + 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+

+ 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 basic_waitable_timer template directly: +

+
typedef basic_waitable_timer<boost::chrono::high_resolution_clock> timer;
+
+
+ + Requirements +
+

+ Header: asio/high_resolution_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder.html new file mode 100644 index 0000000..5d0d80b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder.html @@ -0,0 +1,248 @@ + + + +immediate_executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A call wrapper type to bind a immediate executor of type Executor + to an object of type T. +

+
template<
+    typename T,
+    typename Executor>
+class immediate_executor_binder
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ argument_type +

+ 		+

+ The type of the function's argument. +

+
+

+ first_argument_type +

+ 		+

+ The type of the function's first argument. +

+
+

+ immediate_executor_type +

+ 		+

+ The type of the associated immediate executor. +

+
+

+ result_type +

+ 		+

+ The return type if a function. +

+
+

+ second_argument_type +

+ 		+

+ The type of the function's second argument. +

+
+

+ target_type +

+ 		+

+ The type of the target object. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get +

+ 		+

+ Obtain a reference to the target object. +

+
+

+ get_immediate_executor +

+ 		+

+ Obtain the associated immediate executor. +

+
+

+ immediate_executor_binder [constructor] +

+ 		+

+ Construct a immediate executor wrapper for the specified object. +
—
Copy constructor.
—
Construct a copy, + but specify a different immediate executor.
—
Construct + a copy of a different immediate executor wrapper type.
— +
Construct a copy of a different immediate executor wrapper + type, but specify a different immediate executor.
—
+ Move constructor.
—
Move construct the target object, + but specify a different immediate executor.
—
Move + construct from a different immediate executor wrapper type.
+ —
Move construct from a different immediate executor wrapper + type, but specify a different immediate executor. +

+
+

+ operator() +

+ 		+

+ Forwarding function call operator. +

+
+

+ ~immediate_executor_binder [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/_immediate_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/_immediate_executor_binder.html new file mode 100644 index 0000000..11a14e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/_immediate_executor_binder.html @@ -0,0 +1,41 @@ + + + +immediate_executor_binder::~immediate_executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~immediate_executor_binder();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/argument_type.html new file mode 100644 index 0000000..37c7c6b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/argument_type.html @@ -0,0 +1,74 @@ + + + +immediate_executor_binder::argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's argument. +

+
typedef see_below argument_type;
+
+

+ The type of argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting a single argument, argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type argument_type, + then argument_type + is a synonym for T::argument_type; +
    • +
  • + otherwise argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/first_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/first_argument_type.html new file mode 100644 index 0000000..c32644d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/first_argument_type.html @@ -0,0 +1,74 @@ + + + +immediate_executor_binder::first_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's first argument. +

+
typedef see_below first_argument_type;
+
+

+ The type of first_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, first_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then first_argument_type + is a synonym for T::first_argument_type; +
    • +
  • + otherwise first_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get.html new file mode 100644 index 0000000..2236e5f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get.html @@ -0,0 +1,46 @@ + + + +immediate_executor_binder::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a reference to the target object. +

+
target_type & get();
+  » more...
+
+const target_type & get() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get/overload1.html new file mode 100644 index 0000000..bdc9fbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get/overload1.html @@ -0,0 +1,41 @@ + + + +immediate_executor_binder::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
target_type & get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get/overload2.html new file mode 100644 index 0000000..c9009f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get/overload2.html @@ -0,0 +1,41 @@ + + + +immediate_executor_binder::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain a reference to the target object. +

+
const target_type & get() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get_immediate_executor.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get_immediate_executor.html new file mode 100644 index 0000000..a882123 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/get_immediate_executor.html @@ -0,0 +1,42 @@ + + + +immediate_executor_binder::get_immediate_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the associated immediate executor. +

+
immediate_executor_type get_immediate_executor() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder.html new file mode 100644 index 0000000..071c45b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder.html @@ -0,0 +1,127 @@ + + + +immediate_executor_binder::immediate_executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a immediate executor wrapper for the specified object. +

+
template<
+    typename U>
+immediate_executor_binder(
+    const immediate_executor_type & e,
+    U && u);
+  » more...
+
+

+ Copy constructor. +

+
immediate_executor_binder(
+    const immediate_executor_binder & other);
+  » more...
+
+

+ Construct a copy, but specify a different immediate executor. +

+
immediate_executor_binder(
+    const immediate_executor_type & e,
+    const immediate_executor_binder & other);
+  » more...
+
+

+ Construct a copy of a different immediate executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    const immediate_executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Construct a copy of a different immediate executor wrapper type, but specify + a different immediate executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    const immediate_executor_type & e,
+    const immediate_executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move constructor. +

+
immediate_executor_binder(
+    immediate_executor_binder && other);
+  » more...
+
+

+ Move construct the target object, but specify a different immediate executor. +

+
immediate_executor_binder(
+    const immediate_executor_type & e,
+    immediate_executor_binder && other);
+  » more...
+
+

+ Move construct from a different immediate executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    immediate_executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+

+ Move construct from a different immediate executor wrapper type, but specify + a different immediate executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    const immediate_executor_type & e,
+    immediate_executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload1.html new file mode 100644 index 0000000..1c8d14a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload1.html @@ -0,0 +1,49 @@ + + + +immediate_executor_binder::immediate_executor_binder (1 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a immediate executor wrapper for the specified object. +

+
template<
+    typename U>
+immediate_executor_binder(
+    const immediate_executor_type & e,
+    U && u);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload2.html new file mode 100644 index 0000000..e6801b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload2.html @@ -0,0 +1,42 @@ + + + +immediate_executor_binder::immediate_executor_binder (2 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
immediate_executor_binder(
+    const immediate_executor_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload3.html new file mode 100644 index 0000000..52356ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload3.html @@ -0,0 +1,43 @@ + + + +immediate_executor_binder::immediate_executor_binder (3 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy, but specify a different immediate executor. +

+
immediate_executor_binder(
+    const immediate_executor_type & e,
+    const immediate_executor_binder & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload4.html new file mode 100644 index 0000000..95174ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload4.html @@ -0,0 +1,53 @@ + + + +immediate_executor_binder::immediate_executor_binder (4 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different immediate executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    const immediate_executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the Executor + type is constructible from type OtherExecutor, + and the type T is constructible + from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload5.html new file mode 100644 index 0000000..0f9a3a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload5.html @@ -0,0 +1,52 @@ + + + +immediate_executor_binder::immediate_executor_binder (5 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a copy of a different immediate executor wrapper type, but + specify a different immediate executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    const immediate_executor_type & e,
+    const immediate_executor_binder< U, OtherExecutor > & other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+

+ This constructor is only valid if the type T + is constructible from type U. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload6.html new file mode 100644 index 0000000..116c8fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload6.html @@ -0,0 +1,42 @@ + + + +immediate_executor_binder::immediate_executor_binder (6 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
immediate_executor_binder(
+    immediate_executor_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload7.html new file mode 100644 index 0000000..3261563 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload7.html @@ -0,0 +1,43 @@ + + + +immediate_executor_binder::immediate_executor_binder (7 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct the target object, but specify a different immediate executor. +

+
immediate_executor_binder(
+    const immediate_executor_type & e,
+    immediate_executor_binder && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload8.html new file mode 100644 index 0000000..f3e06b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload8.html @@ -0,0 +1,47 @@ + + + +immediate_executor_binder::immediate_executor_binder (8 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different immediate executor wrapper type. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    immediate_executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< Executor, OtherExecutor >::value >  = 0,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload9.html new file mode 100644 index 0000000..7c3dfe9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_binder/overload9.html @@ -0,0 +1,48 @@ + + + +immediate_executor_binder::immediate_executor_binder (9 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct from a different immediate executor wrapper type, but + specify a different immediate executor. +

+
template<
+    typename U,
+    typename OtherExecutor>
+immediate_executor_binder(
+    const immediate_executor_type & e,
+    immediate_executor_binder< U, OtherExecutor > && other,
+    constraint_t< is_constructible< T, U >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_type.html new file mode 100644 index 0000000..e7e56e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/immediate_executor_type.html @@ -0,0 +1,52 @@ + + + +immediate_executor_binder::immediate_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the associated immediate executor. +

+
typedef Executor immediate_executor_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_.html new file mode 100644 index 0000000..a7a0dfa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_.html @@ -0,0 +1,58 @@ + + + +immediate_executor_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forwarding + function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+  » more...
+
+template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..2794e27 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload1.html @@ -0,0 +1,44 @@ + + + +immediate_executor_binder::operator() (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..fb815cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload2.html @@ -0,0 +1,44 @@ + + + +immediate_executor_binder::operator() (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload3.html new file mode 100644 index 0000000..38e04f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/operator_lp__rp_/overload3.html @@ -0,0 +1,44 @@ + + + +immediate_executor_binder::operator() (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Forwarding function call operator. +

+
template<
+    typename... Args>
+result_of_t< T(Args...)> operator()(
+    Args &&... args) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/result_type.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/result_type.html new file mode 100644 index 0000000..e9bef75 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/result_type.html @@ -0,0 +1,74 @@ + + + +immediate_executor_binder::result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + return type if a function. +

+
typedef see_below result_type;
+
+

+ The type of result_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + function type, result_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type result_type, + then result_type is + a synonym for T::result_type; +
    • +
  • + otherwise result_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/second_argument_type.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/second_argument_type.html new file mode 100644 index 0000000..3660af4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/second_argument_type.html @@ -0,0 +1,74 @@ + + + +immediate_executor_binder::second_argument_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function's second argument. +

+
typedef see_below second_argument_type;
+
+

+ The type of second_argument_type + is based on the type T + of the wrapper's target object: +

+
    +
  • + if T is a pointer to + a function type accepting two arguments, second_argument_type + is a synonym for the return type of T; +
    • +
  • + if T is a class type + with a member type first_argument_type, + then second_argument_type + is a synonym for T::second_argument_type; +
    • +
  • + otherwise second_argument_type + is not defined. +
    • +
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/target_type.html b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/target_type.html new file mode 100644 index 0000000..8e44895 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/immediate_executor_binder/target_type.html @@ -0,0 +1,52 @@ + + + +immediate_executor_binder::target_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the target object. +

+
typedef T target_type;
+
+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/invalid_service_owner.html b/Packages/asio-1.36.0/doc/asio/reference/invalid_service_owner.html new file mode 100644 index 0000000..f84f9d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/invalid_service_owner.html @@ -0,0 +1,86 @@ + + + +invalid_service_owner + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Exception thrown when trying to add a service object to an execution_context where the service + has a different owner. +

+
class invalid_service_owner :
+  public std::logic_error
+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ invalid_service_owner [constructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/invalid_service_owner/invalid_service_owner.html b/Packages/asio-1.36.0/doc/asio/reference/invalid_service_owner/invalid_service_owner.html new file mode 100644 index 0000000..d214865 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/invalid_service_owner/invalid_service_owner.html @@ -0,0 +1,40 @@ + + + +invalid_service_owner::invalid_service_owner + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
invalid_service_owner();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context.html b/Packages/asio-1.36.0/doc/asio/reference/io_context.html new file mode 100644 index 0000000..3b76d2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context.html @@ -0,0 +1,627 @@ + + + +io_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides core I/O functionality. +

+
class io_context :
+  public execution_context
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_executor_type +

+ 		+

+ Executor implementation type used to submit functions to an io_context. +

+
+

+ service +

+ 		+

+ Base class for all io_context services. +

+
+

+ strand +

+ 		+

+ Provides serialised handler execution. +

+
+

+ count_type +

+ 		+

+ The type used to count the number of handlers executed by the context. +

+
+

+ executor_type +

+ 		+

+ Executor used to submit functions to an io_context. +

+
+

+ fork_event +

+ 		+

+ Fork-related event notifications. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get_executor +

+ 		+

+ Obtains the executor associated with the io_context. +

+
+

+ io_context [constructor] +

+ 		+

+ Constructor. +

+
+

+ notify_fork +

+ 		+

+ Notify the execution_context of a fork-related event. +

+
+

+ poll +

+ 		+

+ Run the io_context object's event processing loop to execute ready + handlers. +

+
+

+ poll_one +

+ 		+

+ Run the io_context object's event processing loop to execute one + ready handler. +

+
+

+ restart +

+ 		+

+ Restart the io_context in preparation for a subsequent run() invocation. +

+
+

+ run +

+ 		+

+ Run the io_context object's event processing loop. +

+
+

+ run_for +

+ 		+

+ Run the io_context object's event processing loop for a specified + duration. +

+
+

+ run_one +

+ 		+

+ Run the io_context object's event processing loop to execute at + most one handler. +

+
+

+ run_one_for +

+ 		+

+ Run the io_context object's event processing loop for a specified + duration to execute at most one handler. +

+
+

+ run_one_until +

+ 		+

+ Run the io_context object's event processing loop until a specified + time to execute at most one handler. +

+
+

+ run_until +

+ 		+

+ Run the io_context object's event processing loop until a specified + time. +

+
+

+ stop +

+ 		+

+ Stop the io_context object's event processing loop. +

+
+

+ stopped +

+ 		+

+ Determine whether the io_context object has been stopped. +

+
+

+ wrap +

+ 		+

+ (Deprecated: Use asio::bind_executor().) Create a new handler that + automatically dispatches the wrapped handler on the io_context. +

+
+

+ ~io_context [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ destroy +

+ 		+

+ Destroys all services in the context. +

+
+

+ shutdown +

+ 		+

+ Shuts down all services in the context. +

+
+
+ + Friends +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ use_service +

+ 		+
+

+ The io_context + class provides the core I/O functionality for users of the asynchronous I/O + objects, including: +

+
    +
  • + asio::ip::tcp::socket +
    • +
  • + asio::ip::tcp::acceptor +
    • +
  • + asio::ip::udp::socket +
    • +
  • + deadline_timer. +
    • +
+

+ The io_context + class also includes facilities intended for developers of custom asynchronous + services. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe, with the + specific exceptions of the restart() and notify_fork() functions. Calling restart() while there are unfinished run(), + run_one(), + run_for(), + run_until(), + poll() + or poll_one() + calls results in undefined behaviour. The notify_fork() function should not be called while any + io_context + function, or any function on an I/O object that is associated with the io_context, + is being called in another thread. +

+
+ + Synchronous + and asynchronous operations +
+

+ Synchronous operations on I/O objects implicitly run the io_context object for an individual + operation. The io_context + functions run(), + run_one(), + run_for(), + run_until(), + poll() + or poll_one() + must be called for the io_context 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(), + run_for(), + run_until(), + poll() + or poll_one() + for the io_context. +

+
+ + 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(), run_for(), run_until(), 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(), run_for(), run_until(), poll() or poll_one() call may be restarted without + the need for an intervening call to restart(). This allows the thread to rejoin the + io_context + object's thread pool without impacting any other threads in the pool. +

+

+ For example: +

+
asio::io_context io_context;
+...
+for (;;)
+{
+  try
+  {
+    io_context.run();
+    break; // run() exited normally
+  }
+  catch (my_exception& e)
+  {
+    // Deal with exception as appropriate.
+  }
+}
+
+
+ + Submitting + arbitrary tasks to the io_context +
+

+ To submit functions to the io_context, use the dispatch, post or defer free functions. +

+

+ For example: +

+
void my_task()
+{
+  ...
+}
+
+...
+
+asio::io_context io_context;
+
+// Submit a function to the io_context.
+asio::post(io_context, my_task);
+
+// Submit a lambda object to the io_context.
+asio::post(io_context,
+    []()
+    {
+      ...
+    });
+
+// Run the io_context until it runs out of work.
+io_context.run();
+
+
+ + Stopping + the io_context from running out of work +
+

+ Some applications may need to prevent an io_context object's run() call + from returning when there is no more work to do. For example, the io_context 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 using the make_work_guard function to create + an object of type asio::executor_work_guard<io_context::executor_type>: +

+
asio::io_context io_context;
+asio::executor_work_guard<asio::io_context::executor_type>
+  = asio::make_work_guard(io_context);
+...
+
+

+ To effect a shutdown, the application will then need to call the io_context object's stop() + member function. This will cause the io_context run() call to return as soon as possible, abandoning + unfinished operations and without permitting ready handlers to be dispatched. +

+

+ Alternatively, if the application requires that all operations and handlers + be allowed to finish normally, the work object may be explicitly reset. +

+
asio::io_context io_context;
+asio::executor_work_guard<asio::io_context::executor_type>
+  = asio::make_work_guard(io_context);
+...
+work.reset(); // Allow run() to exit. 
+
+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/_io_context.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/_io_context.html new file mode 100644 index 0000000..9f4b378 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/_io_context.html @@ -0,0 +1,90 @@ + + + +io_context::~io_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~io_context();
+
+

+ On destruction, the io_context performs the following + sequence of operations: +

+
    +
  • + For each service object svc + in the io_context + set, in reverse order of the beginning of service object lifetime, + performs svc->shutdown(). +
    • +
  • + Uninvoked handler objects that were scheduled for deferred invocation + on the io_context, + or any associated strand, are destroyed. +
    • +
  • + For each service object svc + in the io_context + set, in reverse order of the beginning of service object lifetime, + performs delete static_cast<io_context::service*>(svc). +
    • +
+
+ + 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: +

+
    +
  • + 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. +
    • +
  • + To shut down the whole program, the io_context function stop() + is called to terminate any run() calls as soon as possible. The io_context + destructor defined above destroys all handlers, causing all shared_ptr references to all connection + objects to be destroyed. +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/count_type.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/count_type.html new file mode 100644 index 0000000..88551c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/count_type.html @@ -0,0 +1,52 @@ + + + +io_context::count_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type used to + count the number of handlers executed by the context. +

+
typedef std::size_t count_type;
+
+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/destroy.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/destroy.html new file mode 100644 index 0000000..19952ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/destroy.html @@ -0,0 +1,54 @@ + + + +io_context::destroy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Destroys all services + in the context. +

+
void destroy();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order * of the beginning of service object lifetime, performs + delete static_cast<execution_context::service*>(svc). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/executor_type.html new file mode 100644 index 0000000..49076c4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/executor_type.html @@ -0,0 +1,305 @@ + + + +io_context::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Executor + used to submit functions to an io_context. +

+
typedef basic_executor_type< std::allocator< void >, 0 > executor_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_executor_type [constructor] +

+ 		+

+ Copy constructor.
—
Move constructor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the io_context to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the io_context to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Execution function. +

+
+

+ on_work_finished +

+ 		+

+ Inform the io_context that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the io_context that it has some outstanding work to do. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+

+ post +

+ 		+

+ Request the io_context to invoke the given function object. +

+
+

+ query +

+ 		+

+ Query the current value of the context property.
—
+ Query the current value of the blocking property.
—
+ Query the current value of the relationship property.
+ —
Query the current value of the allocator property. +

+
+

+ query [static] +

+ 		+

+ Query the current value of the mapping property.
—
+ Query the current value of the outstanding_work property. +

+
+

+ require +

+ 		+

+ Obtain an executor with the blocking.possibly property.
+ —
Obtain an executor with the blocking.never property. +
—
Obtain an executor with the relationship.fork property. +
—
Obtain an executor with the relationship.continuation + property.
—
Obtain an executor with the outstanding_work.tracked + property.
—
Obtain an executor with the outstanding_work.untracked + property.
—
Obtain an executor with the specified + allocator property.
—
Obtain an executor with the + default allocator property. +

+
+

+ running_in_this_thread +

+ 		+

+ Determine whether the io_context is running in the current thread. +

+
+

+ ~basic_executor_type [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/fork_event.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/fork_event.html new file mode 100644 index 0000000..5894077 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/fork_event.html @@ -0,0 +1,71 @@ + + + +io_context::fork_event + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Fork-related event + notifications. +

+
enum fork_event
+
+

+ + + +

+
+ + Values +
+
+

+
+
fork_prepare
+

+ Notify the context that the process is about to fork. +

+
fork_parent
+

+ Notify the context that the process has forked and is the parent. +

+
fork_child
+

+ Notify the context that the process has forked and is the child. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/get_executor.html new file mode 100644 index 0000000..a79f706 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/get_executor.html @@ -0,0 +1,42 @@ + + + +io_context::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtains the + executor associated with the io_context. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context.html new file mode 100644 index 0000000..465c63b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context.html @@ -0,0 +1,73 @@ + + + +io_context::io_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
io_context();
+  » more...
+
+template<
+    typename Allocator>
+io_context(
+    allocator_arg_t ,
+    const Allocator & a);
+  » more...
+
+explicit io_context(
+    int concurrency_hint);
+  » more...
+
+template<
+    typename Allocator>
+io_context(
+    allocator_arg_t ,
+    const Allocator & a,
+    int concurrency_hint);
+  » more...
+
+explicit io_context(
+    const execution_context::service_maker & initial_services);
+  » more...
+
+template<
+    typename Allocator>
+io_context(
+    allocator_arg_t ,
+    const Allocator & a,
+    const service_maker & initial_services);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload1.html new file mode 100644 index 0000000..d31b922 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload1.html @@ -0,0 +1,41 @@ + + + +io_context::io_context (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
io_context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload2.html new file mode 100644 index 0000000..aec3573 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload2.html @@ -0,0 +1,60 @@ + + + +io_context::io_context (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename Allocator>
+io_context(
+    allocator_arg_t ,
+    const Allocator & a);
+
+
+ + Parameters +
+
+

+
+
a
+

+ An allocator that will be used for allocating objects that are + associated with the context, such as services and internal state + for I/O objects. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload3.html new file mode 100644 index 0000000..c99324a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload3.html @@ -0,0 +1,59 @@ + + + +io_context::io_context (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
io_context(
+    int concurrency_hint);
+
+

+ Construct with a hint about the required level of concurrency. +

+
+ + Parameters +
+
+

+
+
concurrency_hint
+

+ A suggestion to the implementation on how many threads it should + allow to run simultaneously. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload4.html new file mode 100644 index 0000000..105e112 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload4.html @@ -0,0 +1,69 @@ + + + +io_context::io_context (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename Allocator>
+io_context(
+    allocator_arg_t ,
+    const Allocator & a,
+    int concurrency_hint);
+
+

+ Construct with a hint about the required level of concurrency. +

+
+ + Parameters +
+
+

+
+
a
+

+ An allocator that will be used for allocating objects that are + associated with the context, such as services and internal state + for I/O objects. +

+
concurrency_hint
+

+ A suggestion to the implementation on how many threads it should + allow to run simultaneously. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload5.html new file mode 100644 index 0000000..738aeb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload5.html @@ -0,0 +1,60 @@ + + + +io_context::io_context (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
io_context(
+    const execution_context::service_maker & initial_services);
+
+

+ Construct with a service maker, to create an initial set of services + that will be installed into the execution context at construction time. +

+
+ + Parameters +
+
+

+
+
initial_services
+

+ Used to create the initial services. The make + function will be called once at the end of execution_context construction. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload6.html new file mode 100644 index 0000000..63822fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/io_context/overload6.html @@ -0,0 +1,70 @@ + + + +io_context::io_context (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
template<
+    typename Allocator>
+io_context(
+    allocator_arg_t ,
+    const Allocator & a,
+    const service_maker & initial_services);
+
+

+ Construct with a service maker, to create an initial set of services + that will be installed into the execution context at construction time. +

+
+ + Parameters +
+
+

+
+
a
+

+ An allocator that will be used for allocating objects that are + associated with the context, such as services and internal state + for I/O objects. +

+
initial_services
+

+ Used to create the initial services. The make + function will be called once at the end of execution_context construction. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/notify_fork.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/notify_fork.html new file mode 100644 index 0000000..36e5492 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/notify_fork.html @@ -0,0 +1,118 @@ + + + +io_context::notify_fork + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Notify the execution_context + of a fork-related event. +

+
void notify_fork(
+    fork_event event);
+
+

+ This function is used to inform the execution_context that the process + is about to fork, or has just forked. This allows the execution_context, 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 execution_context function, or + any function associated with the execution_context's derived class, + 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 execution_context + or its derived class. +

+
+ + Parameters +
+
+

+
+
event
+

+ A fork-related event. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the notification fails the execution_context object + should no longer be used and should be destroyed. +

+
+
+
+ + Example +
+

+ The following code illustrates how to incorporate the notify_fork() function: +

+
my_execution_context.notify_fork(execution_context::fork_prepare);
+if (fork() == 0)
+{
+  // This is the child process.
+  my_execution_context.notify_fork(execution_context::fork_child);
+}
+else
+{
+  // This is the parent process.
+  my_execution_context.notify_fork(execution_context::fork_parent);
+}
+
+
+ + Remarks +
+

+ For each service object svc + in the execution_context + set, performs svc->notify_fork();. + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/poll.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/poll.html new file mode 100644 index 0000000..82f573a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/poll.html @@ -0,0 +1,56 @@ + + + +io_context::poll + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the io_context object's event processing + loop to execute ready handlers. +

+
count_type poll();
+
+

+ The poll() + function runs handlers that are ready to run, without blocking, until the + io_context + has been stopped or there are no more ready handlers. +

+
+ + Return + Value +
+

+ The number of handlers that were executed. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/poll_one.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/poll_one.html new file mode 100644 index 0000000..96a8ee6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/poll_one.html @@ -0,0 +1,54 @@ + + + +io_context::poll_one + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the io_context object's event processing + loop to execute one ready handler. +

+
count_type poll_one();
+
+

+ The poll_one() + function runs at most one handler that is ready to run, without blocking. +

+
+ + Return + Value +
+

+ The number of handlers that were executed. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/restart.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/restart.html new file mode 100644 index 0000000..29294da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/restart.html @@ -0,0 +1,62 @@ + + + +io_context::restart + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Restart the io_context in preparation for + a subsequent run() + invocation. +

+
void restart();
+
+

+ 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 io_context + being stopped or running out of work. After a call to restart(), the io_context object's stopped() + function will return false. +

+

+ This function must not be called while there are any unfinished calls to + the run(), + run_one(), + poll() + or poll_one() + functions. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/run.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/run.html new file mode 100644 index 0000000..7b658f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/run.html @@ -0,0 +1,85 @@ + + + +io_context::run + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the io_context object's event processing + loop. +

+
count_type run();
+
+

+ The run() + function blocks until all work has finished and there are no more handlers + to be dispatched, or until the io_context has been stopped. +

+

+ Multiple threads may call the run() function to set up a pool of threads + from which the io_context may execute handlers. + All threads that are waiting in the pool are equivalent and the io_context may choose any one + of them to invoke a handler. +

+

+ A normal exit from the run() function implies that the io_context 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 restart(). +

+
+ + Return + Value +
+

+ The number of handlers that were executed. +

+
+ + Remarks +
+

+ Calling the run() + function from a thread that is currently calling one of run(), run_one(), run_for(), run_until(), poll() or poll_one() on the same io_context object may introduce + the potential for deadlock. It is the caller's responsibility to avoid + this. +

+

+ The poll() + function may also be used to dispatch ready handlers, but without blocking. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/run_for.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_for.html new file mode 100644 index 0000000..ed08215 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_for.html @@ -0,0 +1,73 @@ + + + +io_context::run_for + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the io_context object's event processing + loop for a specified duration. +

+
template<
+    typename Rep,
+    typename Period>
+std::size_t run_for(
+    const chrono::duration< Rep, Period > & rel_time);
+
+

+ The run_for() + function blocks until all work has finished and there are no more handlers + to be dispatched, until the io_context has been stopped, or + until the specified duration has elapsed. +

+
+ + Parameters +
+
+

+
+
rel_time
+

+ The duration for which the call may block. +

+
+
+
+ + Return + Value +
+

+ The number of handlers that were executed. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one.html new file mode 100644 index 0000000..e7b0c01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one.html @@ -0,0 +1,69 @@ + + + +io_context::run_one + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the io_context object's event processing + loop to execute at most one handler. +

+
count_type run_one();
+
+

+ The run_one() + function blocks until one handler has been dispatched, or until the io_context + has been stopped. +

+
+ + Return + Value +
+

+ The number of handlers that were executed. A zero return value implies + that the io_context + 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 restart(). +

+
+ + Remarks +
+

+ Calling the run_one() + function from a thread that is currently calling one of run(), run_one(), run_for(), run_until(), poll() or poll_one() on the same io_context object may introduce + the potential for deadlock. It is the caller's responsibility to avoid + this. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one_for.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one_for.html new file mode 100644 index 0000000..d6bb7e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one_for.html @@ -0,0 +1,72 @@ + + + +io_context::run_one_for + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the io_context + object's event processing loop for a specified duration to execute at most + one handler. +

+
template<
+    typename Rep,
+    typename Period>
+std::size_t run_one_for(
+    const chrono::duration< Rep, Period > & rel_time);
+
+

+ The run_one_for() + function blocks until one handler has been dispatched, until the io_context + has been stopped, or until the specified duration has elapsed. +

+
+ + Parameters +
+
+

+
+
rel_time
+

+ The duration for which the call may block. +

+
+
+
+ + Return Value +
+

+ The number of handlers that were executed. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one_until.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one_until.html new file mode 100644 index 0000000..62d00b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_one_until.html @@ -0,0 +1,73 @@ + + + +io_context::run_one_until + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the + io_context + object's event processing loop until a specified time to execute at most + one handler. +

+
template<
+    typename Clock,
+    typename Duration>
+std::size_t run_one_until(
+    const chrono::time_point< Clock, Duration > & abs_time);
+
+

+ The run_one_until() + function blocks until one handler has been dispatched, until the io_context + has been stopped, or until the specified time has been reached. +

+
+ + Parameters +
+
+

+
+
abs_time
+

+ The time point until which the call may block. +

+
+
+
+ + Return Value +
+

+ The number of handlers that were executed. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/run_until.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_until.html new file mode 100644 index 0000000..c11bba2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/run_until.html @@ -0,0 +1,73 @@ + + + +io_context::run_until + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Run the io_context object's event processing + loop until a specified time. +

+
template<
+    typename Clock,
+    typename Duration>
+std::size_t run_until(
+    const chrono::time_point< Clock, Duration > & abs_time);
+
+

+ The run_until() + function blocks until all work has finished and there are no more handlers + to be dispatched, until the io_context has been stopped, or + until the specified time has been reached. +

+
+ + Parameters +
+
+

+
+
abs_time
+

+ The time point until which the call may block. +

+
+
+
+ + Return + Value +
+

+ The number of handlers that were executed. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/shutdown.html new file mode 100644 index 0000000..a360cbb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/shutdown.html @@ -0,0 +1,54 @@ + + + +io_context::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Shuts down all services + in the context. +

+
void shutdown();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order of the beginning of service object lifetime, performs + svc->shutdown(). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/stop.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/stop.html new file mode 100644 index 0000000..45f4878 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/stop.html @@ -0,0 +1,53 @@ + + + +io_context::stop + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Stop the io_context object's event processing + loop. +

+
void stop();
+
+

+ This function does not block, but instead simply signals the io_context 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 restart() is called. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/stopped.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/stopped.html new file mode 100644 index 0000000..70d05c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/stopped.html @@ -0,0 +1,59 @@ + + + +io_context::stopped + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether the + io_context + object has been stopped. +

+
bool stopped() const;
+
+

+ This function is used to determine whether an io_context object has been stopped, + either through an explicit call to stop(), or due to running out of work. When + an io_context + object is stopped, calls to run(), run_one(), poll() or poll_one() will return immediately without invoking + any handlers. +

+
+ + Return + Value +
+

+ true if the io_context object is stopped, + otherwise false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/use_service.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/use_service.html new file mode 100644 index 0000000..0caa690 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/use_service.html @@ -0,0 +1,53 @@ + + + +io_context::use_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename Service>
+Service & use_service(
+    io_context & ioc);
+
+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context/wrap.html b/Packages/asio-1.36.0/doc/asio/reference/io_context/wrap.html new file mode 100644 index 0000000..10e07ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context/wrap.html @@ -0,0 +1,96 @@ + + + +io_context::wrap + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +(Deprecated: Use bind_executor.) Create a new handler + that automatically dispatches the wrapped handler on the io_context. +

+
template<
+    typename Handler>
+unspecified wrap(
+    Handler handler);
+
+

+ This function is used to create a new handler function object that, when + invoked, will automatically pass the wrapped handler to the io_context object's dispatch function. +

+
+ + Parameters +
+
+

+
+
handler
+
+

+ The handler to be wrapped. The io_context will make a copy + of the handler object as required. The function signature of the + handler must be: +

+
void handler(A1 a1, ... An an);
+
+
+
+
+
+ + Return + Value +
+

+ A function object that, when invoked, passes the wrapped handler to the + io_context + object's dispatch function. Given a function object with the signature: +

+
R f(A1 a1, ... An an);
+
+

+ If this function object is passed to the wrap function like so: +

+
io_context.wrap(f);
+
+

+ then the return value is a function object with the signature +

+
void g(A1 a1, ... An an);
+
+

+ that, when invoked, executes code equivalent to: +

+
asio::dispatch(io_context,
+   boost::bind(f, a1, ... an));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type.html new file mode 100644 index 0000000..7964691 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type.html @@ -0,0 +1,310 @@ + + + +io_context::basic_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Executor implementation type used to submit functions to an io_context. +

+
template<
+    typename Allocator,
+    uintptr_t Bits>
+class basic_executor_type :
+  Allocator
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_executor_type [constructor] +

+ 		+

+ Copy constructor.
—
Move constructor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the io_context to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the io_context to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Execution function. +

+
+

+ on_work_finished +

+ 		+

+ Inform the io_context that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the io_context that it has some outstanding work to do. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+

+ post +

+ 		+

+ Request the io_context to invoke the given function object. +

+
+

+ query +

+ 		+

+ Query the current value of the context property.
—
+ Query the current value of the blocking property.
—
+ Query the current value of the relationship property.
—
+ Query the current value of the allocator property. +

+
+

+ query [static] +

+ 		+

+ Query the current value of the mapping property.
—
+ Query the current value of the outstanding_work property. +

+
+

+ require +

+ 		+

+ Obtain an executor with the blocking.possibly property.
+ —
Obtain an executor with the blocking.never property.
+ —
Obtain an executor with the relationship.fork property. +
—
Obtain an executor with the relationship.continuation + property.
—
Obtain an executor with the outstanding_work.tracked + property.
—
Obtain an executor with the outstanding_work.untracked + property.
—
Obtain an executor with the specified allocator + property.
—
Obtain an executor with the default allocator + property. +

+
+

+ running_in_this_thread +

+ 		+

+ Determine whether the io_context is running in the current thread. +

+
+

+ ~basic_executor_type [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/_basic_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/_basic_executor_type.html new file mode 100644 index 0000000..f9aae56 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/_basic_executor_type.html @@ -0,0 +1,41 @@ + + + +io_context::basic_executor_type::~basic_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~basic_executor_type();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type.html new file mode 100644 index 0000000..35b2922 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type.html @@ -0,0 +1,51 @@ + + + +io_context::basic_executor_type::basic_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Copy + constructor. +

+
basic_executor_type(
+    const basic_executor_type & other);
+  » more...
+
+

+ Move constructor. +

+
basic_executor_type(
+    basic_executor_type && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type/overload1.html new file mode 100644 index 0000000..65430ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type/overload1.html @@ -0,0 +1,42 @@ + + + +io_context::basic_executor_type::basic_executor_type (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_executor_type(
+    const basic_executor_type & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type/overload2.html new file mode 100644 index 0000000..2d14ecd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/basic_executor_type/overload2.html @@ -0,0 +1,42 @@ + + + +io_context::basic_executor_type::basic_executor_type (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_executor_type(
+    basic_executor_type && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/context.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/context.html new file mode 100644 index 0000000..226c1a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/context.html @@ -0,0 +1,42 @@ + + + +io_context::basic_executor_type::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the underlying execution context. +

+
io_context & context() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/defer.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/defer.html new file mode 100644 index 0000000..d9fce10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/defer.html @@ -0,0 +1,81 @@ + + + +io_context::basic_executor_type::defer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the io_context + to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void defer(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the io_context to execute the given + function object. The function object will never be executed inside defer(). + Instead, it will be scheduled to run on the io_context. +

+

+ If the current thread belongs to the io_context, defer() will delay scheduling the function object + until the current thread returns control to the pool. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/dispatch.html new file mode 100644 index 0000000..bccc97a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/dispatch.html @@ -0,0 +1,77 @@ + + + +io_context::basic_executor_type::dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the io_context + to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void dispatch(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the io_context to execute the given + function object. If the current thread is running the io_context, dispatch() executes the function before returning. + Otherwise, the function will be scheduled to run on the io_context. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/execute.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/execute.html new file mode 100644 index 0000000..00dea54 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/execute.html @@ -0,0 +1,45 @@ + + + +io_context::basic_executor_type::execute + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Execution + function. +

+
template<
+    typename Function>
+void execute(
+    Function && f) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/on_work_finished.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/on_work_finished.html new file mode 100644 index 0000000..25b2bac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/on_work_finished.html @@ -0,0 +1,50 @@ + + + +io_context::basic_executor_type::on_work_finished + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the io_context + that some work is no longer outstanding. +

+
void on_work_finished() const;
+
+

+ This function is used to inform the io_context that some work has + finished. Once the count of unfinished work reaches zero, the io_context is stopped and the + run() + and run_one() + functions may exit. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/on_work_started.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/on_work_started.html new file mode 100644 index 0000000..633a7ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/on_work_started.html @@ -0,0 +1,48 @@ + + + +io_context::basic_executor_type::on_work_started + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the io_context + that it has some outstanding work to do. +

+
void on_work_started() const;
+
+

+ This function is used to inform the io_context that some work has + begun. This ensures that the io_context's run() and run_one() functions do not exit while the work + is underway. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_.html new file mode 100644 index 0000000..7b4123c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_.html @@ -0,0 +1,51 @@ + + + +io_context::basic_executor_type::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment + operator. +

+
basic_executor_type & operator=(
+    const basic_executor_type & other);
+  » more...
+
+

+ Move assignment operator. +

+
basic_executor_type & operator=(
+    basic_executor_type && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_/overload1.html new file mode 100644 index 0000000..f815b4e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +io_context::basic_executor_type::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_executor_type & operator=(
+    const basic_executor_type & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_/overload2.html new file mode 100644 index 0000000..734f6c3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +io_context::basic_executor_type::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
basic_executor_type & operator=(
+    basic_executor_type && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq__eq_.html new file mode 100644 index 0000000..9288e13 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_eq__eq_.html @@ -0,0 +1,57 @@ + + + +io_context::basic_executor_type::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two executors for equality. +

+
bool operator==(
+    const basic_executor_type & a,
+    const basic_executor_type & b);
+
+

+ Two executors are equal if they refer to the same underlying io_context. +

+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_not__eq_.html new file mode 100644 index 0000000..0905184 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/operator_not__eq_.html @@ -0,0 +1,57 @@ + + + +io_context::basic_executor_type::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two executors for inequality. +

+
bool operator!=(
+    const basic_executor_type & a,
+    const basic_executor_type & b);
+
+

+ Two executors are equal if they refer to the same underlying io_context. +

+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/post.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/post.html new file mode 100644 index 0000000..34158c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/post.html @@ -0,0 +1,77 @@ + + + +io_context::basic_executor_type::post + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the io_context + to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void post(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the io_context to execute the given + function object. The function object will never be executed inside post(). + Instead, it will be scheduled to run on the io_context. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query.html new file mode 100644 index 0000000..928cf53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query.html @@ -0,0 +1,75 @@ + + + +io_context::basic_executor_type::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Query + the current value of the context + property. +

+
io_context & query(
+    execution::context_t ) const;
+  » more...
+
+

+ Query the current value of the blocking + property. +

+
constexpr execution::blocking_t query(
+    execution::blocking_t ) const;
+  » more...
+
+

+ Query the current value of the relationship + property. +

+
constexpr execution::relationship_t query(
+    execution::relationship_t ) const;
+  » more...
+
+

+ Query the current value of the allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr Allocator query(
+    execution::allocator_t< OtherAllocator > ) const;
+  » more...
+
+constexpr Allocator query(
+    execution::allocator_t< void > ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload1.html new file mode 100644 index 0000000..7613a6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload1.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::query (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the context + property. +

+
io_context & query(
+    execution::context_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_io_context.get_executor();
+asio::io_context& ctx = asio::query(
+    ex, asio::execution::context);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload2.html new file mode 100644 index 0000000..ba85f76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload2.html @@ -0,0 +1,56 @@ + + + +io_context::basic_executor_type::query (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the blocking + property. +

+
constexpr execution::blocking_t query(
+    execution::blocking_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_io_context.get_executor();
+if (asio::query(ex, asio::execution::blocking)
+      == asio::execution::blocking.always)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload3.html new file mode 100644 index 0000000..0c46927 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload3.html @@ -0,0 +1,56 @@ + + + +io_context::basic_executor_type::query (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the relationship + property. +

+
constexpr execution::relationship_t query(
+    execution::relationship_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_io_context.get_executor();
+if (asio::query(ex, asio::execution::relationship)
+      == asio::execution::relationship.continuation)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload4.html new file mode 100644 index 0000000..ee068b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload4.html @@ -0,0 +1,57 @@ + + + +io_context::basic_executor_type::query (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr Allocator query(
+    execution::allocator_t< OtherAllocator > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_io_context.get_executor();
+auto alloc = asio::query(ex,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload5.html new file mode 100644 index 0000000..0abd772 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query/overload5.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::query (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the allocator + property. +

+
constexpr Allocator query(
+    execution::allocator_t< void > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_io_context.get_executor();
+auto alloc = asio::query(ex,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static.html new file mode 100644 index 0000000..db800be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static.html @@ -0,0 +1,53 @@ + + + +io_context::basic_executor_type::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Query + the current value of the mapping + property. +

+
static constexpr execution::mapping_t query(
+    execution::mapping_t );
+  » more...
+
+

+ Query the current value of the outstanding_work + property. +

+
static constexpr execution::outstanding_work_t query(
+    execution::outstanding_work_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static/overload1.html new file mode 100644 index 0000000..a766a0e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static/overload1.html @@ -0,0 +1,56 @@ + + + +io_context::basic_executor_type::query (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the mapping + property. +

+
static constexpr execution::mapping_t query(
+    execution::mapping_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_io_context.get_executor();
+if (asio::query(ex, asio::execution::mapping)
+      == asio::execution::mapping.thread)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static/overload2.html new file mode 100644 index 0000000..c7be4b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/query__static/overload2.html @@ -0,0 +1,56 @@ + + + +io_context::basic_executor_type::query (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the outstanding_work + property. +

+
static constexpr execution::outstanding_work_t query(
+    execution::outstanding_work_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_io_context.get_executor();
+if (asio::query(ex, asio::execution::outstanding_work)
+      == asio::execution::outstanding_work.tracked)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require.html new file mode 100644 index 0000000..1502eb4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require.html @@ -0,0 +1,103 @@ + + + +io_context::basic_executor_type::require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an executor with the blocking.possibly + property. +

+
constexpr basic_executor_type require(
+    execution::blocking_t::possibly_t ) const;
+  » more...
+
+

+ Obtain an executor with the blocking.never + property. +

+
constexpr basic_executor_type require(
+    execution::blocking_t::never_t ) const;
+  » more...
+
+

+ Obtain an executor with the relationship.fork + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::fork_t ) const;
+  » more...
+
+

+ Obtain an executor with the relationship.continuation + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::continuation_t ) const;
+  » more...
+
+

+ Obtain an executor with the outstanding_work.tracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::tracked_t ) const;
+  » more...
+
+

+ Obtain an executor with the outstanding_work.untracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::untracked_t ) const;
+  » more...
+
+

+ Obtain an executor with the specified allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr basic_executor_type< OtherAllocator, Bits > require(
+    execution::allocator_t< OtherAllocator > a) const;
+  » more...
+
+

+ Obtain an executor with the default allocator + property. +

+
constexpr basic_executor_type< std::allocator< void >, Bits > require(
+    execution::allocator_t< void > ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload1.html new file mode 100644 index 0000000..bcba353 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload1.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::require (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.possibly + property. +

+
constexpr basic_executor_type require(
+    execution::blocking_t::possibly_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload2.html new file mode 100644 index 0000000..277f2c3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload2.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::require (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.never + property. +

+
constexpr basic_executor_type require(
+    execution::blocking_t::never_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.never);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload3.html new file mode 100644 index 0000000..0e38e27 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload3.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::require (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the relationship.fork + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::fork_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::relationship.fork);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload4.html new file mode 100644 index 0000000..053d257 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload4.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::require (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the relationship.continuation + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::continuation_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::relationship.continuation);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload5.html new file mode 100644 index 0000000..55f072d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload5.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::require (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the outstanding_work.tracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::tracked_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::outstanding_work.tracked);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload6.html new file mode 100644 index 0000000..0396254 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload6.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::require (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the outstanding_work.untracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::untracked_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::outstanding_work.untracked);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload7.html new file mode 100644 index 0000000..0af5c47 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload7.html @@ -0,0 +1,57 @@ + + + +io_context::basic_executor_type::require (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the specified allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr basic_executor_type< OtherAllocator, Bits > require(
+    execution::allocator_t< OtherAllocator > a) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::allocator(my_allocator));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload8.html new file mode 100644 index 0000000..2625360 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/require/overload8.html @@ -0,0 +1,55 @@ + + + +io_context::basic_executor_type::require (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the default allocator + property. +

+
constexpr basic_executor_type< std::allocator< void >, Bits > require(
+    execution::allocator_t< void > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_io_context.get_executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/running_in_this_thread.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/running_in_this_thread.html new file mode 100644 index 0000000..1d1b7dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__basic_executor_type/running_in_this_thread.html @@ -0,0 +1,53 @@ + + + +io_context::basic_executor_type::running_in_this_thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the io_context + is running in the current thread. +

+
bool running_in_this_thread() const;
+
+
+ + Return + Value +
+

+ true if the current thread + is running the io_context. Otherwise returns + false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__service.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__service.html new file mode 100644 index 0000000..96f1884 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__service.html @@ -0,0 +1,152 @@ + + + +io_context::service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Base class for all io_context services. +

+
class service :
+  public execution_context::service
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ context +

+ 		+

+ Get the context object that owns the service. +

+
+

+ get_io_context +

+ 		+

+ Get the io_context object that owns the service. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ service [constructor] +

+ 		+

+ Constructor. +

+
+

+ ~service [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/io_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__service/_service.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/_service.html new file mode 100644 index 0000000..1e64ad0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/_service.html @@ -0,0 +1,41 @@ + + + +io_context::service::~service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
virtual ~service();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__service/context.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/context.html new file mode 100644 index 0000000..1bf09f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/context.html @@ -0,0 +1,45 @@ + + + +io_context::service::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Get + the context object that owns the service. +

+
execution_context & context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__service/get_io_context.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/get_io_context.html new file mode 100644 index 0000000..9263bee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/get_io_context.html @@ -0,0 +1,43 @@ + + + +io_context::service::get_io_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the io_context + object that owns the service. +

+
asio::io_context & get_io_context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__service/service.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/service.html new file mode 100644 index 0000000..086f6ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__service/service.html @@ -0,0 +1,56 @@ + + + +io_context::service::service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
service(
+    asio::io_context & owner);
+
+
+ + Parameters +
+
+

+
+
owner
+

+ The io_context + object that owns the service. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand.html new file mode 100644 index 0000000..b05c2d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand.html @@ -0,0 +1,344 @@ + + + +io_context::strand + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides serialised handler execution. +

+
class strand
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the strand to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the strand to invoke the given function object. +

+
+

+ on_work_finished +

+ 		+

+ Inform the strand that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the strand that it has some outstanding work to do. +

+
+

+ post +

+ 		+

+ Request the strand to invoke the given function object. +

+
+

+ running_in_this_thread +

+ 		+

+ Determine whether the strand is running in the current thread. +

+
+

+ strand [constructor] +

+ 		+

+ Constructor.
—
Copy constructor. +

+
+

+ wrap +

+ 		+

+ (Deprecated: Use asio::bind_executor().) Create a new handler that + automatically dispatches the wrapped handler on the strand. +

+
+

+ ~strand [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two strands for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two strands for equality. +

+
+

+ The io_context::strand + class provides the ability to post and dispatch handlers with the guarantee + that none of those handlers will execute concurrently. +

+
+ + Order + of handler invocation +
+

+ Given: +

+
    +
  • + a strand object s +
    • +
  • + an object a meeting completion + handler requirements +
    • +
  • + an object a1 which is + an arbitrary copy of a + made by the implementation +
    • +
  • + an object b meeting completion + handler requirements +
    • +
  • + an object b1 which is + an arbitrary copy of b + made by the implementation +
    • +
+

+ if any of the following conditions are true: +

+
    +
  • + s.post(a) + happens-before s.post(b) +
    • +
  • + 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 +
    • +
  • + s.dispatch(a) + happens-before s.dispatch(b), + where both are performed outside the strand +
    • +
+

+ then a() + happens-before b() +

+

+ 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. +

+
+ + Remarks +
+

+ The implementation makes no guarantee that handlers posted or dispatched + through different strand + objects will be invoked concurrently. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/io_context_strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/_strand.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/_strand.html new file mode 100644 index 0000000..427c8af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/_strand.html @@ -0,0 +1,48 @@ + + + +io_context::strand::~strand + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~strand();
+
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/context.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/context.html new file mode 100644 index 0000000..67a187b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/context.html @@ -0,0 +1,42 @@ + + + +io_context::strand::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the underlying execution context. +

+
asio::io_context & context() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/defer.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/defer.html new file mode 100644 index 0000000..5a5363f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/defer.html @@ -0,0 +1,76 @@ + + + +io_context::strand::defer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the + strand to invoke the given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void defer(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object will never be executed inside this function. + Instead, it will be scheduled to run by the underlying io_context. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/dispatch.html new file mode 100644 index 0000000..a9f9a73 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/dispatch.html @@ -0,0 +1,78 @@ + + + +io_context::strand::dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the strand to invoke the given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void dispatch(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the strand to execute the given function object + on its underlying io_context. The function object + will be executed inside this function if the strand is not otherwise busy + and if the underlying io_context's executor's dispatch() + function is also able to execute the function before returning. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/on_work_finished.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/on_work_finished.html new file mode 100644 index 0000000..430ed99 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/on_work_finished.html @@ -0,0 +1,45 @@ + + + +io_context::strand::on_work_finished + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the strand that some work is no longer outstanding. +

+
void on_work_finished() const;
+
+

+ The strand delegates this call to its underlying io_context. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/on_work_started.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/on_work_started.html new file mode 100644 index 0000000..cc72bb0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/on_work_started.html @@ -0,0 +1,45 @@ + + + +io_context::strand::on_work_started + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the strand that it has some outstanding work to do. +

+
void on_work_started() const;
+
+

+ The strand delegates this call to its underlying io_context. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/operator_eq__eq_.html new file mode 100644 index 0000000..8f0020b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/operator_eq__eq_.html @@ -0,0 +1,58 @@ + + + +io_context::strand::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two strands for equality. +

+
bool operator==(
+    const strand & a,
+    const strand & b);
+
+

+ Two strands are equal if they refer to the same ordered, non-concurrent + state. +

+
+ + Requirements +
+

+ Header: asio/io_context_strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/operator_not__eq_.html new file mode 100644 index 0000000..efa6475 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/operator_not__eq_.html @@ -0,0 +1,58 @@ + + + +io_context::strand::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two strands for inequality. +

+
bool operator!=(
+    const strand & a,
+    const strand & b);
+
+

+ Two strands are equal if they refer to the same ordered, non-concurrent + state. +

+
+ + Requirements +
+

+ Header: asio/io_context_strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/post.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/post.html new file mode 100644 index 0000000..41fdac8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/post.html @@ -0,0 +1,76 @@ + + + +io_context::strand::post + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the + strand to invoke the given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void post(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object will never be executed inside this function. + Instead, it will be scheduled to run by the underlying io_context. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/running_in_this_thread.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/running_in_this_thread.html new file mode 100644 index 0000000..b99d823 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/running_in_this_thread.html @@ -0,0 +1,54 @@ + + + +io_context::strand::running_in_this_thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the strand is running in the current thread. +

+
bool running_in_this_thread() const;
+
+
+ + Return + Value +
+

+ true if the current thread + is executing a handler that was submitted to the strand using post(), + dispatch() + or wrap(). + Otherwise returns false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand.html new file mode 100644 index 0000000..1fef064 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand.html @@ -0,0 +1,50 @@ + + + +io_context::strand::strand + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
explicit strand(
+    asio::io_context & io_context);
+  » more...
+
+

+ Copy constructor. +

+
strand(
+    const strand & other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand/overload1.html new file mode 100644 index 0000000..8039b2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand/overload1.html @@ -0,0 +1,60 @@ + + + +io_context::strand::strand (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
strand(
+    asio::io_context & io_context);
+
+

+ Constructs the strand. +

+
+ + Parameters +
+
+

+
+
io_context
+

+ The io_context + object that the strand will use to dispatch handlers that are ready + to be run. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand/overload2.html new file mode 100644 index 0000000..948db05 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/strand/overload2.html @@ -0,0 +1,46 @@ + + + +io_context::strand::strand (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
strand(
+    const strand & other);
+
+

+ Creates a copy such that both strand objects share the same underlying + state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/wrap.html b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/wrap.html new file mode 100644 index 0000000..fe1542c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/io_context__strand/wrap.html @@ -0,0 +1,95 @@ + + + +io_context::strand::wrap + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +(Deprecated: + Use bind_executor.) + Create a new handler that automatically dispatches the wrapped handler + on the strand. +

+
template<
+    typename Handler>
+unspecified wrap(
+    Handler handler);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
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);
+
+
+
+
+
+ + 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: +

+
R f(A1 a1, ... An an);
+
+

+ If this function object is passed to the wrap function like so: +

+
strand.wrap(f);
+
+

+ then the return value is a function object with the signature +

+
void g(A1 a1, ... An an);
+
+

+ that, when invoked, executes code equivalent to: +

+
asio::dispatch(strand, boost::bind(f, a1, ... an));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address.html new file mode 100644 index 0000000..19e5759 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address.html @@ -0,0 +1,364 @@ + + + +ip::address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Implements version-independent IP addresses. +

+
class address
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address + [constructor] +

+ 		+

+ Default constructor.
—
Construct an address from an + IPv4 address.
—
Construct an address from an IPv6 address. +
—
Copy constructor.
—
Move constructor. +

+
+

+ is_loopback +

+ 		+

+ Determine whether the address is a loopback address. +

+
+

+ is_multicast +

+ 		+

+ Determine whether the address is a multicast address. +

+
+

+ is_unspecified +

+ 		+

+ Determine whether the address is unspecified. +

+
+

+ is_v4 +

+ 		+

+ Get whether the address is an IP version 4 address. +

+
+

+ is_v6 +

+ 		+

+ Get whether the address is an IP version 6 address. +

+
+

+ operator= +

+ 		+

+ Assign from another address.
—
Move-assign from another + address.
—
Assign from an IPv4 address.
—
+ Assign from an IPv6 address. +

+
+

+ to_string +

+ 		+

+ Get the address as a string. +

+
+

+ to_v4 +

+ 		+

+ Get the address as an IP version 4 address. +

+
+

+ to_v6 +

+ 		+

+ Get the address as an IP version 6 address. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator< +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ operator> +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare addresses for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_address +

+ 		+

+ Create an address from an IPv4 address string in dotted decimal + form, or from an IPv6 address in hexadecimal notation. +

+
+

+ operator<< +

+ 		+

+ Output an address as a string. +

+
+

+ The ip::address + class provides the ability to use either IP version 4 or version 6 addresses. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/address.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address.html new file mode 100644 index 0000000..e8262b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address.html @@ -0,0 +1,70 @@ + + + +ip::address::address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
address();
+  » more...
+
+

+ Construct an address from an IPv4 address. +

+
address(
+    const asio::ip::address_v4 & ipv4_address);
+  » more...
+
+

+ Construct an address from an IPv6 address. +

+
address(
+    const asio::ip::address_v6 & ipv6_address);
+  » more...
+
+

+ Copy constructor. +

+
address(
+    const address & other);
+  » more...
+
+

+ Move constructor. +

+
address(
+    address && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload1.html new file mode 100644 index 0000000..68533d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload1.html @@ -0,0 +1,41 @@ + + + +ip::address::address (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
address();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload2.html new file mode 100644 index 0000000..4cb60c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload2.html @@ -0,0 +1,42 @@ + + + +ip::address::address (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an address from an IPv4 address. +

+
address(
+    const asio::ip::address_v4 & ipv4_address);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload3.html new file mode 100644 index 0000000..b39241c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload3.html @@ -0,0 +1,42 @@ + + + +ip::address::address (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an address from an IPv6 address. +

+
address(
+    const asio::ip::address_v6 & ipv6_address);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload4.html new file mode 100644 index 0000000..640f146 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload4.html @@ -0,0 +1,42 @@ + + + +ip::address::address (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
address(
+    const address & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload5.html new file mode 100644 index 0000000..3b980a6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/address/overload5.html @@ -0,0 +1,42 @@ + + + +ip::address::address (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
address(
+    address && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_loopback.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_loopback.html new file mode 100644 index 0000000..d6788f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_loopback.html @@ -0,0 +1,42 @@ + + + +ip::address::is_loopback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether + the address is a loopback address. +

+
bool is_loopback() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_multicast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_multicast.html new file mode 100644 index 0000000..ac50010 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_multicast.html @@ -0,0 +1,42 @@ + + + +ip::address::is_multicast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a multicast address. +

+
bool is_multicast() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_unspecified.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_unspecified.html new file mode 100644 index 0000000..591dfab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_unspecified.html @@ -0,0 +1,42 @@ + + + +ip::address::is_unspecified + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is unspecified. +

+
bool is_unspecified() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_v4.html new file mode 100644 index 0000000..2c9360d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_v4.html @@ -0,0 +1,42 @@ + + + +ip::address::is_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get whether the address + is an IP version 4 address. +

+
bool is_v4() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_v6.html new file mode 100644 index 0000000..190f6b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/is_v6.html @@ -0,0 +1,42 @@ + + + +ip::address::is_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get whether the address + is an IP version 6 address. +

+
bool is_v6() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address.html new file mode 100644 index 0000000..6493676 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address.html @@ -0,0 +1,68 @@ + + + +ip::address::make_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create an + address from an IPv4 address string in dotted decimal form, or from an + IPv6 address in hexadecimal notation. +

+
address make_address(
+    const char * str);
+  » more...
+
+address make_address(
+    const char * str,
+    asio::error_code & ec);
+  » more...
+
+address make_address(
+    const std::string & str);
+  » more...
+
+address make_address(
+    const std::string & str,
+    asio::error_code & ec);
+  » more...
+
+address make_address(
+    string_view str);
+  » more...
+
+address make_address(
+    string_view str,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload1.html new file mode 100644 index 0000000..644bd22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload1.html @@ -0,0 +1,43 @@ + + + +ip::address::make_address (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an address from an IPv4 address string in dotted decimal form, + or from an IPv6 address in hexadecimal notation. +

+
address make_address(
+    const char * str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload2.html new file mode 100644 index 0000000..2048f43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload2.html @@ -0,0 +1,44 @@ + + + +ip::address::make_address (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an address from an IPv4 address string in dotted decimal form, + or from an IPv6 address in hexadecimal notation. +

+
address make_address(
+    const char * str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload3.html new file mode 100644 index 0000000..60d813e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload3.html @@ -0,0 +1,43 @@ + + + +ip::address::make_address (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an address from an IPv4 address string in dotted decimal form, + or from an IPv6 address in hexadecimal notation. +

+
address make_address(
+    const std::string & str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload4.html new file mode 100644 index 0000000..59087a6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload4.html @@ -0,0 +1,44 @@ + + + +ip::address::make_address (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an address from an IPv4 address string in dotted decimal form, + or from an IPv6 address in hexadecimal notation. +

+
address make_address(
+    const std::string & str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload5.html new file mode 100644 index 0000000..6f429ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload5.html @@ -0,0 +1,43 @@ + + + +ip::address::make_address (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an address from an IPv4 address string in dotted decimal form, + or from an IPv6 address in hexadecimal notation. +

+
address make_address(
+    string_view str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload6.html new file mode 100644 index 0000000..7ddf015 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/make_address/overload6.html @@ -0,0 +1,44 @@ + + + +ip::address::make_address (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an address from an IPv4 address string in dotted decimal form, + or from an IPv6 address in hexadecimal notation. +

+
address make_address(
+    string_view str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_.html new file mode 100644 index 0000000..462837e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_.html @@ -0,0 +1,65 @@ + + + +ip::address::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign from + another address. +

+
address & operator=(
+    const address & other);
+  » more...
+
+

+ Move-assign from another address. +

+
address & operator=(
+    address && other);
+  » more...
+
+

+ Assign from an IPv4 address. +

+
address & operator=(
+    const asio::ip::address_v4 & ipv4_address);
+  » more...
+
+

+ Assign from an IPv6 address. +

+
address & operator=(
+    const asio::ip::address_v6 & ipv6_address);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload1.html new file mode 100644 index 0000000..036354e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::address::operator= (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another address. +

+
address & operator=(
+    const address & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload2.html new file mode 100644 index 0000000..9a811dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::address::operator= (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another address. +

+
address & operator=(
+    address && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload3.html new file mode 100644 index 0000000..1194da9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload3.html @@ -0,0 +1,42 @@ + + + +ip::address::operator= (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from an IPv4 address. +

+
address & operator=(
+    const asio::ip::address_v4 & ipv4_address);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload4.html new file mode 100644 index 0000000..68342da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq_/overload4.html @@ -0,0 +1,42 @@ + + + +ip::address::operator= (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from an IPv6 address. +

+
address & operator=(
+    const asio::ip::address_v6 & ipv6_address);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq__eq_.html new file mode 100644 index 0000000..9b8945b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two addresses for equality. +

+
bool operator==(
+    const address & a1,
+    const address & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_gt_.html new file mode 100644 index 0000000..cc651b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_gt_.html @@ -0,0 +1,54 @@ + + + +ip::address::operator> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare addresses + for ordering. +

+
bool operator>(
+    const address & a1,
+    const address & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_gt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_gt__eq_.html new file mode 100644 index 0000000..e9197be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_gt__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address::operator>= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator>=(
+    const address & a1,
+    const address & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt_.html new file mode 100644 index 0000000..3a7e44d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt_.html @@ -0,0 +1,54 @@ + + + +ip::address::operator< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare addresses + for ordering. +

+
bool operator<(
+    const address & a1,
+    const address & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt__eq_.html new file mode 100644 index 0000000..6f3adb3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address::operator<= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator<=(
+    const address & a1,
+    const address & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt__lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt__lt_.html new file mode 100644 index 0000000..9ae0aee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_lt__lt_.html @@ -0,0 +1,75 @@ + + + +ip::address::operator<< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Output + an address as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const address & addr);
+
+

+ Used to output a human-readable string for a specified address. +

+
+ + Parameters +
+
+

+
+
os
+

+ The output stream to which the string will be written. +

+
addr
+

+ The address to be written. +

+
+
+
+ + Return + Value +
+

+ The output stream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_not__eq_.html new file mode 100644 index 0000000..616b8bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two addresses for inequality. +

+
bool operator!=(
+    const address & a1,
+    const address & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_string.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_string.html new file mode 100644 index 0000000..afcfcb4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_string.html @@ -0,0 +1,42 @@ + + + +ip::address::to_string + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address + as a string. +

+
std::string to_string() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_v4.html new file mode 100644 index 0000000..9de8665 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_v4.html @@ -0,0 +1,42 @@ + + + +ip::address::to_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address as an IP + version 4 address. +

+
asio::ip::address_v4 to_v4() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_v6.html new file mode 100644 index 0000000..dd67370 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address/to_v6.html @@ -0,0 +1,42 @@ + + + +ip::address::to_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address as an IP + version 6 address. +

+
asio::ip::address_v6 to_v6() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address__gt_.html new file mode 100644 index 0000000..0db6dd6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address__gt_.html @@ -0,0 +1,83 @@ + + + +ip::address > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct hash< asio::ip::address >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+
+ + Requirements +
+

+ Header: asio/ip/address.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address__gt_/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address__gt_/operator_lp__rp_.html new file mode 100644 index 0000000..e785bd8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address__gt_/operator_lp__rp_.html @@ -0,0 +1,42 @@ + + + +ip::address >::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::size_t operator()(
+    const asio::ip::address & addr) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4.html new file mode 100644 index 0000000..dc0b045 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4.html @@ -0,0 +1,451 @@ + + + +ip::address_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Implements IP version 4 style addresses. +

+
class address_v4
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bytes_type +

+ 		+

+ The type used to represent an address as an array of bytes. +

+
+

+ uint_type +

+ 		+

+ The type used to represent an address as an unsigned integer. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_v4 [constructor] +

+ 		+

+ Default constructor.
—
Construct an address from raw + bytes.
—
Construct an address from an unsigned integer + in host byte order.
—
Copy constructor.
—
+ Move constructor. +

+
+

+ any + [static] +

+ 		+

+ Obtain an address object that represents any address. +

+
+

+ broadcast [static] +

+ 		+

+ Obtain an address object that represents the broadcast address. +

+
+

+ is_loopback +

+ 		+

+ Determine whether the address is a loopback address. +

+
+

+ is_multicast +

+ 		+

+ Determine whether the address is a multicast address. +

+
+

+ is_unspecified +

+ 		+

+ Determine whether the address is unspecified. +

+
+

+ loopback [static] +

+ 		+

+ Obtain an address object that represents the loopback address. +

+
+

+ operator= +

+ 		+

+ Assign from another address.
—
Move-assign from another + address. +

+
+

+ to_bytes +

+ 		+

+ Get the address in bytes, in network byte order. +

+
+

+ to_string +

+ 		+

+ Get the address as a string in dotted decimal format. +

+
+

+ to_uint +

+ 		+

+ Get the address as an unsigned integer in host byte order. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator< +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ operator> +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare addresses for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_address_v4 +

+ 		+

+ Create an IPv4 address from raw bytes in network order. +

+

+ Create an IPv4 address from an unsigned integer in host byte order. +

+

+ Create an IPv4 address from an IP address string in dotted decimal + form. +

+

+ Create an IPv4 address from a IPv4-mapped IPv6 address. +

+
+

+ make_network_v4 +

+ 		+

+ Create an IPv4 network from an address and prefix length. +

+

+ Create an IPv4 network from an address and netmask. +

+
+

+ operator<< +

+ 		+

+ Output an address as a string. +

+

+ Output a network as a string. +

+
+

+ The ip::address_v4 + class provides the ability to use and manipulate IP version 4 addresses. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4.html new file mode 100644 index 0000000..1373f9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4.html @@ -0,0 +1,71 @@ + + + +ip::address_v4::address_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
address_v4();
+  » more...
+
+

+ Construct an address from raw bytes. +

+
explicit address_v4(
+    const bytes_type & bytes);
+  » more...
+
+

+ Construct an address from an unsigned integer in host byte order. +

+
explicit address_v4(
+    uint_type addr);
+  » more...
+
+

+ Copy constructor. +

+
address_v4(
+    const address_v4 & other);
+  » more...
+
+

+ Move constructor. +

+
address_v4(
+    address_v4 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload1.html new file mode 100644 index 0000000..4b6e4b7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload1.html @@ -0,0 +1,51 @@ + + + +ip::address_v4::address_v4 (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
address_v4();
+
+

+ Initialises the address_v4 + object such that: * to_bytes() yields {0, 0, 0, + 0}; + and +

+
  • + to_uint() + == 0. +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload2.html new file mode 100644 index 0000000..f546b07 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload2.html @@ -0,0 +1,61 @@ + + + +ip::address_v4::address_v4 (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an address from raw bytes. +

+
address_v4(
+    const bytes_type & bytes);
+
+

+ Initialises the address_v4 + object such that to_bytes() == bytes. +

+
+ + Exceptions +
+
+

+
+
out_of_range
+

+ Thrown if any element in bytes + is not in the range 0 - 0xFF. + Note that no range checking is required for platforms where std::numeric_limits<unsigned char>::max() is 0xFF. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload3.html new file mode 100644 index 0000000..08f021c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload3.html @@ -0,0 +1,46 @@ + + + +ip::address_v4::address_v4 (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an address from an unsigned integer in host byte order. +

+
address_v4(
+    uint_type addr);
+
+

+ Initialises the address_v4 + object such that to_uint() == addr. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload4.html new file mode 100644 index 0000000..362f059 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload4.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::address_v4 (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
address_v4(
+    const address_v4 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload5.html new file mode 100644 index 0000000..b7eb68b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/address_v4/overload5.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::address_v4 (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
address_v4(
+    address_v4 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/any.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/any.html new file mode 100644 index 0000000..97eda0c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/any.html @@ -0,0 +1,55 @@ + + + +ip::address_v4::any + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address object + that represents any address. +

+
static address_v4 any();
+
+

+ This functions returns an address that represents the "any" address + 0.0.0.0. +

+
+ + Return + Value +
+

+ A default-constructed address_v4 + object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/broadcast.html new file mode 100644 index 0000000..54fa708 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/broadcast.html @@ -0,0 +1,53 @@ + + + +ip::address_v4::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an + address object that represents the broadcast address. +

+
static address_v4 broadcast();
+
+

+ This function returns an address that represents the broadcast address + 255.255.255.255. +

+
+ + Return Value +
+

+ address_v4(0xFFFFFFFF). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/bytes_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/bytes_type.html new file mode 100644 index 0000000..1c0b471 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/bytes_type.html @@ -0,0 +1,60 @@ + + + +ip::address_v4::bytes_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + used to represent an address as an array of bytes. +

+
typedef array< unsigned char, 4 > bytes_type;
+
+
+ + Remarks +
+

+ This type is defined in terms of the C++0x template std::array + when it is available. Otherwise, it uses boost:array. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_loopback.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_loopback.html new file mode 100644 index 0000000..fd443fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_loopback.html @@ -0,0 +1,55 @@ + + + +ip::address_v4::is_loopback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a loopback address. +

+
bool is_loopback() const;
+
+

+ This function tests whether the address is in the address block 127.0.0.0/8, which + corresponds to the address range 127.0.0.0 - + 127.255.255.255. +

+
+ + Return + Value +
+

+ (to_uint() & 0xFF000000) == 0x7F000000. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_multicast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_multicast.html new file mode 100644 index 0000000..ed2c333 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_multicast.html @@ -0,0 +1,56 @@ + + + +ip::address_v4::is_multicast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a multicast address. +

+
bool is_multicast() const;
+
+

+ This function tests whether the address is in the multicast address block + 224.0.0.0/4, + which corresponds to the address range 224.0.0.0 - + 239.255.255.255. +

+
+ + Return + Value +
+

+ (to_uint() & 0xF0000000) == 0xE0000000. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_unspecified.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_unspecified.html new file mode 100644 index 0000000..1be4312 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/is_unspecified.html @@ -0,0 +1,54 @@ + + + +ip::address_v4::is_unspecified + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is unspecified. +

+
bool is_unspecified() const;
+
+

+ This function tests whether the address is the unspecified address 0.0.0.0. +

+
+ + Return + Value +
+

+ to_uint() + == 0. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/loopback.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/loopback.html new file mode 100644 index 0000000..ca8f0c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/loopback.html @@ -0,0 +1,53 @@ + + + +ip::address_v4::loopback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address + object that represents the loopback address. +

+
static address_v4 loopback();
+
+

+ This function returns an address that represents the well-known loopback + address 127.0.0.1. +

+
+ + Return Value +
+

+ address_v4(0x7F000001). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4.html new file mode 100644 index 0000000..ad801a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4.html @@ -0,0 +1,89 @@ + + + +ip::address_v4::make_address_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + an IPv4 address from raw bytes in network order. +

+
address_v4 make_address_v4(
+    const address_v4::bytes_type & bytes);
+  » more...
+
+

+ Create an IPv4 address from an unsigned integer in host byte order. +

+
address_v4 make_address_v4(
+    address_v4::uint_type addr);
+  » more...
+
+

+ Create an IPv4 address from an IP address string in dotted decimal form. +

+
address_v4 make_address_v4(
+    const char * str);
+  » more...
+
+address_v4 make_address_v4(
+    const char * str,
+    asio::error_code & ec);
+  » more...
+
+address_v4 make_address_v4(
+    const std::string & str);
+  » more...
+
+address_v4 make_address_v4(
+    const std::string & str,
+    asio::error_code & ec);
+  » more...
+
+address_v4 make_address_v4(
+    string_view str);
+  » more...
+
+address_v4 make_address_v4(
+    string_view str,
+    asio::error_code & ec);
+  » more...
+
+

+ Create an IPv4 address from a IPv4-mapped IPv6 address. +

+
address_v4 make_address_v4(
+    v4_mapped_t ,
+    const address_v6 & v6_addr);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload1.html new file mode 100644 index 0000000..dc02a95 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload1.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::make_address_v4 (1 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from raw bytes in network order. +

+
address_v4 make_address_v4(
+    const address_v4::bytes_type & bytes);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload2.html new file mode 100644 index 0000000..12a7168 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload2.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::make_address_v4 (2 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from an unsigned integer in host byte order. +

+
address_v4 make_address_v4(
+    address_v4::uint_type addr);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload3.html new file mode 100644 index 0000000..70f580a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload3.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::make_address_v4 (3 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from an IP address string in dotted decimal form. +

+
address_v4 make_address_v4(
+    const char * str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload4.html new file mode 100644 index 0000000..4b11b83 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload4.html @@ -0,0 +1,43 @@ + + + +ip::address_v4::make_address_v4 (4 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from an IP address string in dotted decimal form. +

+
address_v4 make_address_v4(
+    const char * str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload5.html new file mode 100644 index 0000000..70bd2ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload5.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::make_address_v4 (5 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from an IP address string in dotted decimal form. +

+
address_v4 make_address_v4(
+    const std::string & str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload6.html new file mode 100644 index 0000000..9184ab1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload6.html @@ -0,0 +1,43 @@ + + + +ip::address_v4::make_address_v4 (6 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from an IP address string in dotted decimal form. +

+
address_v4 make_address_v4(
+    const std::string & str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload7.html new file mode 100644 index 0000000..b9fcac2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload7.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::make_address_v4 (7 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from an IP address string in dotted decimal form. +

+
address_v4 make_address_v4(
+    string_view str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload8.html new file mode 100644 index 0000000..888677a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload8.html @@ -0,0 +1,43 @@ + + + +ip::address_v4::make_address_v4 (8 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from an IP address string in dotted decimal form. +

+
address_v4 make_address_v4(
+    string_view str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload9.html new file mode 100644 index 0000000..33a1d82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_address_v4/overload9.html @@ -0,0 +1,43 @@ + + + +ip::address_v4::make_address_v4 (9 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 address from a IPv4-mapped IPv6 address. +

+
address_v4 make_address_v4(
+    v4_mapped_t ,
+    const address_v6 & v6_addr);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4.html new file mode 100644 index 0000000..5de2c2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4.html @@ -0,0 +1,53 @@ + + + +ip::address_v4::make_network_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + an IPv4 network from an address and prefix length. +

+
network_v4 make_network_v4(
+    const address_v4 & addr,
+    unsigned short prefix_len);
+  » more...
+
+

+ Create an IPv4 network from an address and netmask. +

+
network_v4 make_network_v4(
+    const address_v4 & addr,
+    const address_v4 & mask);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4/overload1.html new file mode 100644 index 0000000..0c9a1f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4/overload1.html @@ -0,0 +1,43 @@ + + + +ip::address_v4::make_network_v4 (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from an address and prefix length. +

+
network_v4 make_network_v4(
+    const address_v4 & addr,
+    unsigned short prefix_len);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4/overload2.html new file mode 100644 index 0000000..fc1a480 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/make_network_v4/overload2.html @@ -0,0 +1,43 @@ + + + +ip::address_v4::make_network_v4 (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from an address and netmask. +

+
network_v4 make_network_v4(
+    const address_v4 & addr,
+    const address_v4 & mask);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_.html new file mode 100644 index 0000000..517b2de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::address_v4::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + from another address. +

+
address_v4 & operator=(
+    const address_v4 & other);
+  » more...
+
+

+ Move-assign from another address. +

+
address_v4 & operator=(
+    address_v4 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_/overload1.html new file mode 100644 index 0000000..5f34d15 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another address. +

+
address_v4 & operator=(
+    const address_v4 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_/overload2.html new file mode 100644 index 0000000..a48be74 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another address. +

+
address_v4 & operator=(
+    address_v4 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq__eq_.html new file mode 100644 index 0000000..db1218a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address_v4::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two addresses for equality. +

+
bool operator==(
+    const address_v4 & a1,
+    const address_v4 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_gt_.html new file mode 100644 index 0000000..9926209 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_gt_.html @@ -0,0 +1,65 @@ + + + +ip::address_v4::operator> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator>(
+    const address_v4 & a1,
+    const address_v4 & a2);
+
+

+ Compares two addresses in host byte order. +

+
+ + Return + Value +
+

+ a1.to_uint() > a2.to_uint(). +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_gt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_gt__eq_.html new file mode 100644 index 0000000..574ca09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_gt__eq_.html @@ -0,0 +1,65 @@ + + + +ip::address_v4::operator>= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator>=(
+    const address_v4 & a1,
+    const address_v4 & a2);
+
+

+ Compares two addresses in host byte order. +

+
+ + Return + Value +
+

+ a1.to_uint() >= a2.to_uint(). +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt_.html new file mode 100644 index 0000000..1cc1201 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt_.html @@ -0,0 +1,65 @@ + + + +ip::address_v4::operator< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator<(
+    const address_v4 & a1,
+    const address_v4 & a2);
+
+

+ Compares two addresses in host byte order. +

+
+ + Return + Value +
+

+ a1.to_uint() < a2.to_uint(). +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__eq_.html new file mode 100644 index 0000000..51f3a0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__eq_.html @@ -0,0 +1,65 @@ + + + +ip::address_v4::operator<= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator<=(
+    const address_v4 & a1,
+    const address_v4 & a2);
+
+

+ Compares two addresses in host byte order. +

+
+ + Return + Value +
+

+ a1.to_uint() <= a2.to_uint(). +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_.html new file mode 100644 index 0000000..d750328 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_.html @@ -0,0 +1,59 @@ + + + +ip::address_v4::operator<< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Output + an address as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const address_v4 & addr);
+  » more...
+
+

+ Output a network as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const network_v4 & net);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_/overload1.html new file mode 100644 index 0000000..dc3f512 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_/overload1.html @@ -0,0 +1,74 @@ + + + +ip::address_v4::operator<< (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Output an address as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const address_v4 & addr);
+
+

+ Used to output a human-readable string for a specified address. +

+
+ + Parameters +
+
+

+
+
os
+

+ The output stream to which the string will be written. +

+
addr
+

+ The address to be written. +

+
+
+
+ + Return + Value +
+

+ The output stream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_/overload2.html new file mode 100644 index 0000000..139b4b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_lt__lt_/overload2.html @@ -0,0 +1,74 @@ + + + +ip::address_v4::operator<< (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Output a network as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const network_v4 & net);
+
+

+ Used to output a human-readable string for a specified network. +

+
+ + Parameters +
+
+

+
+
os
+

+ The output stream to which the string will be written. +

+
net
+

+ The network to be written. +

+
+
+
+ + Return + Value +
+

+ The output stream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_not__eq_.html new file mode 100644 index 0000000..2b1f627 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address_v4::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two addresses for inequality. +

+
bool operator!=(
+    const address_v4 & a1,
+    const address_v4 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_bytes.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_bytes.html new file mode 100644 index 0000000..f2a6d2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_bytes.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::to_bytes + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address + in bytes, in network byte order. +

+
bytes_type to_bytes() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_string.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_string.html new file mode 100644 index 0000000..19a84f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_string.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::to_string + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address + as a string in dotted decimal format. +

+
std::string to_string() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_uint.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_uint.html new file mode 100644 index 0000000..28c9567 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/to_uint.html @@ -0,0 +1,42 @@ + + + +ip::address_v4::to_uint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address + as an unsigned integer in host byte order. +

+
uint_type to_uint() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/uint_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/uint_type.html new file mode 100644 index 0000000..f4525d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4/uint_type.html @@ -0,0 +1,52 @@ + + + +ip::address_v4::uint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + used to represent an address as an unsigned integer. +

+
typedef uint_least32_t uint_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4__gt_.html new file mode 100644 index 0000000..6da486e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4__gt_.html @@ -0,0 +1,83 @@ + + + +ip::address_v4 > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct hash< asio::ip::address_v4 >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4__gt_/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4__gt_/operator_lp__rp_.html new file mode 100644 index 0000000..b16b143 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4__gt_/operator_lp__rp_.html @@ -0,0 +1,42 @@ + + + +ip::address_v4 >::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::size_t operator()(
+    const asio::ip::address_v4 & addr) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4_iterator.html new file mode 100644 index 0000000..4e12bd9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4_iterator.html @@ -0,0 +1,297 @@ + + + +ip::address_v4_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An input iterator that can be used for traversing IPv4 addresses. +

+
typedef basic_address_iterator< address_v4 > address_v4_iterator;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ Distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ Denotes that the iterator satisfies the input iterator requirements. +

+
+

+ pointer +

+ 		+

+ The type of a pointer to an element pointed to by the iterator. +

+
+

+ reference +

+ 		+

+ The type of a reference to an element pointed to by the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the elements pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_iterator +

+ 		+

+ Construct an iterator that points to the specified address.
+ —
Copy constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference the iterator. +

+
+

+ operator++ +

+ 		+

+ Pre-increment operator.
—
Post-increment operator. +

+
+

+ operator-- +

+ 		+

+ Pre-decrement operator.
—
Post-decrement operator. +

+
+

+ operator-> +

+ 		+

+ Dereference the iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ In addition to satisfying the input iterator requirements, this iterator + also supports decrement. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4_range.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4_range.html new file mode 100644 index 0000000..855b5ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v4_range.html @@ -0,0 +1,208 @@ + + + +ip::address_v4_range + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Represents a range of IPv4 addresses. +

+
typedef basic_address_range< address_v4 > address_v4_range;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ iterator +

+ 		+

+ The type of an iterator that points into the range. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_range +

+ 		+

+ Construct an empty range.
—
Construct an range that + represents the given range of addresses.
—
Copy constructor. +
—
Move constructor. +

+
+

+ begin +

+ 		+

+ Obtain an iterator that points to the start of the range. +

+
+

+ empty +

+ 		+

+ Determine whether the range is empty. +

+
+

+ end +

+ 		+

+ Obtain an iterator that points to the end of the range. +

+
+

+ find +

+ 		+

+ Find an address in the range. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+

+ size +

+ 		+

+ Return the size of the range. +

+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4_range.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6.html new file mode 100644 index 0000000..6086c67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6.html @@ -0,0 +1,516 @@ + + + +ip::address_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Implements IP version 6 style addresses. +

+
class address_v6
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bytes_type +

+ 		+

+ The type used to represent an address as an array of bytes. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_v6 [constructor] +

+ 		+

+ Default constructor.
—
Construct an address from raw + bytes and scope ID.
—
Copy constructor.
—
+ Move constructor. +

+
+

+ any + [static] +

+ 		+

+ Obtain an address object that represents any address. +

+
+

+ is_link_local +

+ 		+

+ Determine whether the address is link local. +

+
+

+ is_loopback +

+ 		+

+ Determine whether the address is a loopback address. +

+
+

+ is_multicast +

+ 		+

+ Determine whether the address is a multicast address. +

+
+

+ is_multicast_global +

+ 		+

+ Determine whether the address is a global multicast address. +

+
+

+ is_multicast_link_local +

+ 		+

+ Determine whether the address is a link-local multicast address. +

+
+

+ is_multicast_node_local +

+ 		+

+ Determine whether the address is a node-local multicast address. +

+
+

+ is_multicast_org_local +

+ 		+

+ Determine whether the address is a org-local multicast address. +

+
+

+ is_multicast_site_local +

+ 		+

+ Determine whether the address is a site-local multicast address. +

+
+

+ is_site_local +

+ 		+

+ Determine whether the address is site local. +

+
+

+ is_unspecified +

+ 		+

+ Determine whether the address is unspecified. +

+
+

+ is_v4_mapped +

+ 		+

+ Determine whether the address is a mapped IPv4 address. +

+
+

+ loopback [static] +

+ 		+

+ Obtain an address object that represents the loopback address. +

+
+

+ operator= +

+ 		+

+ Assign from another address.
—
Move-assign from another + address. +

+
+

+ scope_id +

+ 		+

+ The scope ID of the address. +

+
+

+ to_bytes +

+ 		+

+ Get the address in bytes, in network byte order. +

+
+

+ to_string +

+ 		+

+ Get the address as a string. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator< +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ operator> +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare addresses for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_address_v6 +

+ 		+

+ Create an IPv6 address from raw bytes and scope ID. +

+

+ Create an IPv6 address from an IP address string. +

+

+ Createan IPv6 address from an IP address string. +

+

+ Create an IPv4-mapped IPv6 address from an IPv4 address. +

+
+

+ make_network_v6 +

+ 		+

+ Create an IPv6 network from an address and prefix length. +

+
+

+ operator<< +

+ 		+

+ Output an address as a string. +

+

+ Output a network as a string. +

+
+

+ The ip::address_v6 + class provides the ability to use and manipulate IP version 6 addresses. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6.html new file mode 100644 index 0000000..ab57029 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6.html @@ -0,0 +1,65 @@ + + + +ip::address_v6::address_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
address_v6();
+  » more...
+
+

+ Construct an address from raw bytes and scope ID. +

+
explicit address_v6(
+    const bytes_type & bytes,
+    scope_id_type scope_id = 0);
+  » more...
+
+

+ Copy constructor. +

+
address_v6(
+    const address_v6 & other);
+  » more...
+
+

+ Move constructor. +

+
address_v6(
+    address_v6 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload1.html new file mode 100644 index 0000000..f41e25d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload1.html @@ -0,0 +1,49 @@ + + + +ip::address_v6::address_v6 (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
address_v6();
+
+

+ Initialises the address_v6 + object such that: * to_bytes() yields {0, 0, ..., 0}; and +

+
  • + scope_id() + == 0. +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload2.html new file mode 100644 index 0000000..b4b9944 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload2.html @@ -0,0 +1,66 @@ + + + +ip::address_v6::address_v6 (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an address from raw bytes and scope ID. +

+
address_v6(
+    const bytes_type & bytes,
+    scope_id_type scope_id = 0);
+
+

+ Initialises the address_v6 + object such that: * to_bytes() == bytes; and +

+
  • + this->scope_id() + == scope_id. +
+
+ + Exceptions +
+
+

+
+
out_of_range
+

+ Thrown if any element in bytes + is not in the range 0 - 0xFF. + Note that no range checking is required for platforms where std::numeric_limits<unsigned char>::max() is 0xFF. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload3.html new file mode 100644 index 0000000..ee6095c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload3.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::address_v6 (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
address_v6(
+    const address_v6 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload4.html new file mode 100644 index 0000000..30c8f16 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/address_v6/overload4.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::address_v6 (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
address_v6(
+    address_v6 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/any.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/any.html new file mode 100644 index 0000000..40945ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/any.html @@ -0,0 +1,55 @@ + + + +ip::address_v6::any + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address object + that represents any address. +

+
static address_v6 any();
+
+

+ This functions returns an address that represents the "any" address + ::. +

+
+ + Return + Value +
+

+ A default-constructed address_v6 + object. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/bytes_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/bytes_type.html new file mode 100644 index 0000000..76ed5a5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/bytes_type.html @@ -0,0 +1,60 @@ + + + +ip::address_v6::bytes_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + used to represent an address as an array of bytes. +

+
typedef array< unsigned char, 16 > bytes_type;
+
+
+ + Remarks +
+

+ This type is defined in terms of the C++0x template std::array + when it is available. Otherwise, it uses boost:array. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_link_local.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_link_local.html new file mode 100644 index 0000000..8856d3f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_link_local.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_link_local + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is link local. +

+
bool is_link_local() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_loopback.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_loopback.html new file mode 100644 index 0000000..f4dbc10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_loopback.html @@ -0,0 +1,45 @@ + + + +ip::address_v6::is_loopback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a loopback address. +

+
bool is_loopback() const;
+
+

+ This function tests whether the address is the loopback address ::1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast.html new file mode 100644 index 0000000..b69c013 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_multicast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a multicast address. +

+
bool is_multicast() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_global.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_global.html new file mode 100644 index 0000000..1d3330f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_global.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_multicast_global + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a global multicast address. +

+
bool is_multicast_global() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_link_local.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_link_local.html new file mode 100644 index 0000000..a7afc8e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_link_local.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_multicast_link_local + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a link-local multicast address. +

+
bool is_multicast_link_local() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_node_local.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_node_local.html new file mode 100644 index 0000000..964dd18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_node_local.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_multicast_node_local + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a node-local multicast address. +

+
bool is_multicast_node_local() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_org_local.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_org_local.html new file mode 100644 index 0000000..e42ef5f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_org_local.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_multicast_org_local + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a org-local multicast address. +

+
bool is_multicast_org_local() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_site_local.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_site_local.html new file mode 100644 index 0000000..c956853 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_multicast_site_local.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_multicast_site_local + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a site-local multicast address. +

+
bool is_multicast_site_local() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_site_local.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_site_local.html new file mode 100644 index 0000000..83067aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_site_local.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_site_local + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is site local. +

+
bool is_site_local() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_unspecified.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_unspecified.html new file mode 100644 index 0000000..e33428b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_unspecified.html @@ -0,0 +1,45 @@ + + + +ip::address_v6::is_unspecified + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is unspecified. +

+
bool is_unspecified() const;
+
+

+ This function tests whether the address is the loopback address ::. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_v4_mapped.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_v4_mapped.html new file mode 100644 index 0000000..1ed4612 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/is_v4_mapped.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::is_v4_mapped + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the address is a mapped IPv4 address. +

+
bool is_v4_mapped() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/loopback.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/loopback.html new file mode 100644 index 0000000..d2f6f42 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/loopback.html @@ -0,0 +1,46 @@ + + + +ip::address_v6::loopback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address + object that represents the loopback address. +

+
static address_v6 loopback();
+
+

+ This function returns an address that represents the well-known loopback + address ::1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6.html new file mode 100644 index 0000000..991c859 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6.html @@ -0,0 +1,86 @@ + + + +ip::address_v6::make_address_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + an IPv6 address from raw bytes and scope ID. +

+
address_v6 make_address_v6(
+    const address_v6::bytes_type & bytes,
+    scope_id_type scope_id = 0);
+  » more...
+
+

+ Create an IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    const char * str);
+  » more...
+
+address_v6 make_address_v6(
+    const char * str,
+    asio::error_code & ec);
+  » more...
+
+

+ Createan IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    const std::string & str);
+  » more...
+
+address_v6 make_address_v6(
+    const std::string & str,
+    asio::error_code & ec);
+  » more...
+
+address_v6 make_address_v6(
+    string_view str);
+  » more...
+
+address_v6 make_address_v6(
+    string_view str,
+    asio::error_code & ec);
+  » more...
+
+

+ Create an IPv4-mapped IPv6 address from an IPv4 address. +

+
address_v6 make_address_v6(
+    v4_mapped_t ,
+    const address_v4 & v4_addr);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload1.html new file mode 100644 index 0000000..e126c4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload1.html @@ -0,0 +1,43 @@ + + + +ip::address_v6::make_address_v6 (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 address from raw bytes and scope ID. +

+
address_v6 make_address_v6(
+    const address_v6::bytes_type & bytes,
+    scope_id_type scope_id = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload2.html new file mode 100644 index 0000000..54ebda6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload2.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::make_address_v6 (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    const char * str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload3.html new file mode 100644 index 0000000..433fae9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload3.html @@ -0,0 +1,43 @@ + + + +ip::address_v6::make_address_v6 (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    const char * str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload4.html new file mode 100644 index 0000000..d03c2cd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload4.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::make_address_v6 (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Createan IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    const std::string & str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload5.html new file mode 100644 index 0000000..2d0c424 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload5.html @@ -0,0 +1,43 @@ + + + +ip::address_v6::make_address_v6 (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    const std::string & str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload6.html new file mode 100644 index 0000000..298f993 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload6.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::make_address_v6 (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    string_view str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload7.html new file mode 100644 index 0000000..05a5084 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload7.html @@ -0,0 +1,43 @@ + + + +ip::address_v6::make_address_v6 (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 address from an IP address string. +

+
address_v6 make_address_v6(
+    string_view str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload8.html new file mode 100644 index 0000000..95cf829 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_address_v6/overload8.html @@ -0,0 +1,43 @@ + + + +ip::address_v6::make_address_v6 (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4-mapped IPv6 address from an IPv4 address. +

+
address_v6 make_address_v6(
+    v4_mapped_t ,
+    const address_v4 & v4_addr);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_network_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_network_v6.html new file mode 100644 index 0000000..0da34bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/make_network_v6.html @@ -0,0 +1,44 @@ + + + +ip::address_v6::make_network_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + an IPv6 network from an address and prefix length. +

+
network_v6 make_network_v6(
+    const address_v6 & addr,
+    unsigned short prefix_len);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_.html new file mode 100644 index 0000000..20a9d51 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::address_v6::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + from another address. +

+
address_v6 & operator=(
+    const address_v6 & other);
+  » more...
+
+

+ Move-assign from another address. +

+
address_v6 & operator=(
+    address_v6 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_/overload1.html new file mode 100644 index 0000000..a68618d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another address. +

+
address_v6 & operator=(
+    const address_v6 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_/overload2.html new file mode 100644 index 0000000..2537f26 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another address. +

+
address_v6 & operator=(
+    address_v6 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq__eq_.html new file mode 100644 index 0000000..ea72764 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address_v6::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two addresses for equality. +

+
bool operator==(
+    const address_v6 & a1,
+    const address_v6 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_gt_.html new file mode 100644 index 0000000..4891354 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_gt_.html @@ -0,0 +1,54 @@ + + + +ip::address_v6::operator> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator>(
+    const address_v6 & a1,
+    const address_v6 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_gt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_gt__eq_.html new file mode 100644 index 0000000..15c1560 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_gt__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address_v6::operator>= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator>=(
+    const address_v6 & a1,
+    const address_v6 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt_.html new file mode 100644 index 0000000..badd6ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt_.html @@ -0,0 +1,54 @@ + + + +ip::address_v6::operator< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator<(
+    const address_v6 & a1,
+    const address_v6 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__eq_.html new file mode 100644 index 0000000..76ef63c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address_v6::operator<= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + addresses for ordering. +

+
bool operator<=(
+    const address_v6 & a1,
+    const address_v6 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_.html new file mode 100644 index 0000000..6e2b358 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_.html @@ -0,0 +1,59 @@ + + + +ip::address_v6::operator<< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Output + an address as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const address_v6 & addr);
+  » more...
+
+

+ Output a network as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const network_v6 & net);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_/overload1.html new file mode 100644 index 0000000..a6c7e92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_/overload1.html @@ -0,0 +1,74 @@ + + + +ip::address_v6::operator<< (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Output an address as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const address_v6 & addr);
+
+

+ Used to output a human-readable string for a specified address. +

+
+ + Parameters +
+
+

+
+
os
+

+ The output stream to which the string will be written. +

+
addr
+

+ The address to be written. +

+
+
+
+ + Return + Value +
+

+ The output stream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_/overload2.html new file mode 100644 index 0000000..3ae4f31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_lt__lt_/overload2.html @@ -0,0 +1,74 @@ + + + +ip::address_v6::operator<< (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Output a network as a string. +

+
template<
+    typename Elem,
+    typename Traits>
+std::basic_ostream< Elem, Traits > & operator<<(
+    std::basic_ostream< Elem, Traits > & os,
+    const network_v6 & net);
+
+

+ Used to output a human-readable string for a specified network. +

+
+ + Parameters +
+
+

+
+
os
+

+ The output stream to which the string will be written. +

+
net
+

+ The network to be written. +

+
+
+
+ + Return + Value +
+

+ The output stream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_not__eq_.html new file mode 100644 index 0000000..1e70d04 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::address_v6::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two addresses for inequality. +

+
bool operator!=(
+    const address_v6 & a1,
+    const address_v6 & a2);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id.html new file mode 100644 index 0000000..e2c15a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id.html @@ -0,0 +1,47 @@ + + + +ip::address_v6::scope_id + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The scope ID + of the address. +

+
scope_id_type scope_id() const;
+  » more...
+
+void scope_id(
+    scope_id_type id);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id/overload1.html new file mode 100644 index 0000000..ad5d7ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id/overload1.html @@ -0,0 +1,44 @@ + + + +ip::address_v6::scope_id (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The scope ID of the address. +

+
scope_id_type scope_id() const;
+
+

+ Returns the scope ID associated with the IPv6 address. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id/overload2.html new file mode 100644 index 0000000..26c6552 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/scope_id/overload2.html @@ -0,0 +1,58 @@ + + + +ip::address_v6::scope_id (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ The scope ID of the address. +

+
void scope_id(
+    scope_id_type id);
+
+

+ Modifies the scope ID associated with the IPv6 address. +

+
+ + Parameters +
+
+

+
+
id
+

+ The new scope ID. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/to_bytes.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/to_bytes.html new file mode 100644 index 0000000..b406666 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/to_bytes.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::to_bytes + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address + in bytes, in network byte order. +

+
bytes_type to_bytes() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/to_string.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/to_string.html new file mode 100644 index 0000000..061dec9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6/to_string.html @@ -0,0 +1,42 @@ + + + +ip::address_v6::to_string + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the address + as a string. +

+
std::string to_string() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6__gt_.html new file mode 100644 index 0000000..91f935c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6__gt_.html @@ -0,0 +1,83 @@ + + + +ip::address_v6 > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct hash< asio::ip::address_v6 >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6__gt_/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6__gt_/operator_lp__rp_.html new file mode 100644 index 0000000..9938706 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6__gt_/operator_lp__rp_.html @@ -0,0 +1,42 @@ + + + +ip::address_v6 >::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::size_t operator()(
+    const asio::ip::address_v6 & addr) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6_iterator.html new file mode 100644 index 0000000..ce9ffd8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6_iterator.html @@ -0,0 +1,297 @@ + + + +ip::address_v6_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An input iterator that can be used for traversing IPv6 addresses. +

+
typedef basic_address_iterator< address_v6 > address_v6_iterator;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ Distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ Denotes that the iterator satisfies the input iterator requirements. +

+
+

+ pointer +

+ 		+

+ The type of a pointer to an element pointed to by the iterator. +

+
+

+ reference +

+ 		+

+ The type of a reference to an element pointed to by the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the elements pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_iterator +

+ 		+

+ Construct an iterator that points to the specified address.
+ —
Copy constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference the iterator. +

+
+

+ operator++ +

+ 		+

+ Pre-increment operator.
—
Post-increment operator. +

+
+

+ operator-- +

+ 		+

+ Pre-decrement operator.
—
Post-decrement operator. +

+
+

+ operator-> +

+ 		+

+ Dereference the iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ In addition to satisfying the input iterator requirements, this iterator + also supports decrement. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6_range.html b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6_range.html new file mode 100644 index 0000000..503e5fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__address_v6_range.html @@ -0,0 +1,196 @@ + + + +ip::address_v6_range + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Represents a range of IPv6 addresses. +

+
typedef basic_address_range< address_v6 > address_v6_range;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ iterator +

+ 		+

+ The type of an iterator that points into the range. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_range +

+ 		+

+ Construct an empty range.
—
Construct an range that + represents the given range of addresses.
—
Copy constructor. +
—
Move constructor. +

+
+

+ begin +

+ 		+

+ Obtain an iterator that points to the start of the range. +

+
+

+ empty +

+ 		+

+ Determine whether the range is empty. +

+
+

+ end +

+ 		+

+ Obtain an iterator that points to the end of the range. +

+
+

+ find +

+ 		+

+ Find an address in the range. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6_range.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast.html new file mode 100644 index 0000000..28b2ff3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast.html @@ -0,0 +1,114 @@ + + + +ip::bad_address_cast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Thrown to indicate a failed address conversion. +

+
class bad_address_cast :
+  public std::bad_cast
+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bad_address_cast [constructor] +

+ 		+

+ Default constructor.
—
Copy constructor. +

+
+

+ what +

+ 		+

+ Get the message associated with the exception. +

+
+

+ ~bad_address_cast [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Requirements +
+

+ Header: asio/ip/bad_address_cast.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/_bad_address_cast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/_bad_address_cast.html new file mode 100644 index 0000000..bff2544 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/_bad_address_cast.html @@ -0,0 +1,41 @@ + + + +ip::bad_address_cast::~bad_address_cast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
virtual ~bad_address_cast();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast.html new file mode 100644 index 0000000..4ab7eda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast.html @@ -0,0 +1,50 @@ + + + +ip::bad_address_cast::bad_address_cast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
bad_address_cast();
+  » more...
+
+

+ Copy constructor. +

+
bad_address_cast(
+    const bad_address_cast & other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast/overload1.html new file mode 100644 index 0000000..8951145 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast/overload1.html @@ -0,0 +1,41 @@ + + + +ip::bad_address_cast::bad_address_cast (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
bad_address_cast();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast/overload2.html new file mode 100644 index 0000000..bf5f236 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/bad_address_cast/overload2.html @@ -0,0 +1,42 @@ + + + +ip::bad_address_cast::bad_address_cast (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
bad_address_cast(
+    const bad_address_cast & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/what.html b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/what.html new file mode 100644 index 0000000..587b3fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__bad_address_cast/what.html @@ -0,0 +1,42 @@ + + + +ip::bad_address_cast::what + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + message associated with the exception. +

+
virtual const char * what() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator.html new file mode 100644 index 0000000..f14cd4e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+     >
+class basic_address_iterator
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_.html new file mode 100644 index 0000000..4a2e7a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_.html @@ -0,0 +1,300 @@ + + + +ip::basic_address_iterator< address_v4 > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An input iterator that can be used for traversing IPv4 addresses. +

+
template<>
+class basic_address_iterator< address_v4 >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ Distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ Denotes that the iterator satisfies the input iterator requirements. +

+
+

+ pointer +

+ 		+

+ The type of a pointer to an element pointed to by the iterator. +

+
+

+ reference +

+ 		+

+ The type of a reference to an element pointed to by the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the elements pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_iterator +

+ 		+

+ Construct an iterator that points to the specified address.
+ —
Copy constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference the iterator. +

+
+

+ operator++ +

+ 		+

+ Pre-increment operator.
—
Post-increment operator. +

+
+

+ operator-- +

+ 		+

+ Pre-decrement operator.
—
Post-decrement operator. +

+
+

+ operator-> +

+ 		+

+ Dereference the iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ In addition to satisfying the input iterator requirements, this iterator + also supports decrement. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator.html new file mode 100644 index 0000000..e9f29c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator.html @@ -0,0 +1,58 @@ + + + +ip::basic_address_iterator< address_v4 >::basic_address_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct an iterator that points to the specified address. +

+
basic_address_iterator(
+    const address_v4 & addr);
+  » more...
+
+

+ Copy constructor. +

+
basic_address_iterator(
+    const basic_address_iterator & other);
+  » more...
+
+

+ Move constructor. +

+
basic_address_iterator(
+    basic_address_iterator && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload1.html new file mode 100644 index 0000000..3cbd471 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::basic_address_iterator (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an iterator that points to the specified address. +

+
basic_address_iterator(
+    const address_v4 & addr);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload2.html new file mode 100644 index 0000000..057e22a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::basic_address_iterator (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_address_iterator(
+    const basic_address_iterator & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload3.html new file mode 100644 index 0000000..4c92676 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/basic_address_iterator/overload3.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::basic_address_iterator (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_address_iterator(
+    basic_address_iterator && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/difference_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/difference_type.html new file mode 100644 index 0000000..d00bec4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/difference_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_iterator< address_v4 >::difference_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Distance between two iterators. +

+
typedef std::ptrdiff_t difference_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/iterator_category.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/iterator_category.html new file mode 100644 index 0000000..c27e501 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/iterator_category.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_iterator< address_v4 >::iterator_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Denotes that the iterator satisfies the input iterator requirements. +

+
typedef std::input_iterator_tag iterator_category;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_arrow_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_arrow_.html new file mode 100644 index 0000000..9e3feaf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_arrow_.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::operator-> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference the iterator. +

+
const address_v4 * operator->() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_.html new file mode 100644 index 0000000..cc138b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_address_iterator< address_v4 >::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment operator. +

+
basic_address_iterator & operator=(
+    const basic_address_iterator & other);
+  » more...
+
+

+ Move assignment operator. +

+
basic_address_iterator & operator=(
+    basic_address_iterator && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_/overload1.html new file mode 100644 index 0000000..aa90d03 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_address_iterator & operator=(
+    const basic_address_iterator & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_/overload2.html new file mode 100644 index 0000000..436fe5e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
basic_address_iterator & operator=(
+    basic_address_iterator && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq__eq_.html new file mode 100644 index 0000000..60d9317 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_address_iterator< address_v4 >::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two addresses for equality. +

+
bool operator==(
+    const basic_address_iterator & a,
+    const basic_address_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_.html new file mode 100644 index 0000000..29a0db0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_.html @@ -0,0 +1,50 @@ + + + +ip::basic_address_iterator< address_v4 >::operator-- + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Pre-decrement operator. +

+
basic_address_iterator & operator--();
+  » more...
+
+

+ Post-decrement operator. +

+
basic_address_iterator operator--(
+    int );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_/overload1.html new file mode 100644 index 0000000..9de1f85 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_address_iterator< address_v4 >::operator-- (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Pre-decrement operator. +

+
basic_address_iterator & operator--();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_/overload2.html new file mode 100644 index 0000000..b0c39e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_minus__minus_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::operator-- (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Post-decrement operator. +

+
basic_address_iterator operator--(
+    int );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_not__eq_.html new file mode 100644 index 0000000..fa3c9ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_address_iterator< address_v4 >::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two addresses for inequality. +

+
bool operator!=(
+    const basic_address_iterator & a,
+    const basic_address_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_.html new file mode 100644 index 0000000..0b3da94 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_.html @@ -0,0 +1,50 @@ + + + +ip::basic_address_iterator< address_v4 >::operator++ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Pre-increment operator. +

+
basic_address_iterator & operator++();
+  » more...
+
+

+ Post-increment operator. +

+
basic_address_iterator operator++(
+    int );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_/overload1.html new file mode 100644 index 0000000..eeb8491 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_address_iterator< address_v4 >::operator++ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Pre-increment operator. +

+
basic_address_iterator & operator++();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_/overload2.html new file mode 100644 index 0000000..bb2aca1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_plus__plus_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::operator++ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Post-increment operator. +

+
basic_address_iterator operator++(
+    int );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_star_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_star_.html new file mode 100644 index 0000000..458dcc6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/operator_star_.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v4 >::operator* + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference the iterator. +

+
const address_v4 & operator*() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/pointer.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/pointer.html new file mode 100644 index 0000000..47af246 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/pointer.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_iterator< address_v4 >::pointer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of a pointer to an element pointed to by the iterator. +

+
typedef const address_v4 * pointer;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/reference.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/reference.html new file mode 100644 index 0000000..21dba2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/reference.html @@ -0,0 +1,452 @@ + + + +ip::basic_address_iterator< address_v4 >::reference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of a reference to an element pointed to by the + iterator. +

+
typedef const address_v4 & reference;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bytes_type +

+ 		+

+ The type used to represent an address as an array of bytes. +

+
+

+ uint_type +

+ 		+

+ The type used to represent an address as an unsigned integer. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_v4 [constructor] +

+ 		+

+ Default constructor.
—
Construct an address from + raw bytes.
—
Construct an address from an unsigned + integer in host byte order.
—
Copy constructor. +
—
Move constructor. +

+
+

+ any + [static] +

+ 		+

+ Obtain an address object that represents any address. +

+
+

+ broadcast [static] +

+ 		+

+ Obtain an address object that represents the broadcast address. +

+
+

+ is_loopback +

+ 		+

+ Determine whether the address is a loopback address. +

+
+

+ is_multicast +

+ 		+

+ Determine whether the address is a multicast address. +

+
+

+ is_unspecified +

+ 		+

+ Determine whether the address is unspecified. +

+
+

+ loopback [static] +

+ 		+

+ Obtain an address object that represents the loopback address. +

+
+

+ operator= +

+ 		+

+ Assign from another address.
—
Move-assign from another + address. +

+
+

+ to_bytes +

+ 		+

+ Get the address in bytes, in network byte order. +

+
+

+ to_string +

+ 		+

+ Get the address as a string in dotted decimal format. +

+
+

+ to_uint +

+ 		+

+ Get the address as an unsigned integer in host byte order. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator< +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ operator> +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare addresses for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_address_v4 +

+ 		+

+ Create an IPv4 address from raw bytes in network order. +

+

+ Create an IPv4 address from an unsigned integer in host byte + order. +

+

+ Create an IPv4 address from an IP address string in dotted decimal + form. +

+

+ Create an IPv4 address from a IPv4-mapped IPv6 address. +

+
+

+ make_network_v4 +

+ 		+

+ Create an IPv4 network from an address and prefix length. +

+

+ Create an IPv4 network from an address and netmask. +

+
+

+ operator<< +

+ 		+

+ Output an address as a string. +

+

+ Output a network as a string. +

+
+

+ The ip::address_v4 + class provides the ability to use and manipulate IP version 4 addresses. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/value_type.html new file mode 100644 index 0000000..93bab93 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v4__gt_/value_type.html @@ -0,0 +1,451 @@ + + + +ip::basic_address_iterator< address_v4 >::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of the elements pointed to by the iterator. +

+
typedef address_v4 value_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bytes_type +

+ 		+

+ The type used to represent an address as an array of bytes. +

+
+

+ uint_type +

+ 		+

+ The type used to represent an address as an unsigned integer. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_v4 [constructor] +

+ 		+

+ Default constructor.
—
Construct an address from + raw bytes.
—
Construct an address from an unsigned + integer in host byte order.
—
Copy constructor. +
—
Move constructor. +

+
+

+ any + [static] +

+ 		+

+ Obtain an address object that represents any address. +

+
+

+ broadcast [static] +

+ 		+

+ Obtain an address object that represents the broadcast address. +

+
+

+ is_loopback +

+ 		+

+ Determine whether the address is a loopback address. +

+
+

+ is_multicast +

+ 		+

+ Determine whether the address is a multicast address. +

+
+

+ is_unspecified +

+ 		+

+ Determine whether the address is unspecified. +

+
+

+ loopback [static] +

+ 		+

+ Obtain an address object that represents the loopback address. +

+
+

+ operator= +

+ 		+

+ Assign from another address.
—
Move-assign from another + address. +

+
+

+ to_bytes +

+ 		+

+ Get the address in bytes, in network byte order. +

+
+

+ to_string +

+ 		+

+ Get the address as a string in dotted decimal format. +

+
+

+ to_uint +

+ 		+

+ Get the address as an unsigned integer in host byte order. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator< +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ operator> +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare addresses for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_address_v4 +

+ 		+

+ Create an IPv4 address from raw bytes in network order. +

+

+ Create an IPv4 address from an unsigned integer in host byte + order. +

+

+ Create an IPv4 address from an IP address string in dotted decimal + form. +

+

+ Create an IPv4 address from a IPv4-mapped IPv6 address. +

+
+

+ make_network_v4 +

+ 		+

+ Create an IPv4 network from an address and prefix length. +

+

+ Create an IPv4 network from an address and netmask. +

+
+

+ operator<< +

+ 		+

+ Output an address as a string. +

+

+ Output a network as a string. +

+
+

+ The ip::address_v4 + class provides the ability to use and manipulate IP version 4 addresses. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_.html new file mode 100644 index 0000000..961c2fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_.html @@ -0,0 +1,300 @@ + + + +ip::basic_address_iterator< address_v6 > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An input iterator that can be used for traversing IPv6 addresses. +

+
template<>
+class basic_address_iterator< address_v6 >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ Distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ Denotes that the iterator satisfies the input iterator requirements. +

+
+

+ pointer +

+ 		+

+ The type of a pointer to an element pointed to by the iterator. +

+
+

+ reference +

+ 		+

+ The type of a reference to an element pointed to by the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the elements pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_iterator +

+ 		+

+ Construct an iterator that points to the specified address.
+ —
Copy constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference the iterator. +

+
+

+ operator++ +

+ 		+

+ Pre-increment operator.
—
Post-increment operator. +

+
+

+ operator-- +

+ 		+

+ Pre-decrement operator.
—
Post-decrement operator. +

+
+

+ operator-> +

+ 		+

+ Dereference the iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ In addition to satisfying the input iterator requirements, this iterator + also supports decrement. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator.html new file mode 100644 index 0000000..e9d405e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator.html @@ -0,0 +1,58 @@ + + + +ip::basic_address_iterator< address_v6 >::basic_address_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct an iterator that points to the specified address. +

+
basic_address_iterator(
+    const address_v6 & addr);
+  » more...
+
+

+ Copy constructor. +

+
basic_address_iterator(
+    const basic_address_iterator & other);
+  » more...
+
+

+ Move constructor. +

+
basic_address_iterator(
+    basic_address_iterator && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload1.html new file mode 100644 index 0000000..df217fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::basic_address_iterator (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an iterator that points to the specified address. +

+
basic_address_iterator(
+    const address_v6 & addr);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload2.html new file mode 100644 index 0000000..a0880bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::basic_address_iterator (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_address_iterator(
+    const basic_address_iterator & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload3.html new file mode 100644 index 0000000..e859725 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/basic_address_iterator/overload3.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::basic_address_iterator (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_address_iterator(
+    basic_address_iterator && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/difference_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/difference_type.html new file mode 100644 index 0000000..ac214fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/difference_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_iterator< address_v6 >::difference_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Distance between two iterators. +

+
typedef std::ptrdiff_t difference_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/iterator_category.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/iterator_category.html new file mode 100644 index 0000000..01b6082 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/iterator_category.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_iterator< address_v6 >::iterator_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Denotes that the iterator satisfies the input iterator requirements. +

+
typedef std::input_iterator_tag iterator_category;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_arrow_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_arrow_.html new file mode 100644 index 0000000..e787230 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_arrow_.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::operator-> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference the iterator. +

+
const address_v6 * operator->() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_.html new file mode 100644 index 0000000..baa7f83 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_address_iterator< address_v6 >::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment operator. +

+
basic_address_iterator & operator=(
+    const basic_address_iterator & other);
+  » more...
+
+

+ Move assignment operator. +

+
basic_address_iterator & operator=(
+    basic_address_iterator && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_/overload1.html new file mode 100644 index 0000000..8551865 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_address_iterator & operator=(
+    const basic_address_iterator & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_/overload2.html new file mode 100644 index 0000000..ff61754 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
basic_address_iterator & operator=(
+    basic_address_iterator && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq__eq_.html new file mode 100644 index 0000000..7f228e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_address_iterator< address_v6 >::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two addresses for equality. +

+
bool operator==(
+    const basic_address_iterator & a,
+    const basic_address_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_.html new file mode 100644 index 0000000..3205fff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_.html @@ -0,0 +1,50 @@ + + + +ip::basic_address_iterator< address_v6 >::operator-- + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Pre-decrement operator. +

+
basic_address_iterator & operator--();
+  » more...
+
+

+ Post-decrement operator. +

+
basic_address_iterator operator--(
+    int );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_/overload1.html new file mode 100644 index 0000000..d4b9d2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_address_iterator< address_v6 >::operator-- (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Pre-decrement operator. +

+
basic_address_iterator & operator--();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_/overload2.html new file mode 100644 index 0000000..863c079 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_minus__minus_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::operator-- (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Post-decrement operator. +

+
basic_address_iterator operator--(
+    int );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_not__eq_.html new file mode 100644 index 0000000..65db65a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_address_iterator< address_v6 >::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two addresses for inequality. +

+
bool operator!=(
+    const basic_address_iterator & a,
+    const basic_address_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_.html new file mode 100644 index 0000000..e813f17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_.html @@ -0,0 +1,50 @@ + + + +ip::basic_address_iterator< address_v6 >::operator++ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Pre-increment operator. +

+
basic_address_iterator & operator++();
+  » more...
+
+

+ Post-increment operator. +

+
basic_address_iterator operator++(
+    int );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_/overload1.html new file mode 100644 index 0000000..5acb72d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_address_iterator< address_v6 >::operator++ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Pre-increment operator. +

+
basic_address_iterator & operator++();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_/overload2.html new file mode 100644 index 0000000..a5201e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_plus__plus_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::operator++ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Post-increment operator. +

+
basic_address_iterator operator++(
+    int );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_star_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_star_.html new file mode 100644 index 0000000..9a06c1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/operator_star_.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_iterator< address_v6 >::operator* + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference the iterator. +

+
const address_v6 & operator*() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/pointer.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/pointer.html new file mode 100644 index 0000000..2480b7e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/pointer.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_iterator< address_v6 >::pointer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of a pointer to an element pointed to by the iterator. +

+
typedef const address_v6 * pointer;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/reference.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/reference.html new file mode 100644 index 0000000..3e7c3ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/reference.html @@ -0,0 +1,516 @@ + + + +ip::basic_address_iterator< address_v6 >::reference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of a reference to an element pointed to by the + iterator. +

+
typedef const address_v6 & reference;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bytes_type +

+ 		+

+ The type used to represent an address as an array of bytes. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_v6 [constructor] +

+ 		+

+ Default constructor.
—
Construct an address from + raw bytes and scope ID.
—
Copy constructor.
+ —
Move constructor. +

+
+

+ any + [static] +

+ 		+

+ Obtain an address object that represents any address. +

+
+

+ is_link_local +

+ 		+

+ Determine whether the address is link local. +

+
+

+ is_loopback +

+ 		+

+ Determine whether the address is a loopback address. +

+
+

+ is_multicast +

+ 		+

+ Determine whether the address is a multicast address. +

+
+

+ is_multicast_global +

+ 		+

+ Determine whether the address is a global multicast address. +

+
+

+ is_multicast_link_local +

+ 		+

+ Determine whether the address is a link-local multicast address. +

+
+

+ is_multicast_node_local +

+ 		+

+ Determine whether the address is a node-local multicast address. +

+
+

+ is_multicast_org_local +

+ 		+

+ Determine whether the address is a org-local multicast address. +

+
+

+ is_multicast_site_local +

+ 		+

+ Determine whether the address is a site-local multicast address. +

+
+

+ is_site_local +

+ 		+

+ Determine whether the address is site local. +

+
+

+ is_unspecified +

+ 		+

+ Determine whether the address is unspecified. +

+
+

+ is_v4_mapped +

+ 		+

+ Determine whether the address is a mapped IPv4 address. +

+
+

+ loopback [static] +

+ 		+

+ Obtain an address object that represents the loopback address. +

+
+

+ operator= +

+ 		+

+ Assign from another address.
—
Move-assign from another + address. +

+
+

+ scope_id +

+ 		+

+ The scope ID of the address. +

+
+

+ to_bytes +

+ 		+

+ Get the address in bytes, in network byte order. +

+
+

+ to_string +

+ 		+

+ Get the address as a string. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator< +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ operator> +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare addresses for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_address_v6 +

+ 		+

+ Create an IPv6 address from raw bytes and scope ID. +

+

+ Create an IPv6 address from an IP address string. +

+

+ Createan IPv6 address from an IP address string. +

+

+ Create an IPv4-mapped IPv6 address from an IPv4 address. +

+
+

+ make_network_v6 +

+ 		+

+ Create an IPv6 network from an address and prefix length. +

+
+

+ operator<< +

+ 		+

+ Output an address as a string. +

+

+ Output a network as a string. +

+
+

+ The ip::address_v6 + class provides the ability to use and manipulate IP version 6 addresses. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/value_type.html new file mode 100644 index 0000000..03acb38 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_iterator_lt__address_v6__gt_/value_type.html @@ -0,0 +1,515 @@ + + + +ip::basic_address_iterator< address_v6 >::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of the elements pointed to by the iterator. +

+
typedef address_v6 value_type;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bytes_type +

+ 		+

+ The type used to represent an address as an array of bytes. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_v6 [constructor] +

+ 		+

+ Default constructor.
—
Construct an address from + raw bytes and scope ID.
—
Copy constructor.
+ —
Move constructor. +

+
+

+ any + [static] +

+ 		+

+ Obtain an address object that represents any address. +

+
+

+ is_link_local +

+ 		+

+ Determine whether the address is link local. +

+
+

+ is_loopback +

+ 		+

+ Determine whether the address is a loopback address. +

+
+

+ is_multicast +

+ 		+

+ Determine whether the address is a multicast address. +

+
+

+ is_multicast_global +

+ 		+

+ Determine whether the address is a global multicast address. +

+
+

+ is_multicast_link_local +

+ 		+

+ Determine whether the address is a link-local multicast address. +

+
+

+ is_multicast_node_local +

+ 		+

+ Determine whether the address is a node-local multicast address. +

+
+

+ is_multicast_org_local +

+ 		+

+ Determine whether the address is a org-local multicast address. +

+
+

+ is_multicast_site_local +

+ 		+

+ Determine whether the address is a site-local multicast address. +

+
+

+ is_site_local +

+ 		+

+ Determine whether the address is site local. +

+
+

+ is_unspecified +

+ 		+

+ Determine whether the address is unspecified. +

+
+

+ is_v4_mapped +

+ 		+

+ Determine whether the address is a mapped IPv4 address. +

+
+

+ loopback [static] +

+ 		+

+ Obtain an address object that represents the loopback address. +

+
+

+ operator= +

+ 		+

+ Assign from another address.
—
Move-assign from another + address. +

+
+

+ scope_id +

+ 		+

+ The scope ID of the address. +

+
+

+ to_bytes +

+ 		+

+ Get the address in bytes, in network byte order. +

+
+

+ to_string +

+ 		+

+ Get the address as a string. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator< +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ operator> +

+ 		+

+ Compare addresses for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare addresses for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_address_v6 +

+ 		+

+ Create an IPv6 address from raw bytes and scope ID. +

+

+ Create an IPv6 address from an IP address string. +

+

+ Createan IPv6 address from an IP address string. +

+

+ Create an IPv4-mapped IPv6 address from an IPv4 address. +

+
+

+ make_network_v6 +

+ 		+

+ Create an IPv6 network from an address and prefix length. +

+
+

+ operator<< +

+ 		+

+ Output an address as a string. +

+

+ Output a network as a string. +

+
+

+ The ip::address_v6 + class provides the ability to use and manipulate IP version 6 addresses. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range.html new file mode 100644 index 0000000..b94fd28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range.html @@ -0,0 +1,52 @@ + + + +ip::basic_address_range + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+     >
+class basic_address_range
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v4_range.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_.html new file mode 100644 index 0000000..f1d6131 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_.html @@ -0,0 +1,211 @@ + + + +ip::basic_address_range< address_v4 > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Represents a range of IPv4 addresses. +

+
template<>
+class basic_address_range< address_v4 >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ iterator +

+ 		+

+ The type of an iterator that points into the range. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_range +

+ 		+

+ Construct an empty range.
—
Construct an range that + represents the given range of addresses.
—
Copy constructor. +
—
Move constructor. +

+
+

+ begin +

+ 		+

+ Obtain an iterator that points to the start of the range. +

+
+

+ empty +

+ 		+

+ Determine whether the range is empty. +

+
+

+ end +

+ 		+

+ Obtain an iterator that points to the end of the range. +

+
+

+ find +

+ 		+

+ Find an address in the range. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+

+ size +

+ 		+

+ Return the size of the range. +

+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4_range.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range.html new file mode 100644 index 0000000..afdf868 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range.html @@ -0,0 +1,65 @@ + + + +ip::basic_address_range< address_v4 >::basic_address_range + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct an empty range. +

+
basic_address_range();
+  » more...
+
+

+ Construct an range that represents the given range of addresses. +

+
explicit basic_address_range(
+    const iterator & first,
+    const iterator & last);
+  » more...
+
+

+ Copy constructor. +

+
basic_address_range(
+    const basic_address_range & other);
+  » more...
+
+

+ Move constructor. +

+
basic_address_range(
+    basic_address_range && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload1.html new file mode 100644 index 0000000..5b6f21b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_address_range< address_v4 >::basic_address_range (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an empty range. +

+
basic_address_range();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload2.html new file mode 100644 index 0000000..f241045 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload2.html @@ -0,0 +1,43 @@ + + + +ip::basic_address_range< address_v4 >::basic_address_range (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an range that represents the given range of addresses. +

+
basic_address_range(
+    const iterator & first,
+    const iterator & last);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload3.html new file mode 100644 index 0000000..c454c80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload3.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::basic_address_range (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_address_range(
+    const basic_address_range & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload4.html new file mode 100644 index 0000000..17734b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/basic_address_range/overload4.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::basic_address_range (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_address_range(
+    basic_address_range && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/begin.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/begin.html new file mode 100644 index 0000000..d994564 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/begin.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an iterator that points to the start of the range. +

+
iterator begin() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/empty.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/empty.html new file mode 100644 index 0000000..8d3a995 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/empty.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::empty + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether the range is empty. +

+
bool empty() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/end.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/end.html new file mode 100644 index 0000000..2a80306 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/end.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an iterator that points to the end of the range. +

+
iterator end() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/find.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/find.html new file mode 100644 index 0000000..204d3cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/find.html @@ -0,0 +1,43 @@ + + + +ip::basic_address_range< address_v4 >::find + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Find an address in the range. +

+
iterator find(
+    const address_v4 & addr) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/iterator.html new file mode 100644 index 0000000..4423ead --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/iterator.html @@ -0,0 +1,297 @@ + + + +ip::basic_address_range< address_v4 >::iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of an iterator that points into the range. +

+
typedef basic_address_iterator< address_v4 > iterator;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ Distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ Denotes that the iterator satisfies the input iterator requirements. +

+
+

+ pointer +

+ 		+

+ The type of a pointer to an element pointed to by the iterator. +

+
+

+ reference +

+ 		+

+ The type of a reference to an element pointed to by the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the elements pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_iterator +

+ 		+

+ Construct an iterator that points to the specified address. +
—
Copy constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference the iterator. +

+
+

+ operator++ +

+ 		+

+ Pre-increment operator.
—
Post-increment operator. +

+
+

+ operator-- +

+ 		+

+ Pre-decrement operator.
—
Post-decrement operator. +

+
+

+ operator-> +

+ 		+

+ Dereference the iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ In addition to satisfying the input iterator requirements, this iterator + also supports decrement. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v4_range.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_.html new file mode 100644 index 0000000..c9d847f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_address_range< address_v4 >::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment operator. +

+
basic_address_range & operator=(
+    const basic_address_range & other);
+  » more...
+
+

+ Move assignment operator. +

+
basic_address_range & operator=(
+    basic_address_range && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_/overload1.html new file mode 100644 index 0000000..2b29712 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_address_range & operator=(
+    const basic_address_range & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_/overload2.html new file mode 100644 index 0000000..130b013 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
basic_address_range & operator=(
+    basic_address_range && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/size.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/size.html new file mode 100644 index 0000000..ba1d159 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v4__gt_/size.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v4 >::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Return the size of the range. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_.html new file mode 100644 index 0000000..6765da7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_.html @@ -0,0 +1,199 @@ + + + +ip::basic_address_range< address_v6 > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Represents a range of IPv6 addresses. +

+
template<>
+class basic_address_range< address_v6 >
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ iterator +

+ 		+

+ The type of an iterator that points into the range. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_range +

+ 		+

+ Construct an empty range.
—
Construct an range that + represents the given range of addresses.
—
Copy constructor. +
—
Move constructor. +

+
+

+ begin +

+ 		+

+ Obtain an iterator that points to the start of the range. +

+
+

+ empty +

+ 		+

+ Determine whether the range is empty. +

+
+

+ end +

+ 		+

+ Obtain an iterator that points to the end of the range. +

+
+

+ find +

+ 		+

+ Find an address in the range. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6_range.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range.html new file mode 100644 index 0000000..58893d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range.html @@ -0,0 +1,65 @@ + + + +ip::basic_address_range< address_v6 >::basic_address_range + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct an empty range. +

+
basic_address_range();
+  » more...
+
+

+ Construct an range that represents the given range of addresses. +

+
explicit basic_address_range(
+    const iterator & first,
+    const iterator & last);
+  » more...
+
+

+ Copy constructor. +

+
basic_address_range(
+    const basic_address_range & other);
+  » more...
+
+

+ Move constructor. +

+
basic_address_range(
+    basic_address_range && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload1.html new file mode 100644 index 0000000..2e6f01d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_address_range< address_v6 >::basic_address_range (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an empty range. +

+
basic_address_range();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload2.html new file mode 100644 index 0000000..26e7399 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload2.html @@ -0,0 +1,43 @@ + + + +ip::basic_address_range< address_v6 >::basic_address_range (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an range that represents the given range of addresses. +

+
basic_address_range(
+    const iterator & first,
+    const iterator & last);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload3.html new file mode 100644 index 0000000..d9670fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload3.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v6 >::basic_address_range (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_address_range(
+    const basic_address_range & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload4.html new file mode 100644 index 0000000..74ba436 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/basic_address_range/overload4.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v6 >::basic_address_range (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_address_range(
+    basic_address_range && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/begin.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/begin.html new file mode 100644 index 0000000..3b5a1ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/begin.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v6 >::begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an iterator that points to the start of the range. +

+
iterator begin() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/empty.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/empty.html new file mode 100644 index 0000000..58074ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/empty.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v6 >::empty + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether the range is empty. +

+
bool empty() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/end.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/end.html new file mode 100644 index 0000000..2ce908b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/end.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v6 >::end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an iterator that points to the end of the range. +

+
iterator end() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/find.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/find.html new file mode 100644 index 0000000..9cbb695 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/find.html @@ -0,0 +1,43 @@ + + + +ip::basic_address_range< address_v6 >::find + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Find an address in the range. +

+
iterator find(
+    const address_v6 & addr) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/iterator.html new file mode 100644 index 0000000..7b28427 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/iterator.html @@ -0,0 +1,297 @@ + + + +ip::basic_address_range< address_v6 >::iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of an iterator that points into the range. +

+
typedef basic_address_iterator< address_v6 > iterator;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ Distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ Denotes that the iterator satisfies the input iterator requirements. +

+
+

+ pointer +

+ 		+

+ The type of a pointer to an element pointed to by the iterator. +

+
+

+ reference +

+ 		+

+ The type of a reference to an element pointed to by the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the elements pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_address_iterator +

+ 		+

+ Construct an iterator that points to the specified address. +
—
Copy constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference the iterator. +

+
+

+ operator++ +

+ 		+

+ Pre-increment operator.
—
Post-increment operator. +

+
+

+ operator-- +

+ 		+

+ Pre-decrement operator.
—
Post-decrement operator. +

+
+

+ operator-> +

+ 		+

+ Dereference the iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two addresses for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two addresses for equality. +

+
+

+ In addition to satisfying the input iterator requirements, this iterator + also supports decrement. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/address_v6_range.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_.html new file mode 100644 index 0000000..2a783e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_address_range< address_v6 >::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment operator. +

+
basic_address_range & operator=(
+    const basic_address_range & other);
+  » more...
+
+

+ Move assignment operator. +

+
basic_address_range & operator=(
+    basic_address_range && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_/overload1.html new file mode 100644 index 0000000..a11a53b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v6 >::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_address_range & operator=(
+    const basic_address_range & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_/overload2.html new file mode 100644 index 0000000..5357eeb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_address_range_lt__address_v6__gt_/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_address_range< address_v6 >::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
basic_address_range & operator=(
+    basic_address_range && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint.html new file mode 100644 index 0000000..846bf7f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint.html @@ -0,0 +1,396 @@ + + + +ip::basic_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Describes an endpoint for a version-independent IP socket. +

+
template<
+    typename InternetProtocol>
+class basic_endpoint
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on the + underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address +

+ 		+

+ Get the IP address associated with the endpoint.
—
+ Set the IP address associated with the endpoint. +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ 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.
—
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from another + endpoint. +

+
+

+ 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. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The ip::basic_endpoint + class template describes an endpoint that may be associated with a particular + socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address.html new file mode 100644 index 0000000..79132d0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address.html @@ -0,0 +1,50 @@ + + + +ip::basic_endpoint::address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + IP address associated with the endpoint. +

+
asio::ip::address address() const;
+  » more...
+
+

+ Set the IP address associated with the endpoint. +

+
void address(
+    const asio::ip::address & addr);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address/overload1.html new file mode 100644 index 0000000..9be2aab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_endpoint::address (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the IP address associated with the endpoint. +

+
asio::ip::address address() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address/overload2.html new file mode 100644 index 0000000..ffbc98a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/address/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::address (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the IP address associated with the endpoint. +

+
void address(
+    const asio::ip::address & addr);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint.html new file mode 100644 index 0000000..c2b3285 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint.html @@ -0,0 +1,77 @@ + + + +ip::basic_endpoint::basic_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
basic_endpoint();
+  » more...
+
+

+ 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. +

+
basic_endpoint(
+    const InternetProtocol & internet_protocol,
+    port_type port_num);
+  » more...
+
+

+ 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. +

+
basic_endpoint(
+    const asio::ip::address & addr,
+    port_type port_num);
+  » more...
+
+

+ Copy constructor. +

+
basic_endpoint(
+    const basic_endpoint & other);
+  » more...
+
+

+ Move constructor. +

+
basic_endpoint(
+    basic_endpoint && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload1.html new file mode 100644 index 0000000..0085940 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_endpoint::basic_endpoint (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
basic_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload2.html new file mode 100644 index 0000000..0b2a256 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload2.html @@ -0,0 +1,59 @@ + + + +ip::basic_endpoint::basic_endpoint (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
basic_endpoint(
+    const InternetProtocol & internet_protocol,
+    port_type port_num);
+
+
+ + Examples +
+

+ To initialise an IPv4 TCP endpoint for port 1234, use: +

+
asio::ip::tcp::endpoint ep(asio::ip::tcp::v4(), 1234);
+
+

+ To specify an IPv6 UDP endpoint for port 9876, use: +

+
asio::ip::udp::endpoint ep(asio::ip::udp::v6(), 9876);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload3.html new file mode 100644 index 0000000..b89ed1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload3.html @@ -0,0 +1,45 @@ + + + +ip::basic_endpoint::basic_endpoint (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
basic_endpoint(
+    const asio::ip::address & addr,
+    port_type port_num);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload4.html new file mode 100644 index 0000000..31ab129 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload4.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::basic_endpoint (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_endpoint(
+    const basic_endpoint & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload5.html new file mode 100644 index 0000000..d8c6a22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/basic_endpoint/overload5.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::basic_endpoint (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_endpoint(
+    basic_endpoint && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/capacity.html new file mode 100644 index 0000000..f02e4d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/capacity.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the capacity of the endpoint in the native type. +

+
std::size_t capacity() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data.html new file mode 100644 index 0000000..c328c1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data.html @@ -0,0 +1,46 @@ + + + +ip::basic_endpoint::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the underlying + endpoint in the native type. +

+
data_type * data();
+  » more...
+
+const data_type * data() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data/overload1.html new file mode 100644 index 0000000..3a9b0a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_endpoint::data (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying endpoint in the native type. +

+
data_type * data();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data/overload2.html new file mode 100644 index 0000000..2a3a350 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data/overload2.html @@ -0,0 +1,41 @@ + + + +ip::basic_endpoint::data (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying endpoint in the native type. +

+
const data_type * data() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data_type.html new file mode 100644 index 0000000..a5918a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/data_type.html @@ -0,0 +1,53 @@ + + + +ip::basic_endpoint::data_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the endpoint structure. This type is dependent on the underlying + implementation of the socket layer. +

+
typedef implementation_defined data_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_.html new file mode 100644 index 0000000..31dcae2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_endpoint::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + from another endpoint. +

+
basic_endpoint & operator=(
+    const basic_endpoint & other);
+  » more...
+
+

+ Move-assign from another endpoint. +

+
basic_endpoint & operator=(
+    basic_endpoint && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_/overload1.html new file mode 100644 index 0000000..2d3b464 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another endpoint. +

+
basic_endpoint & operator=(
+    const basic_endpoint & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_/overload2.html new file mode 100644 index 0000000..bf60e1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another endpoint. +

+
basic_endpoint & operator=(
+    basic_endpoint && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq__eq_.html new file mode 100644 index 0000000..0941f99 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_endpoint::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two endpoints for equality. +

+
bool operator==(
+    const basic_endpoint< InternetProtocol > & e1,
+    const basic_endpoint< InternetProtocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_gt_.html new file mode 100644 index 0000000..de629fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_gt_.html @@ -0,0 +1,54 @@ + + + +ip::basic_endpoint::operator> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator>(
+    const basic_endpoint< InternetProtocol > & e1,
+    const basic_endpoint< InternetProtocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_gt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_gt__eq_.html new file mode 100644 index 0000000..4b7cd10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_gt__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_endpoint::operator>= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator>=(
+    const basic_endpoint< InternetProtocol > & e1,
+    const basic_endpoint< InternetProtocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt_.html new file mode 100644 index 0000000..0f311b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt_.html @@ -0,0 +1,54 @@ + + + +ip::basic_endpoint::operator< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator<(
+    const basic_endpoint< InternetProtocol > & e1,
+    const basic_endpoint< InternetProtocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt__eq_.html new file mode 100644 index 0000000..edabb94 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_endpoint::operator<= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator<=(
+    const basic_endpoint< InternetProtocol > & e1,
+    const basic_endpoint< InternetProtocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt__lt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt__lt_.html new file mode 100644 index 0000000..736ad62 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_lt__lt_.html @@ -0,0 +1,76 @@ + + + +ip::basic_endpoint::operator<< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Output + an endpoint as a string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename InternetProtocol>
+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. +

+
+ + Parameters +
+
+

+
+
os
+

+ The output stream to which the string will be written. +

+
endpoint
+

+ The endpoint to be written. +

+
+
+
+ + Return + Value +
+

+ The output stream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_not__eq_.html new file mode 100644 index 0000000..cfc757e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_endpoint::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two endpoints for inequality. +

+
bool operator!=(
+    const basic_endpoint< InternetProtocol > & e1,
+    const basic_endpoint< InternetProtocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port.html new file mode 100644 index 0000000..3084b2d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port.html @@ -0,0 +1,52 @@ + + + +ip::basic_endpoint::port + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the port + associated with the endpoint. The port number is always in the host's byte + order. +

+
port_type port() const;
+  » more...
+
+

+ Set the port associated with the endpoint. The port number is always in + the host's byte order. +

+
void port(
+    port_type port_num);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port/overload1.html new file mode 100644 index 0000000..f519c14 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::port (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the port associated with the endpoint. The port number is always + in the host's byte order. +

+
port_type port() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port/overload2.html new file mode 100644 index 0000000..38e644f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/port/overload2.html @@ -0,0 +1,43 @@ + + + +ip::basic_endpoint::port (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the port associated with the endpoint. The port number is always + in the host's byte order. +

+
void port(
+    port_type port_num);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/protocol.html new file mode 100644 index 0000000..7792b8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/protocol.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol associated with the endpoint. +

+
protocol_type protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/protocol_type.html new file mode 100644 index 0000000..3f1c148 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/protocol_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_endpoint::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type associated with the endpoint. +

+
typedef InternetProtocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/resize.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/resize.html new file mode 100644 index 0000000..b8d1dbb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/resize.html @@ -0,0 +1,43 @@ + + + +ip::basic_endpoint::resize + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set the + underlying size of the endpoint in the native type. +

+
void resize(
+    std::size_t new_size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/size.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/size.html new file mode 100644 index 0000000..3180f4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint/size.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the underlying + size of the endpoint in the native type. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint_lt__InternetProtocol__gt___gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint_lt__InternetProtocol__gt___gt_.html new file mode 100644 index 0000000..a3114d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint_lt__InternetProtocol__gt___gt_.html @@ -0,0 +1,85 @@ + + + +ip::basic_endpoint< InternetProtocol > > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename InternetProtocol>
+struct hash< asio::ip::basic_endpoint< InternetProtocol > >
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint_lt__InternetProtocol__gt___gt_/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint_lt__InternetProtocol__gt___gt_/operator_lp__rp_.html new file mode 100644 index 0000000..cb9c5d0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_endpoint_lt__InternetProtocol__gt___gt_/operator_lp__rp_.html @@ -0,0 +1,42 @@ + + + +ip::basic_endpoint< InternetProtocol > >::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::size_t operator()(
+    const asio::ip::basic_endpoint< InternetProtocol > & ep) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver.html new file mode 100644 index 0000000..15d9102 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver.html @@ -0,0 +1,396 @@ + + + +ip::basic_resolver + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides endpoint resolution functionality. +

+
template<
+    typename InternetProtocol,
+    typename Executor>
+class basic_resolver :
+  public ip::resolver_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the resolver type to another executor. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ results_type +

+ 		+

+ The results type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ 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. +

+
+

+ basic_resolver [constructor] +

+ 		+

+ Construct with executor.
—
Construct with execution + context.
—
Move-construct a basic_resolver from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the resolver. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_resolver from another. +

+
+

+ resolve +

+ 		+

+ Perform forward resolution of a query to a list of entries.
+ —
Perform reverse resolution of an endpoint to a list of entries. +

+
+

+ ~basic_resolver [destructor] +

+ 		+

+ Destroys the resolver. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a port + number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+

+ The ip::basic_resolver + class template provides the ability to resolve a query to a list of endpoints. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/_basic_resolver.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/_basic_resolver.html new file mode 100644 index 0000000..86de0d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/_basic_resolver.html @@ -0,0 +1,46 @@ + + + +ip::basic_resolver::~basic_resolver + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destroys + the resolver. +

+
~basic_resolver();
+
+

+ This function destroys the resolver, cancelling any outstanding asynchronous + wait operations associated with the resolver as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/address_configured.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/address_configured.html new file mode 100644 index 0000000..7b705ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/address_configured.html @@ -0,0 +1,47 @@ + + + +ip::basic_resolver::address_configured + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_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. +

+
static const flags address_configured = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/all_matching.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/all_matching.html new file mode 100644 index 0000000..821ee2e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/all_matching.html @@ -0,0 +1,45 @@ + + + +ip::basic_resolver::all_matching + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +If + used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
static const flags all_matching = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve.html new file mode 100644 index 0000000..9939102 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve.html @@ -0,0 +1,86 @@ + + + +ip::basic_resolver::async_resolve + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + perform forward resolution of a query to a list of entries. +

+
template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    string_view host,
+    string_view service,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+

+ Asynchronously perform reverse resolution of an endpoint to a list of entries. +

+
template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    const endpoint_type & e,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload1.html new file mode 100644 index 0000000..ca6bd7d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload1.html @@ -0,0 +1,124 @@ + + + +ip::basic_resolver::async_resolve (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously perform forward resolution of a query to a list of entries. +

+
template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    string_view host,
+    string_view service,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the resolve completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  resolver::results_type results // Resolved endpoints as a range.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+

+ A successful resolve operation is guaranteed to pass a non-empty range + to the handler. +

+
+ + Completion + Signature +
+
void(asio::error_code, results_type)
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload2.html new file mode 100644 index 0000000..c450429 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload2.html @@ -0,0 +1,133 @@ + + + +ip::basic_resolver::async_resolve (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously perform forward resolution of a query to a list of entries. +

+
template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
resolve_flags
+

+ A set of flags that determine how name resolution should be performed. + The default flags are suitable for communication with remote hosts. + See the ip::resolver_base documentation + for the set of available flags. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the resolve completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  resolver::results_type results // Resolved endpoints as a range.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+

+ A successful resolve operation is guaranteed to pass a non-empty range + to the handler. +

+
+ + Completion + Signature +
+
void(asio::error_code, results_type)
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload3.html new file mode 100644 index 0000000..c551e29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload3.html @@ -0,0 +1,131 @@ + + + +ip::basic_resolver::async_resolve (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously perform forward resolution of a query to a list of entries. +

+
template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the resolve completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  resolver::results_type results // Resolved endpoints as a range.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+

+ A successful resolve operation is guaranteed to pass a non-empty range + to the handler. +

+
+ + Completion + Signature +
+
void(asio::error_code, results_type)
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload4.html new file mode 100644 index 0000000..481876f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload4.html @@ -0,0 +1,139 @@ + + + +ip::basic_resolver::async_resolve (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously perform forward resolution of a query to a list of entries. +

+
template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. + See the ip::resolver_base documentation + for the set of available flags. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the resolve completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  resolver::results_type results // Resolved endpoints as a range.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+

+ A successful resolve operation is guaranteed to pass a non-empty range + to the handler. +

+
+ + Completion + Signature +
+
void(asio::error_code, results_type)
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload5.html new file mode 100644 index 0000000..b8d6e52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/async_resolve/overload5.html @@ -0,0 +1,97 @@ + + + +ip::basic_resolver::async_resolve (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asynchronously perform reverse resolution of an endpoint to a list of + entries. +

+
template<
+    typename ResolveToken = default_completion_token_t<executor_type>>
+DEDUCED async_resolve(
+    const endpoint_type & e,
+    ResolveToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously resolve an endpoint into a list + of endpoint entries. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
e
+

+ An endpoint object that determines what endpoints will be returned. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the resolve completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  resolver::results_type results // Resolved endpoints as a range.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+

+ A successful resolve operation is guaranteed to pass a non-empty range + to the handler. +

+
+ + Completion + Signature +
+
void(asio::error_code, results_type)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver.html new file mode 100644 index 0000000..b9f034f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver.html @@ -0,0 +1,68 @@ + + + +ip::basic_resolver::basic_resolver + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + with executor. +

+
explicit basic_resolver(
+    const executor_type & ex);
+  » more...
+
+

+ Construct with execution context. +

+
template<
+    typename ExecutionContext>
+explicit basic_resolver(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a ip::basic_resolver from another. +

+
basic_resolver(
+    basic_resolver && other);
+  » more...
+
+template<
+    typename Executor1>
+basic_resolver(
+    basic_resolver< InternetProtocol, Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload1.html new file mode 100644 index 0000000..4f5a42c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload1.html @@ -0,0 +1,59 @@ + + + +ip::basic_resolver::basic_resolver (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with executor. +

+
basic_resolver(
+    const executor_type & ex);
+
+

+ This constructor creates a ip::basic_resolver. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the resolver will use, by default, to dispatch + handlers for any asynchronous operations performed on the resolver. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload2.html new file mode 100644 index 0000000..bcce71d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload2.html @@ -0,0 +1,63 @@ + + + +ip::basic_resolver::basic_resolver (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with execution context. +

+
template<
+    typename ExecutionContext>
+basic_resolver(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a ip::basic_resolver. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the resolver + will use, by default, to dispatch handlers for any asynchronous + operations performed on the resolver. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload3.html new file mode 100644 index 0000000..5c130d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload3.html @@ -0,0 +1,68 @@ + + + +ip::basic_resolver::basic_resolver (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a ip::basic_resolver from another. +

+
basic_resolver(
+    basic_resolver && other);
+
+

+ This constructor moves a resolver from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other ip::basic_resolver object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_resolver(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload4.html new file mode 100644 index 0000000..e20ce1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/basic_resolver/overload4.html @@ -0,0 +1,71 @@ + + + +ip::basic_resolver::basic_resolver (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a ip::basic_resolver from another. +

+
template<
+    typename Executor1>
+basic_resolver(
+    basic_resolver< InternetProtocol, Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value >  = 0);
+
+

+ This constructor moves a resolver from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other ip::basic_resolver object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_resolver(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/cancel.html new file mode 100644 index 0000000..5b46ea7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/cancel.html @@ -0,0 +1,47 @@ + + + +ip::basic_resolver::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + any asynchronous operations that are waiting on the resolver. +

+
void cancel();
+
+

+ 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 asio::error::operation_aborted error code. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/canonical_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/canonical_name.html new file mode 100644 index 0000000..1d2be5c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/canonical_name.html @@ -0,0 +1,45 @@ + + + +ip::basic_resolver::canonical_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +Determine + the canonical name of the host specified in the query. +

+
static const flags canonical_name = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/endpoint_type.html new file mode 100644 index 0000000..5abcce4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/endpoint_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type. +

+
typedef InternetProtocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/executor_type.html new file mode 100644 index 0000000..d3ed034 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/executor_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/flags.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/flags.html new file mode 100644 index 0000000..9ac3b96 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/flags.html @@ -0,0 +1,55 @@ + + + +ip::basic_resolver::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +A bitmask + type (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/get_executor.html new file mode 100644 index 0000000..5b2c641 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/get_executor.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/numeric_host.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/numeric_host.html new file mode 100644 index 0000000..5bb3825 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/numeric_host.html @@ -0,0 +1,46 @@ + + + +ip::basic_resolver::numeric_host + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/numeric_service.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/numeric_service.html new file mode 100644 index 0000000..5d52e44 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/numeric_service.html @@ -0,0 +1,46 @@ + + + +ip::basic_resolver::numeric_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_.html new file mode 100644 index 0000000..f0e9110 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_resolver::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a ip::basic_resolver + from another. +

+
basic_resolver & operator=(
+    basic_resolver && other);
+  » more...
+
+template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_resolver & > operator=(
+    basic_resolver< InternetProtocol, Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_/overload1.html new file mode 100644 index 0000000..4907a67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_/overload1.html @@ -0,0 +1,70 @@ + + + +ip::basic_resolver::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a ip::basic_resolver from another. +

+
basic_resolver & operator=(
+    basic_resolver && other);
+
+

+ This assignment operator moves a resolver from one object to another. + Cancels any outstanding asynchronous operations associated with the target + object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other ip::basic_resolver object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_resolver(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_/overload2.html new file mode 100644 index 0000000..71429f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +ip::basic_resolver::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a ip::basic_resolver from another. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_resolver & > operator=(
+    basic_resolver< InternetProtocol, Executor1 > && other);
+
+

+ This assignment operator moves a resolver from one object to another. + Cancels any outstanding asynchronous operations associated with the target + object. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other ip::basic_resolver object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_resolver(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/passive.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/passive.html new file mode 100644 index 0000000..f070cc4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/passive.html @@ -0,0 +1,45 @@ + + + +ip::basic_resolver::passive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +Indicate + that returned endpoint is intended for use as a locally bound socket endpoint. +

+
static const flags passive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/protocol_type.html new file mode 100644 index 0000000..e5a9e04 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/protocol_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type. +

+
typedef InternetProtocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve.html new file mode 100644 index 0000000..1f4f2b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve.html @@ -0,0 +1,104 @@ + + + +ip::basic_resolver::resolve + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + forward resolution of a query to a list of entries. +

+
results_type resolve(
+    string_view host,
+    string_view service);
+  » more...
+
+results_type resolve(
+    string_view host,
+    string_view service,
+    asio::error_code & ec);
+  » more...
+
+results_type resolve(
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags);
+  » more...
+
+results_type resolve(
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    asio::error_code & ec);
+  » more...
+
+results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service);
+  » more...
+
+results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    asio::error_code & ec);
+  » more...
+
+results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags);
+  » more...
+
+results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    asio::error_code & ec);
+  » more...
+
+

+ Perform reverse resolution of an endpoint to a list of entries. +

+
results_type resolve(
+    const endpoint_type & e);
+  » more...
+
+results_type resolve(
+    const endpoint_type & e,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload1.html new file mode 100644 index 0000000..7c77802 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload1.html @@ -0,0 +1,110 @@ + + + +ip::basic_resolver::resolve (1 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    string_view host,
+    string_view service);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. A successful + call to this function is guaranteed to return a non-empty range. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload10.html new file mode 100644 index 0000000..e91fa43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload10.html @@ -0,0 +1,74 @@ + + + +ip::basic_resolver::resolve (10 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform reverse resolution of an endpoint to a list of entries. +

+
results_type resolve(
+    const endpoint_type & e,
+    asio::error_code & ec);
+
+

+ This function is used to resolve an endpoint into a list of endpoint + entries. +

+
+ + Parameters +
+
+

+
+
e
+

+ An endpoint object that determines what endpoints will be returned. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. An empty range + is returned if an error occurs. A successful call to this function is + guaranteed to return a non-empty range. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload2.html new file mode 100644 index 0000000..f35943a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload2.html @@ -0,0 +1,103 @@ + + + +ip::basic_resolver::resolve (2 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    string_view host,
+    string_view service,
+    asio::error_code & ec);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. An empty range + is returned if an error occurs. A successful call to this function is + guaranteed to return a non-empty range. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload3.html new file mode 100644 index 0000000..d291866 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload3.html @@ -0,0 +1,118 @@ + + + +ip::basic_resolver::resolve (3 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
resolve_flags
+

+ A set of flags that determine how name resolution should be performed. + The default flags are suitable for communication with remote hosts. + See the ip::resolver_base documentation + for the set of available flags. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. A successful + call to this function is guaranteed to return a non-empty range. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload4.html new file mode 100644 index 0000000..7bb3eff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload4.html @@ -0,0 +1,111 @@ + + + +ip::basic_resolver::resolve (4 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    asio::error_code & ec);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
resolve_flags
+

+ A set of flags that determine how name resolution should be performed. + The default flags are suitable for communication with remote hosts. + See the ip::resolver_base documentation + for the set of available flags. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. An empty range + is returned if an error occurs. A successful call to this function is + guaranteed to return a non-empty range. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload5.html new file mode 100644 index 0000000..f0c9c39 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload5.html @@ -0,0 +1,116 @@ + + + +ip::basic_resolver::resolve (5 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. A successful + call to this function is guaranteed to return a non-empty range. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload6.html new file mode 100644 index 0000000..aeac17b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload6.html @@ -0,0 +1,109 @@ + + + +ip::basic_resolver::resolve (6 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    asio::error_code & ec);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. An empty range + is returned if an error occurs. A successful call to this function is + guaranteed to return a non-empty range. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload7.html new file mode 100644 index 0000000..2dd03f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload7.html @@ -0,0 +1,124 @@ + + + +ip::basic_resolver::resolve (7 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. + See the ip::resolver_base documentation + for the set of available flags. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. A successful + call to this function is guaranteed to return a non-empty range. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload8.html new file mode 100644 index 0000000..c85e302 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload8.html @@ -0,0 +1,117 @@ + + + +ip::basic_resolver::resolve (8 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform forward resolution of a query to a list of entries. +

+
results_type resolve(
+    const protocol_type & protocol,
+    string_view host,
+    string_view service,
+    resolver_base::flags resolve_flags,
+    asio::error_code & ec);
+
+

+ This function is used to resolve host and service names into a list of + endpoint entries. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. + See the ip::resolver_base documentation + for the set of available flags. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. An empty range + is returned if an error occurs. A successful call to this function is + guaranteed to return a non-empty range. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload9.html new file mode 100644 index 0000000..6551996 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/resolve/overload9.html @@ -0,0 +1,81 @@ + + + +ip::basic_resolver::resolve (9 of 10 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform reverse resolution of an endpoint to a list of entries. +

+
results_type resolve(
+    const endpoint_type & e);
+
+

+ This function is used to resolve an endpoint into a list of endpoint + entries. +

+
+ + Parameters +
+
+

+
+
e
+

+ An endpoint object that determines what endpoints will be returned. +

+
+
+
+ + Return + Value +
+

+ A range object representing the list of endpoint entries. A successful + call to this function is guaranteed to return a non-empty range. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/results_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/results_type.html new file mode 100644 index 0000000..d7c6d85 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/results_type.html @@ -0,0 +1,409 @@ + + + +ip::basic_resolver::results_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + results type. +

+
typedef basic_resolver_results< InternetProtocol > results_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_iterator +

+ 		+

+ The type of an iterator into the range. +

+
+

+ const_reference +

+ 		+

+ The type of a const reference to a value in the range. +

+
+

+ difference_type +

+ 		+

+ Type used to represent the distance between two iterators in + the range. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type associated with the results. +

+
+

+ iterator +

+ 		+

+ The type of an iterator into the range. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the results. +

+
+

+ reference +

+ 		+

+ The type of a non-const reference to a value in the range. +

+
+

+ size_type +

+ 		+

+ Type used to represent a count of the elements in the range. +

+
+

+ value_type +

+ 		+

+ The type of a value in the results range. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_results [constructor] +

+ 		+

+ Default constructor creates an empty range.
—
Copy + constructor.
—
Move constructor. +

+
+

+ begin +

+ 		+

+ Obtain a begin iterator for the results range. +

+
+

+ cbegin +

+ 		+

+ Obtain a begin iterator for the results range. +

+
+

+ cend +

+ 		+

+ Obtain an end iterator for the results range. +

+
+

+ empty +

+ 		+

+ Determine whether the results range is empty. +

+
+

+ end +

+ 		+

+ Obtain an end iterator for the results range. +

+
+

+ max_size +

+ 		+

+ Get the maximum number of entries permitted in a results range. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move-assignment operator. +

+
+

+ size +

+ 		+

+ Get the number of entries in the results range. +

+
+

+ swap +

+ 		+

+ Swap the results range with another. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Test two iterators for inequality. +

+
+

+ operator== +

+ 		+

+ Test two iterators for equality. +

+
+

+ The ip::basic_resolver_results class template + is used to define a range over the results returned by a resolver. +

+

+ The iterator's value_type, obtained when a results iterator is dereferenced, + is: +

+
const basic_resolver_entry<InternetProtocol>
+
+
+ + Remarks +
+

+ For backward compatibility, ip::basic_resolver_results is derived + from ip::basic_resolver_iterator. This + derivation is deprecated. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/v4_mapped.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/v4_mapped.html new file mode 100644 index 0000000..fa6c7fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver/v4_mapped.html @@ -0,0 +1,46 @@ + + + +ip::basic_resolver::v4_mapped + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver__rebind_executor.html new file mode 100644 index 0000000..266b031 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver__rebind_executor.html @@ -0,0 +1,89 @@ + + + +ip::basic_resolver::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the resolver type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The resolver type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver__rebind_executor/other.html new file mode 100644 index 0000000..e939060 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver__rebind_executor/other.html @@ -0,0 +1,392 @@ + + + +ip::basic_resolver::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + resolver type when rebound to the specified executor. +

+
typedef basic_resolver< InternetProtocol, Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the resolver type to another executor. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ results_type +

+ 		+

+ The results type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ 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. +

+
+

+ basic_resolver [constructor] +

+ 		+

+ Construct with executor.
—
Construct with execution + context.
—
Move-construct a basic_resolver from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the resolver. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_resolver from another. +

+
+

+ resolve +

+ 		+

+ Perform forward resolution of a query to a list of entries. +
—
Perform reverse resolution of an endpoint to a + list of entries. +

+
+

+ ~basic_resolver [destructor] +

+ 		+

+ Destroys the resolver. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a + port number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+

+ The ip::basic_resolver + class template provides the ability to resolve a query to a list of endpoints. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry.html new file mode 100644 index 0000000..f12eebf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry.html @@ -0,0 +1,203 @@ + + + +ip::basic_resolver_entry + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An entry produced by a resolver. +

+
template<
+    typename InternetProtocol>
+class basic_resolver_entry
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type associated with the endpoint entry. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint entry. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_entry [constructor] +

+ 		+

+ Default constructor.
—
Construct with specified endpoint, + host name and service name. +

+
+

+ endpoint +

+ 		+

+ Get the endpoint associated with the entry. +

+
+

+ host_name +

+ 		+

+ Get the host name associated with the entry. +

+
+

+ operator endpoint_type +

+ 		+

+ Convert to the endpoint associated with the entry. +

+
+

+ service_name +

+ 		+

+ Get the service name associated with the entry. +

+
+

+ The ip::basic_resolver_entry + class template describes an entry as returned by a resolver. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_entry.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry.html new file mode 100644 index 0000000..b690855 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_entry::basic_resolver_entry + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
basic_resolver_entry();
+  » more...
+
+

+ Construct with specified endpoint, host name and service name. +

+
basic_resolver_entry(
+    const endpoint_type & ep,
+    string_view host,
+    string_view service);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry/overload1.html new file mode 100644 index 0000000..cc48f8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_resolver_entry::basic_resolver_entry (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
basic_resolver_entry();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry/overload2.html new file mode 100644 index 0000000..ddce3d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/basic_resolver_entry/overload2.html @@ -0,0 +1,44 @@ + + + +ip::basic_resolver_entry::basic_resolver_entry (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with specified endpoint, host name and service name. +

+
basic_resolver_entry(
+    const endpoint_type & ep,
+    string_view host,
+    string_view service);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/endpoint.html new file mode 100644 index 0000000..51ea79b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/endpoint.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_entry::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the endpoint associated with the entry. +

+
endpoint_type endpoint() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/endpoint_type.html new file mode 100644 index 0000000..d805cf2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/endpoint_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_entry::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type associated with the endpoint entry. +

+
typedef InternetProtocol::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_entry.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name.html new file mode 100644 index 0000000..b53d861 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name.html @@ -0,0 +1,49 @@ + + + +ip::basic_resolver_entry::host_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the host name associated with the entry. +

+
std::string host_name() const;
+  » more...
+
+template<
+    class Allocator>
+std::basic_string< char, std::char_traits< char >, Allocator > host_name(
+    const Allocator & alloc = Allocator()) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name/overload1.html new file mode 100644 index 0000000..e290154 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_resolver_entry::host_name (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the host name associated with the entry. +

+
std::string host_name() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name/overload2.html new file mode 100644 index 0000000..f9043e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/host_name/overload2.html @@ -0,0 +1,44 @@ + + + +ip::basic_resolver_entry::host_name (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the host name associated with the entry. +

+
template<
+    class Allocator>
+std::basic_string< char, std::char_traits< char >, Allocator > host_name(
+    const Allocator & alloc = Allocator()) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/operator_endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/operator_endpoint_type.html new file mode 100644 index 0000000..40e5946 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/operator_endpoint_type.html @@ -0,0 +1,43 @@ + + + +ip::basic_resolver_entry::operator endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Convert to the endpoint associated + with the entry. +

+
operator endpoint_type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/protocol_type.html new file mode 100644 index 0000000..821e979 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/protocol_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_entry::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type associated with the endpoint entry. +

+
typedef InternetProtocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_entry.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name.html new file mode 100644 index 0000000..d5ef8dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name.html @@ -0,0 +1,49 @@ + + + +ip::basic_resolver_entry::service_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the service name associated with the entry. +

+
std::string service_name() const;
+  » more...
+
+template<
+    class Allocator>
+std::basic_string< char, std::char_traits< char >, Allocator > service_name(
+    const Allocator & alloc = Allocator()) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name/overload1.html new file mode 100644 index 0000000..0cfc7e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_resolver_entry::service_name (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the service name associated with the entry. +

+
std::string service_name() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name/overload2.html new file mode 100644 index 0000000..a145913 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_entry/service_name/overload2.html @@ -0,0 +1,44 @@ + + + +ip::basic_resolver_entry::service_name (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the service name associated with the entry. +

+
template<
+    class Allocator>
+std::basic_string< char, std::char_traits< char >, Allocator > service_name(
+    const Allocator & alloc = Allocator()) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator.html new file mode 100644 index 0000000..e7b24df --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator.html @@ -0,0 +1,389 @@ + + + +ip::basic_resolver_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An iterator over the entries produced by a resolver. +

+
template<
+    typename InternetProtocol>
+class basic_resolver_iterator
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ The type used for the distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ The iterator category. +

+
+

+ pointer +

+ 		+

+ The type of the result of applying operator->() to the iterator. +

+
+

+ reference +

+ 		+

+ The type of the result of applying operator*() to the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the value pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_iterator [constructor] +

+ 		+

+ Default constructor creates an end iterator.
—
Copy + constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference an iterator. +

+
+

+ operator++ +

+ 		+

+ Increment operator (prefix).
—
Increment operator (postfix). +

+
+

+ operator-> +

+ 		+

+ Dereference an iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move-assignment operator. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ dereference +

+ 		+
+

+ equal +

+ 		+
+

+ increment +

+ 		+
+
+ + Protected + Data Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ index_ +

+ 		+
+

+ values_ +

+ 		+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Test two iterators for inequality. +

+
+

+ operator== +

+ 		+

+ Test two iterators for equality. +

+
+

+ The 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>
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator.html new file mode 100644 index 0000000..164646d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator.html @@ -0,0 +1,57 @@ + + + +ip::basic_resolver_iterator::basic_resolver_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor creates an end iterator. +

+
basic_resolver_iterator();
+  » more...
+
+

+ Copy constructor. +

+
basic_resolver_iterator(
+    const basic_resolver_iterator & other);
+  » more...
+
+

+ Move constructor. +

+
basic_resolver_iterator(
+    basic_resolver_iterator && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload1.html new file mode 100644 index 0000000..18d82e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_resolver_iterator::basic_resolver_iterator (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor creates an end iterator. +

+
basic_resolver_iterator();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload2.html new file mode 100644 index 0000000..fa86896 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_iterator::basic_resolver_iterator (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_resolver_iterator(
+    const basic_resolver_iterator & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload3.html new file mode 100644 index 0000000..b47e730 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/basic_resolver_iterator/overload3.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_iterator::basic_resolver_iterator (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_resolver_iterator(
+    basic_resolver_iterator && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/dereference.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/dereference.html new file mode 100644 index 0000000..b20f1ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/dereference.html @@ -0,0 +1,40 @@ + + + +ip::basic_resolver_iterator::dereference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const basic_resolver_entry< InternetProtocol > & dereference() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/difference_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/difference_type.html new file mode 100644 index 0000000..3faff1d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/difference_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_iterator::difference_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type used for the distance between two iterators. +

+
typedef std::ptrdiff_t difference_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/equal.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/equal.html new file mode 100644 index 0000000..bdaa88f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/equal.html @@ -0,0 +1,41 @@ + + + +ip::basic_resolver_iterator::equal + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
bool equal(
+    const basic_resolver_iterator & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/increment.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/increment.html new file mode 100644 index 0000000..9fa820b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/increment.html @@ -0,0 +1,40 @@ + + + +ip::basic_resolver_iterator::increment + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void increment();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/index_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/index_.html new file mode 100644 index 0000000..abd8ba8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/index_.html @@ -0,0 +1,40 @@ + + + +ip::basic_resolver_iterator::index_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::size_t index_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/iterator_category.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/iterator_category.html new file mode 100644 index 0000000..923cb8c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/iterator_category.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_iterator::iterator_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + iterator category. +

+
typedef std::forward_iterator_tag iterator_category;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_arrow_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_arrow_.html new file mode 100644 index 0000000..d93bfba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_arrow_.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_iterator::operator-> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference + an iterator. +

+
const basic_resolver_entry< InternetProtocol > * operator->() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_.html new file mode 100644 index 0000000..e8e38a4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_resolver_iterator::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment + operator. +

+
basic_resolver_iterator & operator=(
+    const basic_resolver_iterator & other);
+  » more...
+
+

+ Move-assignment operator. +

+
basic_resolver_iterator & operator=(
+    basic_resolver_iterator && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_/overload1.html new file mode 100644 index 0000000..ce5a4fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_iterator::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_resolver_iterator & operator=(
+    const basic_resolver_iterator & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_/overload2.html new file mode 100644 index 0000000..2babf3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_iterator::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assignment operator. +

+
basic_resolver_iterator & operator=(
+    basic_resolver_iterator && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq__eq_.html new file mode 100644 index 0000000..84e0559 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_resolver_iterator::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + two iterators for equality. +

+
bool operator==(
+    const basic_resolver_iterator & a,
+    const basic_resolver_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_not__eq_.html new file mode 100644 index 0000000..59610bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_resolver_iterator::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + two iterators for inequality. +

+
bool operator!=(
+    const basic_resolver_iterator & a,
+    const basic_resolver_iterator & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_.html new file mode 100644 index 0000000..bce4723 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_.html @@ -0,0 +1,50 @@ + + + +ip::basic_resolver_iterator::operator++ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Increment + operator (prefix). +

+
basic_resolver_iterator & operator++();
+  » more...
+
+

+ Increment operator (postfix). +

+
basic_resolver_iterator operator++(
+    int );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_/overload1.html new file mode 100644 index 0000000..2b57ae2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_resolver_iterator::operator++ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Increment operator (prefix). +

+
basic_resolver_iterator & operator++();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_/overload2.html new file mode 100644 index 0000000..d6d4fe3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_plus__plus_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_iterator::operator++ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Increment operator (postfix). +

+
basic_resolver_iterator operator++(
+    int );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_star_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_star_.html new file mode 100644 index 0000000..e16368e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/operator_star_.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_iterator::operator* + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Dereference + an iterator. +

+
const basic_resolver_entry< InternetProtocol > & operator*() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/pointer.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/pointer.html new file mode 100644 index 0000000..923d429 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/pointer.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_iterator::pointer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the result of applying operator->() to the iterator. +

+
typedef const basic_resolver_entry< InternetProtocol > * pointer;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/reference.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/reference.html new file mode 100644 index 0000000..0a122e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/reference.html @@ -0,0 +1,201 @@ + + + +ip::basic_resolver_iterator::reference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the result of applying operator*() to the iterator. +

+
typedef const basic_resolver_entry< InternetProtocol > & reference;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type associated with the endpoint entry. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint entry. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_entry [constructor] +

+ 		+

+ Default constructor.
—
Construct with specified endpoint, + host name and service name. +

+
+

+ endpoint +

+ 		+

+ Get the endpoint associated with the entry. +

+
+

+ host_name +

+ 		+

+ Get the host name associated with the entry. +

+
+

+ operator endpoint_type +

+ 		+

+ Convert to the endpoint associated with the entry. +

+
+

+ service_name +

+ 		+

+ Get the service name associated with the entry. +

+
+

+ The ip::basic_resolver_entry class template + describes an entry as returned by a resolver. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/value_type.html new file mode 100644 index 0000000..39bf0b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/value_type.html @@ -0,0 +1,201 @@ + + + +ip::basic_resolver_iterator::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the value pointed to by the iterator. +

+
typedef basic_resolver_entry< InternetProtocol > value_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type associated with the endpoint entry. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint entry. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_entry [constructor] +

+ 		+

+ Default constructor.
—
Construct with specified endpoint, + host name and service name. +

+
+

+ endpoint +

+ 		+

+ Get the endpoint associated with the entry. +

+
+

+ host_name +

+ 		+

+ Get the host name associated with the entry. +

+
+

+ operator endpoint_type +

+ 		+

+ Convert to the endpoint associated with the entry. +

+
+

+ service_name +

+ 		+

+ Get the service name associated with the entry. +

+
+

+ The ip::basic_resolver_entry class template + describes an entry as returned by a resolver. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/values_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/values_.html new file mode 100644 index 0000000..2140760 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_iterator/values_.html @@ -0,0 +1,40 @@ + + + +ip::basic_resolver_iterator::values_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
values_ptr_type values_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query.html new file mode 100644 index 0000000..2ac295b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query.html @@ -0,0 +1,311 @@ + + + +ip::basic_resolver_query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An query to be passed to a resolver. +

+
template<
+    typename InternetProtocol>
+class basic_resolver_query :
+  public ip::resolver_query_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint query. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_query [constructor] +

+ 		+

+ 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.
—
Construct with specified host name + and service name for a given protocol.
—
Copy construct + a basic_resolver_query from another.
—
Move construct + a basic_resolver_query from another. +

+
+

+ hints +

+ 		+

+ Get the hints associated with the query. +

+
+

+ host_name +

+ 		+

+ Get the host name associated with the query. +

+
+

+ service_name +

+ 		+

+ Get the service name associated with the query. +

+
+
+ + Data Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a port + number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+

+ The ip::basic_resolver_query + class template describes a query that can be passed to a resolver. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/address_configured.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/address_configured.html new file mode 100644 index 0000000..e19e71d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/address_configured.html @@ -0,0 +1,47 @@ + + + +ip::basic_resolver_query::address_configured + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_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. +

+
static const flags address_configured = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/all_matching.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/all_matching.html new file mode 100644 index 0000000..cb9b454 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/all_matching.html @@ -0,0 +1,45 @@ + + + +ip::basic_resolver_query::all_matching + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +If + used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
static const flags all_matching = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query.html new file mode 100644 index 0000000..52ae531 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query.html @@ -0,0 +1,89 @@ + + + +ip::basic_resolver_query::basic_resolver_query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + with specified service name for any protocol. +

+
basic_resolver_query(
+    const std::string & service,
+    resolver_query_base::flags resolve_flags = passive|address_configured);
+  » more...
+
+

+ Construct with specified service name for a given protocol. +

+
basic_resolver_query(
+    const protocol_type & protocol,
+    const std::string & service,
+    resolver_query_base::flags resolve_flags = passive|address_configured);
+  » more...
+
+

+ 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);
+  » more...
+
+

+ Construct with specified host name and service name for a given protocol. +

+
basic_resolver_query(
+    const protocol_type & protocol,
+    const std::string & host,
+    const std::string & service,
+    resolver_query_base::flags resolve_flags = address_configured);
+  » more...
+
+

+ Copy construct a basic_resolver_query + from another. +

+
basic_resolver_query(
+    const basic_resolver_query & other);
+  » more...
+
+

+ Move construct a basic_resolver_query + from another. +

+
basic_resolver_query(
+    basic_resolver_query && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload1.html new file mode 100644 index 0000000..064c4a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload1.html @@ -0,0 +1,76 @@ + + + +ip::basic_resolver_query::basic_resolver_query (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with specified service name for any protocol. +

+
basic_resolver_query(
+    const std::string & service,
+    resolver_query_base::flags resolve_flags = passive|address_configured);
+
+

+ This constructor is typically used to perform name resolution for local + service binding. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload2.html new file mode 100644 index 0000000..227ea21 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload2.html @@ -0,0 +1,82 @@ + + + +ip::basic_resolver_query::basic_resolver_query (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with specified service name for a given protocol. +

+
basic_resolver_query(
+    const protocol_type & protocol,
+    const std::string & service,
+    resolver_query_base::flags resolve_flags = passive|address_configured);
+
+

+ This constructor is typically used to perform name resolution for local + service binding with a specific protocol version. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload3.html new file mode 100644 index 0000000..264063c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload3.html @@ -0,0 +1,94 @@ + + + +ip::basic_resolver_query::basic_resolver_query (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
resolve_flags
+

+ A set of flags that determine how name resolution should be performed. + The default flags are suitable for communication with remote hosts. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload4.html new file mode 100644 index 0000000..18ef103 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload4.html @@ -0,0 +1,100 @@ + + + +ip::basic_resolver_query::basic_resolver_query (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct with specified host name and service name for a given protocol. +

+
basic_resolver_query(
+    const protocol_type & protocol,
+    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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. +

+
+
+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload5.html new file mode 100644 index 0000000..0fb520f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload5.html @@ -0,0 +1,43 @@ + + + +ip::basic_resolver_query::basic_resolver_query (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy construct a basic_resolver_query + from another. +

+
basic_resolver_query(
+    const basic_resolver_query & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload6.html new file mode 100644 index 0000000..7561721 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/basic_resolver_query/overload6.html @@ -0,0 +1,43 @@ + + + +ip::basic_resolver_query::basic_resolver_query (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move construct a basic_resolver_query + from another. +

+
basic_resolver_query(
+    basic_resolver_query && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/canonical_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/canonical_name.html new file mode 100644 index 0000000..7e230d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/canonical_name.html @@ -0,0 +1,45 @@ + + + +ip::basic_resolver_query::canonical_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +Determine + the canonical name of the host specified in the query. +

+
static const flags canonical_name = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/flags.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/flags.html new file mode 100644 index 0000000..23cd0e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/flags.html @@ -0,0 +1,55 @@ + + + +ip::basic_resolver_query::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +A + bitmask type (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/hints.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/hints.html new file mode 100644 index 0000000..d3dbe23 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/hints.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_query::hints + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the hints associated with the query. +

+
const asio::detail::addrinfo_type & hints() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/host_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/host_name.html new file mode 100644 index 0000000..b600ab3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/host_name.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_query::host_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the host name associated with the query. +

+
std::string host_name() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/numeric_host.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/numeric_host.html new file mode 100644 index 0000000..d5528dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/numeric_host.html @@ -0,0 +1,46 @@ + + + +ip::basic_resolver_query::numeric_host + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/numeric_service.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/numeric_service.html new file mode 100644 index 0000000..4c40cae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/numeric_service.html @@ -0,0 +1,46 @@ + + + +ip::basic_resolver_query::numeric_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/passive.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/passive.html new file mode 100644 index 0000000..ee20528 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/passive.html @@ -0,0 +1,45 @@ + + + +ip::basic_resolver_query::passive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +Indicate + that returned endpoint is intended for use as a locally bound socket endpoint. +

+
static const flags passive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/protocol_type.html new file mode 100644 index 0000000..e0e3578 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/protocol_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_query::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type associated with the endpoint query. +

+
typedef InternetProtocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/service_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/service_name.html new file mode 100644 index 0000000..797f2b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/service_name.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_query::service_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the service name associated with the query. +

+
std::string service_name() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/v4_mapped.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/v4_mapped.html new file mode 100644 index 0000000..3a45bbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_query/v4_mapped.html @@ -0,0 +1,46 @@ + + + +ip::basic_resolver_query::v4_mapped + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results.html new file mode 100644 index 0000000..3b51872 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results.html @@ -0,0 +1,413 @@ + + + +ip::basic_resolver_results + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A range of entries produced by a resolver. +

+
template<
+    typename InternetProtocol>
+class basic_resolver_results :
+  ip::basic_resolver_iterator< InternetProtocol >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_iterator +

+ 		+

+ The type of an iterator into the range. +

+
+

+ const_reference +

+ 		+

+ The type of a const reference to a value in the range. +

+
+

+ difference_type +

+ 		+

+ Type used to represent the distance between two iterators in the + range. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type associated with the results. +

+
+

+ iterator +

+ 		+

+ The type of an iterator into the range. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the results. +

+
+

+ reference +

+ 		+

+ The type of a non-const reference to a value in the range. +

+
+

+ size_type +

+ 		+

+ Type used to represent a count of the elements in the range. +

+
+

+ value_type +

+ 		+

+ The type of a value in the results range. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_results [constructor] +

+ 		+

+ Default constructor creates an empty range.
—
Copy + constructor.
—
Move constructor. +

+
+

+ begin +

+ 		+

+ Obtain a begin iterator for the results range. +

+
+

+ cbegin +

+ 		+

+ Obtain a begin iterator for the results range. +

+
+

+ cend +

+ 		+

+ Obtain an end iterator for the results range. +

+
+

+ empty +

+ 		+

+ Determine whether the results range is empty. +

+
+

+ end +

+ 		+

+ Obtain an end iterator for the results range. +

+
+

+ max_size +

+ 		+

+ Get the maximum number of entries permitted in a results range. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move-assignment operator. +

+
+

+ size +

+ 		+

+ Get the number of entries in the results range. +

+
+

+ swap +

+ 		+

+ Swap the results range with another. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Test two iterators for inequality. +

+
+

+ operator== +

+ 		+

+ Test two iterators for equality. +

+
+

+ The ip::basic_resolver_results + class template is used to define a range over the results returned by a resolver. +

+

+ The iterator's value_type, obtained when a results iterator is dereferenced, + is: +

+
const basic_resolver_entry<InternetProtocol>
+
+
+ + Remarks +
+

+ For backward compatibility, ip::basic_resolver_results + is derived from ip::basic_resolver_iterator. + This derivation is deprecated. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results.html new file mode 100644 index 0000000..48264c4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results.html @@ -0,0 +1,57 @@ + + + +ip::basic_resolver_results::basic_resolver_results + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor creates an empty range. +

+
basic_resolver_results();
+  » more...
+
+

+ Copy constructor. +

+
basic_resolver_results(
+    const basic_resolver_results & other);
+  » more...
+
+

+ Move constructor. +

+
basic_resolver_results(
+    basic_resolver_results && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload1.html new file mode 100644 index 0000000..31a389f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload1.html @@ -0,0 +1,41 @@ + + + +ip::basic_resolver_results::basic_resolver_results (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor creates an empty range. +

+
basic_resolver_results();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload2.html new file mode 100644 index 0000000..6e6ae89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::basic_resolver_results (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_resolver_results(
+    const basic_resolver_results & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload3.html new file mode 100644 index 0000000..ea8440a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/basic_resolver_results/overload3.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::basic_resolver_results (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_resolver_results(
+    basic_resolver_results && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/begin.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/begin.html new file mode 100644 index 0000000..939eab7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/begin.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a begin iterator for the results range. +

+
const_iterator begin() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/cbegin.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/cbegin.html new file mode 100644 index 0000000..9922b54 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/cbegin.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::cbegin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a begin iterator for the results range. +

+
const_iterator cbegin() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/cend.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/cend.html new file mode 100644 index 0000000..fbfc3ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/cend.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::cend + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an end iterator for the results range. +

+
const_iterator cend() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/const_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/const_iterator.html new file mode 100644 index 0000000..efec5c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/const_iterator.html @@ -0,0 +1,387 @@ + + + +ip::basic_resolver_results::const_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of an iterator into the range. +

+
typedef basic_resolver_iterator< protocol_type > const_iterator;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ difference_type +

+ 		+

+ The type used for the distance between two iterators. +

+
+

+ iterator_category +

+ 		+

+ The iterator category. +

+
+

+ pointer +

+ 		+

+ The type of the result of applying operator->() to the iterator. +

+
+

+ reference +

+ 		+

+ The type of the result of applying operator*() to the iterator. +

+
+

+ value_type +

+ 		+

+ The type of the value pointed to by the iterator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_iterator [constructor] +

+ 		+

+ Default constructor creates an end iterator.
—
Copy + constructor.
—
Move constructor. +

+
+

+ operator* +

+ 		+

+ Dereference an iterator. +

+
+

+ operator++ +

+ 		+

+ Increment operator (prefix).
—
Increment operator + (postfix). +

+
+

+ operator-> +

+ 		+

+ Dereference an iterator. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move-assignment operator. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ dereference +

+ 		+
+

+ equal +

+ 		+
+

+ increment +

+ 		+
+
+ + Protected + Data Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ index_ +

+ 		+
+

+ values_ +

+ 		+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Test two iterators for inequality. +

+
+

+ operator== +

+ 		+

+ Test two iterators for equality. +

+
+

+ The 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>
+
+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/const_reference.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/const_reference.html new file mode 100644 index 0000000..3eca4ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/const_reference.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_results::const_reference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of a const reference to a value in the range. +

+
typedef const value_type & const_reference;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/difference_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/difference_type.html new file mode 100644 index 0000000..d09193d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/difference_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_results::difference_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + used to represent the distance between two iterators in the range. +

+
typedef std::ptrdiff_t difference_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/empty.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/empty.html new file mode 100644 index 0000000..9fb819f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/empty.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::empty + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the results range is empty. +

+
bool empty() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/end.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/end.html new file mode 100644 index 0000000..34f462c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/end.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an end iterator for the results range. +

+
const_iterator end() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/endpoint_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/endpoint_type.html new file mode 100644 index 0000000..72b5ca1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/endpoint_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_results::endpoint_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + endpoint type associated with the results. +

+
typedef protocol_type::endpoint endpoint_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/iterator.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/iterator.html new file mode 100644 index 0000000..0cdf6d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/iterator.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_results::iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of an iterator into the range. +

+
typedef const_iterator iterator;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/max_size.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/max_size.html new file mode 100644 index 0000000..6011e82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/max_size.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::max_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the maximum number of entries permitted in a results range. +

+
size_type max_size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_.html new file mode 100644 index 0000000..c939040 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::basic_resolver_results::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment + operator. +

+
basic_resolver_results & operator=(
+    const basic_resolver_results & other);
+  » more...
+
+

+ Move-assignment operator. +

+
basic_resolver_results & operator=(
+    basic_resolver_results && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_/overload1.html new file mode 100644 index 0000000..36b863c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_resolver_results & operator=(
+    const basic_resolver_results & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_/overload2.html new file mode 100644 index 0000000..13017d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assignment operator. +

+
basic_resolver_results & operator=(
+    basic_resolver_results && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq__eq_.html new file mode 100644 index 0000000..db5098c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_resolver_results::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + two iterators for equality. +

+
bool operator==(
+    const basic_resolver_results & a,
+    const basic_resolver_results & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_not__eq_.html new file mode 100644 index 0000000..da7ff8e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::basic_resolver_results::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + two iterators for inequality. +

+
bool operator!=(
+    const basic_resolver_results & a,
+    const basic_resolver_results & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/protocol_type.html new file mode 100644 index 0000000..789a7ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/protocol_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_results::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type associated with the results. +

+
typedef InternetProtocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/reference.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/reference.html new file mode 100644 index 0000000..54c7114 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/reference.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_results::reference + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of a non-const reference to a value in the range. +

+
typedef value_type & reference;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/size.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/size.html new file mode 100644 index 0000000..1fa1606 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/size.html @@ -0,0 +1,42 @@ + + + +ip::basic_resolver_results::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the number of entries in the results range. +

+
size_type size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/size_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/size_type.html new file mode 100644 index 0000000..ebc3738 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/size_type.html @@ -0,0 +1,52 @@ + + + +ip::basic_resolver_results::size_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + used to represent a count of the elements in the range. +

+
typedef std::size_t size_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/swap.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/swap.html new file mode 100644 index 0000000..8f20a2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/swap.html @@ -0,0 +1,43 @@ + + + +ip::basic_resolver_results::swap + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Swap + the results range with another. +

+
void swap(
+    basic_resolver_results & that);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/value_type.html new file mode 100644 index 0000000..4454aa1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__basic_resolver_results/value_type.html @@ -0,0 +1,201 @@ + + + +ip::basic_resolver_results::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of a value in the results range. +

+
typedef basic_resolver_entry< protocol_type > value_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type associated with the endpoint entry. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint entry. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_resolver_entry [constructor] +

+ 		+

+ Default constructor.
—
Construct with specified endpoint, + host name and service name. +

+
+

+ endpoint +

+ 		+

+ Get the endpoint associated with the entry. +

+
+

+ host_name +

+ 		+

+ Get the host name associated with the entry. +

+
+

+ operator endpoint_type +

+ 		+

+ Convert to the endpoint associated with the entry. +

+
+

+ service_name +

+ 		+

+ Get the service name associated with the entry. +

+
+

+ The ip::basic_resolver_entry class template + describes an entry as returned by a resolver. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/basic_resolver_results.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__host_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__host_name.html new file mode 100644 index 0000000..4eb7f43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__host_name.html @@ -0,0 +1,58 @@ + + + +ip::host_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Get the current host name. +

+
std::string host_name();
+  » more...
+
+std::string host_name(
+    asio::error_code & ec);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/ip/host_name.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__host_name/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__host_name/overload1.html new file mode 100644 index 0000000..1b04811 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__host_name/overload1.html @@ -0,0 +1,41 @@ + + + +ip::host_name (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the current host name. +

+
std::string host_name();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__host_name/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__host_name/overload2.html new file mode 100644 index 0000000..495e0b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__host_name/overload2.html @@ -0,0 +1,42 @@ + + + +ip::host_name (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the current host name. +

+
std::string host_name(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp.html new file mode 100644 index 0000000..24886ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp.html @@ -0,0 +1,263 @@ + + + +ip::icmp + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for ICMP. +

+
class icmp
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint +

+ 		+

+ The type of a ICMP endpoint. +

+
+

+ resolver +

+ 		+

+ The ICMP resolver type. +

+
+

+ socket +

+ 		+

+ The ICMP socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+

+ v4 + [static] +

+ 		+

+ Construct to represent the IPv4 ICMP protocol. +

+
+

+ v6 + [static] +

+ 		+

+ Construct to represent the IPv6 ICMP protocol. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two protocols for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two protocols for equality. +

+
+

+ The ip::icmp + class contains flags necessary for ICMP sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/ip/icmp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/endpoint.html new file mode 100644 index 0000000..7b39e3e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/endpoint.html @@ -0,0 +1,392 @@ + + + +ip::icmp::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of a ICMP endpoint. +

+
typedef basic_endpoint< icmp > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address +

+ 		+

+ Get the IP address associated with the endpoint.
—
+ Set the IP address associated with the endpoint. +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ 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.
—
Move + constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ 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. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The ip::basic_endpoint + class template describes an endpoint that may be associated with a particular + socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/icmp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/family.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/family.html new file mode 100644 index 0000000..9700ee9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/family.html @@ -0,0 +1,42 @@ + + + +ip::icmp::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for the + protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/operator_eq__eq_.html new file mode 100644 index 0000000..2349ce0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::icmp::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two protocols + for equality. +

+
bool operator==(
+    const icmp & p1,
+    const icmp & p2);
+
+
+ + Requirements +
+

+ Header: asio/ip/icmp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/operator_not__eq_.html new file mode 100644 index 0000000..d5d0a68 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::icmp::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two + protocols for inequality. +

+
bool operator!=(
+    const icmp & p1,
+    const icmp & p2);
+
+
+ + Requirements +
+

+ Header: asio/ip/icmp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/protocol.html new file mode 100644 index 0000000..4993c3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/protocol.html @@ -0,0 +1,42 @@ + + + +ip::icmp::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for + the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/resolver.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/resolver.html new file mode 100644 index 0000000..a3a2bf8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/resolver.html @@ -0,0 +1,391 @@ + + + +ip::icmp::resolver + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The ICMP resolver type. +

+
typedef basic_resolver< icmp > resolver;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the resolver type to another executor. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ results_type +

+ 		+

+ The results type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ 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. +

+
+

+ basic_resolver [constructor] +

+ 		+

+ Construct with executor.
—
Construct with execution + context.
—
Move-construct a basic_resolver from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the resolver. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_resolver from another. +

+
+

+ resolve +

+ 		+

+ Perform forward resolution of a query to a list of entries. +
—
Perform reverse resolution of an endpoint to a + list of entries. +

+
+

+ ~basic_resolver [destructor] +

+ 		+

+ Destroys the resolver. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a + port number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+

+ The ip::basic_resolver + class template provides the ability to resolve a query to a list of endpoints. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/icmp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/socket.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/socket.html new file mode 100644 index 0000000..cfc4482 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/socket.html @@ -0,0 +1,911 @@ + + + +ip::icmp::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The ICMP socket type. +

+
typedef basic_raw_socket< icmp > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_raw_socket [constructor] +

+ 		+

+ Construct a basic_raw_socket without opening it.
—
+ Construct and open a basic_raw_socket.
—
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.
—
Move-construct a basic_raw_socket + from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_raw_socket from another.
—
Move-assign + a basic_raw_socket from a socket of another protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive raw data with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send raw data to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_raw_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_raw_socket + class template provides asynchronous and blocking raw-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/ip/icmp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/type.html new file mode 100644 index 0000000..0cbedea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/type.html @@ -0,0 +1,42 @@ + + + +ip::icmp::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for the type + of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/v4.html new file mode 100644 index 0000000..f16f816 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/v4.html @@ -0,0 +1,42 @@ + + + +ip::icmp::v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct to represent the IPv4 ICMP + protocol. +

+
static icmp v4();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/v6.html new file mode 100644 index 0000000..7675f3d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__icmp/v6.html @@ -0,0 +1,42 @@ + + + +ip::icmp::v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct to represent the IPv6 ICMP + protocol. +

+
static icmp v6();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__enable_loopback.html b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__enable_loopback.html new file mode 100644 index 0000000..66aebe6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__enable_loopback.html @@ -0,0 +1,78 @@ + + + +ip::multicast::enable_loopback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Socket option determining whether outgoing multicast packets will be received + on the same socket if it is a member of the multicast group. +

+
typedef implementation_defined enable_loopback;
+
+

+ Implements the IPPROTO_IP/IP_MULTICAST_LOOP socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::multicast::enable_loopback option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::multicast::enable_loopback option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/ip/multicast.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__hops.html b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__hops.html new file mode 100644 index 0000000..3c22431 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__hops.html @@ -0,0 +1,77 @@ + + + +ip::multicast::hops + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Socket option for time-to-live associated with outgoing multicast packets. +

+
typedef implementation_defined hops;
+
+

+ Implements the IPPROTO_IP/IP_MULTICAST_TTL socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::multicast::hops option(4);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::multicast::hops option;
+socket.get_option(option);
+int ttl = option.value();
+
+
+ + Requirements +
+

+ Header: asio/ip/multicast.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__join_group.html b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__join_group.html new file mode 100644 index 0000000..35bd5ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__join_group.html @@ -0,0 +1,70 @@ + + + +ip::multicast::join_group + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ 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. +

+
+ + Examples +
+

+ Setting the option to join a multicast group: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::address multicast_address =
+  asio::ip::address::from_string("225.0.0.1");
+asio::ip::multicast::join_group option(multicast_address);
+socket.set_option(option);
+
+
+ + Requirements +
+

+ Header: asio/ip/multicast.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__leave_group.html b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__leave_group.html new file mode 100644 index 0000000..1f1da6a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__leave_group.html @@ -0,0 +1,70 @@ + + + +ip::multicast::leave_group + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Socket option to leave a multicast group on a specified interface. +

+
typedef implementation_defined leave_group;
+
+

+ Implements the IPPROTO_IP/IP_DROP_MEMBERSHIP socket option. +

+
+ + Examples +
+

+ Setting the option to leave a multicast group: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::address multicast_address =
+  asio::ip::address::from_string("225.0.0.1");
+asio::ip::multicast::leave_group option(multicast_address);
+socket.set_option(option);
+
+
+ + Requirements +
+

+ Header: asio/ip/multicast.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__outbound_interface.html b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__outbound_interface.html new file mode 100644 index 0000000..c5537c4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__multicast__outbound_interface.html @@ -0,0 +1,70 @@ + + + +ip::multicast::outbound_interface + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Socket option for local interface to use for outgoing multicast packets. +

+
typedef implementation_defined outbound_interface;
+
+

+ Implements the IPPROTO_IP/IP_MULTICAST_IF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::address_v4 local_interface =
+  asio::ip::address_v4::from_string("1.2.3.4");
+asio::ip::multicast::outbound_interface option(local_interface);
+socket.set_option(option);
+
+
+ + Requirements +
+

+ Header: asio/ip/multicast.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4.html new file mode 100644 index 0000000..fbfccda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4.html @@ -0,0 +1,329 @@ + + + +ip::network_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Represents an IPv4 network. +

+
class network_v4
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address +

+ 		+

+ Obtain the address object specified when the network object was + created. +

+
+

+ broadcast +

+ 		+

+ Obtain an address object that represents the network's broadcast + address. +

+
+

+ canonical +

+ 		+

+ Obtain the true network address, omitting any host bits. +

+
+

+ hosts +

+ 		+

+ Obtain an address range corresponding to the hosts in the network. +

+
+

+ is_host +

+ 		+

+ Test if network is a valid host address. +

+
+

+ is_subnet_of +

+ 		+

+ Test if a network is a real subnet of another network. +

+
+

+ netmask +

+ 		+

+ Obtain the netmask that was specified when the network object was + created. +

+
+

+ network +

+ 		+

+ Obtain an address object that represents the network address. +

+
+

+ network_v4 [constructor] +

+ 		+

+ Default constructor.
—
Construct a network based on + the specified address and prefix length.
—
Construct + network based on the specified address and netmask.
—
+ Copy constructor.
—
Move constructor. +

+
+

+ operator= +

+ 		+

+ Assign from another network.
—
Move-assign from another + network. +

+
+

+ prefix_length +

+ 		+

+ Obtain the prefix length that was specified when the network object + was created. +

+
+

+ to_string +

+ 		+

+ Get the network as an address in dotted decimal format. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two networks for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two networks for equality. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_network_v4 +

+ 		+

+ Create an IPv4 network from a string containing IP address and + prefix length. +

+
+

+ The ip::network_v4 + class provides the ability to use and manipulate IP version 4 networks. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/network_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/address.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/address.html new file mode 100644 index 0000000..8917f4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/address.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain the address + object specified when the network object was created. +

+
address_v4 address() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/broadcast.html new file mode 100644 index 0000000..ba95d41 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/broadcast.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an + address object that represents the network's broadcast address. +

+
address_v4 broadcast() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/canonical.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/canonical.html new file mode 100644 index 0000000..1d9d367 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/canonical.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::canonical + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain the + true network address, omitting any host bits. +

+
network_v4 canonical() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/hosts.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/hosts.html new file mode 100644 index 0000000..dfd7bd0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/hosts.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::hosts + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address + range corresponding to the hosts in the network. +

+
address_v4_range hosts() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/is_host.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/is_host.html new file mode 100644 index 0000000..6c5da25 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/is_host.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::is_host + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test if network + is a valid host address. +

+
bool is_host() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/is_subnet_of.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/is_subnet_of.html new file mode 100644 index 0000000..7681c01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/is_subnet_of.html @@ -0,0 +1,43 @@ + + + +ip::network_v4::is_subnet_of + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + if a network is a real subnet of another network. +

+
bool is_subnet_of(
+    const network_v4 & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4.html new file mode 100644 index 0000000..780b8fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4.html @@ -0,0 +1,67 @@ + + + +ip::network_v4::make_network_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + an IPv4 network from a string containing IP address and prefix length. +

+
network_v4 make_network_v4(
+    const char * str);
+  » more...
+
+network_v4 make_network_v4(
+    const char * str,
+    asio::error_code & ec);
+  » more...
+
+network_v4 make_network_v4(
+    const std::string & str);
+  » more...
+
+network_v4 make_network_v4(
+    const std::string & str,
+    asio::error_code & ec);
+  » more...
+
+network_v4 make_network_v4(
+    string_view str);
+  » more...
+
+network_v4 make_network_v4(
+    string_view str,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload1.html new file mode 100644 index 0000000..9a630d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload1.html @@ -0,0 +1,43 @@ + + + +ip::network_v4::make_network_v4 (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from a string containing IP address and prefix + length. +

+
network_v4 make_network_v4(
+    const char * str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload2.html new file mode 100644 index 0000000..8e848e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload2.html @@ -0,0 +1,44 @@ + + + +ip::network_v4::make_network_v4 (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from a string containing IP address and prefix + length. +

+
network_v4 make_network_v4(
+    const char * str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload3.html new file mode 100644 index 0000000..31a1b14 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload3.html @@ -0,0 +1,43 @@ + + + +ip::network_v4::make_network_v4 (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from a string containing IP address and prefix + length. +

+
network_v4 make_network_v4(
+    const std::string & str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload4.html new file mode 100644 index 0000000..ef85530 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload4.html @@ -0,0 +1,44 @@ + + + +ip::network_v4::make_network_v4 (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from a string containing IP address and prefix + length. +

+
network_v4 make_network_v4(
+    const std::string & str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload5.html new file mode 100644 index 0000000..5f5f63e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload5.html @@ -0,0 +1,43 @@ + + + +ip::network_v4::make_network_v4 (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from a string containing IP address and prefix + length. +

+
network_v4 make_network_v4(
+    string_view str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload6.html new file mode 100644 index 0000000..1c986ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/make_network_v4/overload6.html @@ -0,0 +1,44 @@ + + + +ip::network_v4::make_network_v4 (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv4 network from a string containing IP address and prefix + length. +

+
network_v4 make_network_v4(
+    string_view str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/netmask.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/netmask.html new file mode 100644 index 0000000..4c3e16d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/netmask.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::netmask + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain the netmask + that was specified when the network object was created. +

+
address_v4 netmask() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network.html new file mode 100644 index 0000000..a7a5562 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::network + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address + object that represents the network address. +

+
address_v4 network() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4.html new file mode 100644 index 0000000..0d1485e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4.html @@ -0,0 +1,73 @@ + + + +ip::network_v4::network_v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
network_v4();
+  » more...
+
+

+ Construct a network based on the specified address and prefix length. +

+
network_v4(
+    const address_v4 & addr,
+    unsigned short prefix_len);
+  » more...
+
+

+ Construct network based on the specified address and netmask. +

+
network_v4(
+    const address_v4 & addr,
+    const address_v4 & mask);
+  » more...
+
+

+ Copy constructor. +

+
network_v4(
+    const network_v4 & other);
+  » more...
+
+

+ Move constructor. +

+
network_v4(
+    network_v4 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload1.html new file mode 100644 index 0000000..fa02abb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload1.html @@ -0,0 +1,41 @@ + + + +ip::network_v4::network_v4 (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
network_v4();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload2.html new file mode 100644 index 0000000..39c3c5b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload2.html @@ -0,0 +1,43 @@ + + + +ip::network_v4::network_v4 (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a network based on the specified address and prefix length. +

+
network_v4(
+    const address_v4 & addr,
+    unsigned short prefix_len);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload3.html new file mode 100644 index 0000000..6a60ea3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload3.html @@ -0,0 +1,43 @@ + + + +ip::network_v4::network_v4 (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct network based on the specified address and netmask. +

+
network_v4(
+    const address_v4 & addr,
+    const address_v4 & mask);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload4.html new file mode 100644 index 0000000..3f5a137 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload4.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::network_v4 (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
network_v4(
+    const network_v4 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload5.html new file mode 100644 index 0000000..09c7242 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/network_v4/overload5.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::network_v4 (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
network_v4(
+    network_v4 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_.html new file mode 100644 index 0000000..72f5d34 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::network_v4::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + from another network. +

+
network_v4 & operator=(
+    const network_v4 & other);
+  » more...
+
+

+ Move-assign from another network. +

+
network_v4 & operator=(
+    network_v4 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_/overload1.html new file mode 100644 index 0000000..b4985e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another network. +

+
network_v4 & operator=(
+    const network_v4 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_/overload2.html new file mode 100644 index 0000000..c79b6ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another network. +

+
network_v4 & operator=(
+    network_v4 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq__eq_.html new file mode 100644 index 0000000..1982000 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::network_v4::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two networks for equality. +

+
bool operator==(
+    const network_v4 & a,
+    const network_v4 & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/network_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_not__eq_.html new file mode 100644 index 0000000..f2a3ad7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::network_v4::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two networks for inequality. +

+
bool operator!=(
+    const network_v4 & a,
+    const network_v4 & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/network_v4.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/prefix_length.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/prefix_length.html new file mode 100644 index 0000000..3678e14 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/prefix_length.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::prefix_length + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the prefix length that was specified when the network object was created. +

+
unsigned short prefix_length() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string.html new file mode 100644 index 0000000..992a1ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string.html @@ -0,0 +1,47 @@ + + + +ip::network_v4::to_string + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the network + as an address in dotted decimal format. +

+
std::string to_string() const;
+  » more...
+
+std::string to_string(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string/overload1.html new file mode 100644 index 0000000..6283140 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string/overload1.html @@ -0,0 +1,41 @@ + + + +ip::network_v4::to_string (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the network as an address in dotted decimal format. +

+
std::string to_string() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string/overload2.html new file mode 100644 index 0000000..c87ac72 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v4/to_string/overload2.html @@ -0,0 +1,42 @@ + + + +ip::network_v4::to_string (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the network as an address in dotted decimal format. +

+
std::string to_string(
+    asio::error_code & ec) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6.html new file mode 100644 index 0000000..b6c058e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6.html @@ -0,0 +1,302 @@ + + + +ip::network_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Represents an IPv6 network. +

+
class network_v6
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address +

+ 		+

+ Obtain the address object specified when the network object was + created. +

+
+

+ canonical +

+ 		+

+ Obtain the true network address, omitting any host bits. +

+
+

+ hosts +

+ 		+

+ Obtain an address range corresponding to the hosts in the network. +

+
+

+ is_host +

+ 		+

+ Test if network is a valid host address. +

+
+

+ is_subnet_of +

+ 		+

+ Test if a network is a real subnet of another network. +

+
+

+ network +

+ 		+

+ Obtain an address object that represents the network address. +

+
+

+ network_v6 [constructor] +

+ 		+

+ Default constructor.
—
Construct a network based on + the specified address and prefix length.
—
Copy constructor. +
—
Move constructor. +

+
+

+ operator= +

+ 		+

+ Assign from another network.
—
Move-assign from another + network. +

+
+

+ prefix_length +

+ 		+

+ Obtain the prefix length that was specified when the network object + was created. +

+
+

+ to_string +

+ 		+

+ Get the network as an address in dotted decimal format. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two networks for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two networks for equality. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ make_network_v6 +

+ 		+

+ Create an IPv6 network from a string containing IP address and + prefix length. +

+
+

+ The ip::network_v6 + class provides the ability to use and manipulate IP version 6 networks. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/network_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/address.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/address.html new file mode 100644 index 0000000..c1f4819 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/address.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain the address + object specified when the network object was created. +

+
address_v6 address() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/canonical.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/canonical.html new file mode 100644 index 0000000..88d0db4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/canonical.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::canonical + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain the + true network address, omitting any host bits. +

+
network_v6 canonical() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/hosts.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/hosts.html new file mode 100644 index 0000000..700c4fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/hosts.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::hosts + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address + range corresponding to the hosts in the network. +

+
address_v6_range hosts() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/is_host.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/is_host.html new file mode 100644 index 0000000..b547c76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/is_host.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::is_host + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test if network + is a valid host address. +

+
bool is_host() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/is_subnet_of.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/is_subnet_of.html new file mode 100644 index 0000000..09b49d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/is_subnet_of.html @@ -0,0 +1,43 @@ + + + +ip::network_v6::is_subnet_of + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test + if a network is a real subnet of another network. +

+
bool is_subnet_of(
+    const network_v6 & other) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6.html new file mode 100644 index 0000000..b6568bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6.html @@ -0,0 +1,67 @@ + + + +ip::network_v6::make_network_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + an IPv6 network from a string containing IP address and prefix length. +

+
network_v6 make_network_v6(
+    const char * str);
+  » more...
+
+network_v6 make_network_v6(
+    const char * str,
+    asio::error_code & ec);
+  » more...
+
+network_v6 make_network_v6(
+    const std::string & str);
+  » more...
+
+network_v6 make_network_v6(
+    const std::string & str,
+    asio::error_code & ec);
+  » more...
+
+network_v6 make_network_v6(
+    string_view str);
+  » more...
+
+network_v6 make_network_v6(
+    string_view str,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload1.html new file mode 100644 index 0000000..03bb977 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload1.html @@ -0,0 +1,43 @@ + + + +ip::network_v6::make_network_v6 (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 network from a string containing IP address and prefix + length. +

+
network_v6 make_network_v6(
+    const char * str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload2.html new file mode 100644 index 0000000..f93f432 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload2.html @@ -0,0 +1,44 @@ + + + +ip::network_v6::make_network_v6 (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 network from a string containing IP address and prefix + length. +

+
network_v6 make_network_v6(
+    const char * str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload3.html new file mode 100644 index 0000000..431eb89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload3.html @@ -0,0 +1,43 @@ + + + +ip::network_v6::make_network_v6 (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 network from a string containing IP address and prefix + length. +

+
network_v6 make_network_v6(
+    const std::string & str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload4.html new file mode 100644 index 0000000..3dbb09c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload4.html @@ -0,0 +1,44 @@ + + + +ip::network_v6::make_network_v6 (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 network from a string containing IP address and prefix + length. +

+
network_v6 make_network_v6(
+    const std::string & str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload5.html new file mode 100644 index 0000000..a4a31a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload5.html @@ -0,0 +1,43 @@ + + + +ip::network_v6::make_network_v6 (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 network from a string containing IP address and prefix + length. +

+
network_v6 make_network_v6(
+    string_view str);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload6.html new file mode 100644 index 0000000..88d0c09 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/make_network_v6/overload6.html @@ -0,0 +1,44 @@ + + + +ip::network_v6::make_network_v6 (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an IPv6 network from a string containing IP address and prefix + length. +

+
network_v6 make_network_v6(
+    string_view str,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network.html new file mode 100644 index 0000000..8cf9306 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::network + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an address + object that represents the network address. +

+
address_v6 network() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6.html new file mode 100644 index 0000000..5531392 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6.html @@ -0,0 +1,65 @@ + + + +ip::network_v6::network_v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
network_v6();
+  » more...
+
+

+ Construct a network based on the specified address and prefix length. +

+
network_v6(
+    const address_v6 & addr,
+    unsigned short prefix_len);
+  » more...
+
+

+ Copy constructor. +

+
network_v6(
+    const network_v6 & other);
+  » more...
+
+

+ Move constructor. +

+
network_v6(
+    network_v6 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload1.html new file mode 100644 index 0000000..e25f206 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload1.html @@ -0,0 +1,41 @@ + + + +ip::network_v6::network_v6 (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
network_v6();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload2.html new file mode 100644 index 0000000..9d972bd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload2.html @@ -0,0 +1,43 @@ + + + +ip::network_v6::network_v6 (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a network based on the specified address and prefix length. +

+
network_v6(
+    const address_v6 & addr,
+    unsigned short prefix_len);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload3.html new file mode 100644 index 0000000..d467c77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload3.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::network_v6 (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
network_v6(
+    const network_v6 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload4.html new file mode 100644 index 0000000..9caa446 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/network_v6/overload4.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::network_v6 (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
network_v6(
+    network_v6 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_.html new file mode 100644 index 0000000..a1c3e0d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_.html @@ -0,0 +1,51 @@ + + + +ip::network_v6::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + from another network. +

+
network_v6 & operator=(
+    const network_v6 & other);
+  » more...
+
+

+ Move-assign from another network. +

+
network_v6 & operator=(
+    network_v6 && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_/overload1.html new file mode 100644 index 0000000..b96ea60 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another network. +

+
network_v6 & operator=(
+    const network_v6 & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_/overload2.html new file mode 100644 index 0000000..4761bf2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another network. +

+
network_v6 & operator=(
+    network_v6 && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq__eq_.html new file mode 100644 index 0000000..2c40689 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::network_v6::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two networks for equality. +

+
bool operator==(
+    const network_v6 & a,
+    const network_v6 & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/network_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_not__eq_.html new file mode 100644 index 0000000..ba55260 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::network_v6::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two networks for inequality. +

+
bool operator!=(
+    const network_v6 & a,
+    const network_v6 & b);
+
+
+ + Requirements +
+

+ Header: asio/ip/network_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/prefix_length.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/prefix_length.html new file mode 100644 index 0000000..e770e70 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/prefix_length.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::prefix_length + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the prefix length that was specified when the network object was created. +

+
unsigned short prefix_length() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string.html new file mode 100644 index 0000000..c721ec6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string.html @@ -0,0 +1,47 @@ + + + +ip::network_v6::to_string + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the network + as an address in dotted decimal format. +

+
std::string to_string() const;
+  » more...
+
+std::string to_string(
+    asio::error_code & ec) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string/overload1.html new file mode 100644 index 0000000..d8095ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string/overload1.html @@ -0,0 +1,41 @@ + + + +ip::network_v6::to_string (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the network as an address in dotted decimal format. +

+
std::string to_string() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string/overload2.html new file mode 100644 index 0000000..6b3bc5a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__network_v6/to_string/overload2.html @@ -0,0 +1,42 @@ + + + +ip::network_v6::to_string (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the network as an address in dotted decimal format. +

+
std::string to_string(
+    asio::error_code & ec) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__port_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__port_type.html new file mode 100644 index 0000000..e4b6419 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__port_type.html @@ -0,0 +1,53 @@ + + + +ip::port_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Type used for storing port numbers. +

+
typedef uint_least16_t port_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base.html new file mode 100644 index 0000000..686cf88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base.html @@ -0,0 +1,239 @@ + + + +ip::resolver_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The ip::resolver_base + class is used as a base for the ip::basic_resolver + class templates to provide a common place to define the flag constants. +

+
class resolver_base
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~resolver_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a port + number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+
+ + Requirements +
+

+ Header: asio/ip/resolver_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/_resolver_base.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/_resolver_base.html new file mode 100644 index 0000000..a46fd49 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/_resolver_base.html @@ -0,0 +1,42 @@ + + + +ip::resolver_base::~resolver_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~resolver_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/address_configured.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/address_configured.html new file mode 100644 index 0000000..c73f528 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/address_configured.html @@ -0,0 +1,44 @@ + + + +ip::resolver_base::address_configured + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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. +

+
static const flags address_configured = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/all_matching.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/all_matching.html new file mode 100644 index 0000000..39baff2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/all_matching.html @@ -0,0 +1,42 @@ + + + +ip::resolver_base::all_matching + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +If + used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
static const flags all_matching = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/canonical_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/canonical_name.html new file mode 100644 index 0000000..32ce2cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/canonical_name.html @@ -0,0 +1,42 @@ + + + +ip::resolver_base::canonical_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + the canonical name of the host specified in the query. +

+
static const flags canonical_name = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/flags.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/flags.html new file mode 100644 index 0000000..47ea7ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/flags.html @@ -0,0 +1,52 @@ + + + +ip::resolver_base::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A bitmask type + (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/ip/resolver_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/numeric_host.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/numeric_host.html new file mode 100644 index 0000000..9b46939 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/numeric_host.html @@ -0,0 +1,43 @@ + + + +ip::resolver_base::numeric_host + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/numeric_service.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/numeric_service.html new file mode 100644 index 0000000..90e8965 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/numeric_service.html @@ -0,0 +1,43 @@ + + + +ip::resolver_base::numeric_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/passive.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/passive.html new file mode 100644 index 0000000..3d72538 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/passive.html @@ -0,0 +1,42 @@ + + + +ip::resolver_base::passive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Indicate + that returned endpoint is intended for use as a locally bound socket endpoint. +

+
static const flags passive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/v4_mapped.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/v4_mapped.html new file mode 100644 index 0000000..d3c8b91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_base/v4_mapped.html @@ -0,0 +1,43 @@ + + + +ip::resolver_base::v4_mapped + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base.html new file mode 100644 index 0000000..9a4b34c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base.html @@ -0,0 +1,240 @@ + + + +ip::resolver_query_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The ip::resolver_query_base + class is used as a base for the ip::basic_resolver_query + class templates to provide a common place to define the flag constants. +

+
class resolver_query_base :
+  public ip::resolver_base
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~resolver_query_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a port + number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+
+ + Requirements +
+

+ Header: asio/ip/resolver_query_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/_resolver_query_base.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/_resolver_query_base.html new file mode 100644 index 0000000..ce2ba5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/_resolver_query_base.html @@ -0,0 +1,42 @@ + + + +ip::resolver_query_base::~resolver_query_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~resolver_query_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/address_configured.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/address_configured.html new file mode 100644 index 0000000..3156243 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/address_configured.html @@ -0,0 +1,47 @@ + + + +ip::resolver_query_base::address_configured + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_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. +

+
static const flags address_configured = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/all_matching.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/all_matching.html new file mode 100644 index 0000000..5d91cc2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/all_matching.html @@ -0,0 +1,45 @@ + + + +ip::resolver_query_base::all_matching + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +If + used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
static const flags all_matching = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/canonical_name.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/canonical_name.html new file mode 100644 index 0000000..6ff6798 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/canonical_name.html @@ -0,0 +1,45 @@ + + + +ip::resolver_query_base::canonical_name + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +Determine + the canonical name of the host specified in the query. +

+
static const flags canonical_name = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/flags.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/flags.html new file mode 100644 index 0000000..5a1f8ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/flags.html @@ -0,0 +1,55 @@ + + + +ip::resolver_query_base::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +A + bitmask type (C++ Std [lib.bitmask.types]). +

+
typedef unspecified flags;
+
+
+ + Requirements +
+

+ Header: asio/ip/resolver_query_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/numeric_host.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/numeric_host.html new file mode 100644 index 0000000..8b76c9c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/numeric_host.html @@ -0,0 +1,46 @@ + + + +ip::resolver_query_base::numeric_host + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/numeric_service.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/numeric_service.html new file mode 100644 index 0000000..c35be63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/numeric_service.html @@ -0,0 +1,46 @@ + + + +ip::resolver_query_base::numeric_service + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/passive.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/passive.html new file mode 100644 index 0000000..10668ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/passive.html @@ -0,0 +1,45 @@ + + + +ip::resolver_query_base::passive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +Indicate + that returned endpoint is intended for use as a locally bound socket endpoint. +

+
static const flags passive = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/v4_mapped.html b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/v4_mapped.html new file mode 100644 index 0000000..3e6b188 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__resolver_query_base/v4_mapped.html @@ -0,0 +1,46 @@ + + + +ip::resolver_query_base::v4_mapped + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from ip::resolver_base. +

+

+ +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;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__scope_id_type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__scope_id_type.html new file mode 100644 index 0000000..0bfc1a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__scope_id_type.html @@ -0,0 +1,53 @@ + + + +ip::scope_id_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Type used for storing IPv6 scope IDs. +

+
typedef uint_least32_t scope_id_type;
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp.html new file mode 100644 index 0000000..a11a73d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp.html @@ -0,0 +1,299 @@ + + + +ip::tcp + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for TCP. +

+
class tcp
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ acceptor +

+ 		+

+ The TCP acceptor type. +

+
+

+ endpoint +

+ 		+

+ The type of a TCP endpoint. +

+
+

+ iostream +

+ 		+

+ The TCP iostream type. +

+
+

+ no_delay +

+ 		+

+ Socket option for disabling the Nagle algorithm. +

+
+

+ resolver +

+ 		+

+ The TCP resolver type. +

+
+

+ socket +

+ 		+

+ The TCP socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+

+ v4 + [static] +

+ 		+

+ Construct to represent the IPv4 TCP protocol. +

+
+

+ v6 + [static] +

+ 		+

+ Construct to represent the IPv6 TCP protocol. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two protocols for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two protocols for equality. +

+
+

+ The ip::tcp + class contains flags necessary for TCP sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/acceptor.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/acceptor.html new file mode 100644 index 0000000..646776d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/acceptor.html @@ -0,0 +1,769 @@ + + + +ip::tcp::acceptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The TCP acceptor type. +

+
typedef basic_socket_acceptor< tcp > acceptor;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the acceptor type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of an acceptor. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ accept +

+ 		+

+ Accept a new connection.
—
Accept a new connection + and obtain the endpoint of the peer. +

+
+

+ assign +

+ 		+

+ Assigns an existing native acceptor to the acceptor. +

+
+

+ async_accept +

+ 		+

+ Start an asynchronous accept. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the acceptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_socket_acceptor [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_socket_acceptor from an acceptor of another protocol + type. +

+
+

+ bind +

+ 		+

+ Bind the acceptor to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the acceptor. +

+
+

+ close +

+ 		+

+ Close the acceptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the acceptor. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the acceptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the acceptor is open. +

+
+

+ listen +

+ 		+

+ Place the acceptor into the state where it will listen for new + connections. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the acceptor. +

+
+

+ native_handle +

+ 		+

+ Get the native acceptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native acceptor implementation. +
—
Sets the non-blocking mode of the native acceptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the acceptor.
—
Sets + the non-blocking mode of the acceptor. +

+
+

+ open +

+ 		+

+ Open the acceptor using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_acceptor from another.
—
+ Move-assign a basic_socket_acceptor from an acceptor of another + protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native acceptor. +

+
+

+ set_option +

+ 		+

+ Set an option on the acceptor. +

+
+

+ wait +

+ 		+

+ Wait for the acceptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_socket_acceptor [destructor] +

+ 		+

+ Destroys the acceptor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket_acceptor class template + is used for accepting new socket connections. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous accept operations + are thread safe, if the underlying operating system calls are also thread + safe. This means that it is permitted to perform concurrent calls to synchronous + accept operations on a + single socket object. Other synchronous operations, such as open or close, + are not thread safe. +

+
+ + Example +
+

+ Opening a socket acceptor with the SO_REUSEADDR option enabled: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::ip::tcp::endpoint endpoint(asio::ip::tcp::v4(), port);
+acceptor.open(endpoint.protocol());
+acceptor.set_option(asio::ip::tcp::acceptor::reuse_address(true));
+acceptor.bind(endpoint);
+acceptor.listen();
+
+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/endpoint.html new file mode 100644 index 0000000..0b987d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/endpoint.html @@ -0,0 +1,393 @@ + + + +ip::tcp::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of a TCP endpoint. +

+
typedef basic_endpoint< tcp > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address +

+ 		+

+ Get the IP address associated with the endpoint.
—
+ Set the IP address associated with the endpoint. +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ 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.
—
Move + constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ 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. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The ip::basic_endpoint + class template describes an endpoint that may be associated with a particular + socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/family.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/family.html new file mode 100644 index 0000000..4a087fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/family.html @@ -0,0 +1,42 @@ + + + +ip::tcp::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for the + protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/iostream.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/iostream.html new file mode 100644 index 0000000..27b7936 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/iostream.html @@ -0,0 +1,285 @@ + + + +ip::tcp::iostream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The TCP iostream type. +

+
typedef basic_socket_iostream< tcp > iostream;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ time_point +

+ 		+

+ The time type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_socket_iostream [constructor] +

+ 		+

+ Construct a basic_socket_iostream without establishing a connection. +
—
Construct a basic_socket_iostream from the supplied + socket.
—
Move-construct a basic_socket_iostream + from another.
—
Establish a connection to an endpoint + corresponding to a resolver query. +

+
+

+ close +

+ 		+

+ Close the connection. +

+
+

+ connect +

+ 		+

+ Establish a connection to an endpoint corresponding to a resolver + query. +

+
+

+ error +

+ 		+

+ Get the last error associated with the stream. +

+
+

+ expires_after +

+ 		+

+ Set the stream's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the stream's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the stream's expiry time as an absolute time. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_iostream from another. +

+
+

+ rdbuf +

+ 		+

+ Return a pointer to the underlying streambuf. +

+
+

+ socket +

+ 		+

+ Get a reference to the underlying socket. +

+
+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/no_delay.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/no_delay.html new file mode 100644 index 0000000..90c1683 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/no_delay.html @@ -0,0 +1,76 @@ + + + +ip::tcp::no_delay + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket option for disabling + the Nagle algorithm. +

+
typedef implementation_defined no_delay;
+
+

+ Implements the IPPROTO_TCP/TCP_NODELAY socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::tcp::no_delay option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/operator_eq__eq_.html new file mode 100644 index 0000000..f18aad0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::tcp::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two protocols + for equality. +

+
bool operator==(
+    const tcp & p1,
+    const tcp & p2);
+
+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/operator_not__eq_.html new file mode 100644 index 0000000..f751704 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::tcp::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two protocols + for inequality. +

+
bool operator!=(
+    const tcp & p1,
+    const tcp & p2);
+
+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/protocol.html new file mode 100644 index 0000000..b054df0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/protocol.html @@ -0,0 +1,42 @@ + + + +ip::tcp::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for + the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/resolver.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/resolver.html new file mode 100644 index 0000000..659d9e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/resolver.html @@ -0,0 +1,391 @@ + + + +ip::tcp::resolver + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The TCP resolver type. +

+
typedef basic_resolver< tcp > resolver;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the resolver type to another executor. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ results_type +

+ 		+

+ The results type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ 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. +

+
+

+ basic_resolver [constructor] +

+ 		+

+ Construct with executor.
—
Construct with execution + context.
—
Move-construct a basic_resolver from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the resolver. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_resolver from another. +

+
+

+ resolve +

+ 		+

+ Perform forward resolution of a query to a list of entries. +
—
Perform reverse resolution of an endpoint to a + list of entries. +

+
+

+ ~basic_resolver [destructor] +

+ 		+

+ Destroys the resolver. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a + port number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+

+ The ip::basic_resolver + class template provides the ability to resolve a query to a list of endpoints. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/socket.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/socket.html new file mode 100644 index 0000000..3d8e7bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/socket.html @@ -0,0 +1,914 @@ + + + +ip::tcp::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The TCP socket type. +

+
typedef basic_stream_socket< tcp > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_stream_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_stream_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_socket from another.
—
+ Move-assign a basic_stream_socket from a socket of another protocol + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the socket. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the socket. +

+
+

+ ~basic_stream_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_stream_socket + class template provides asynchronous and blocking stream-oriented socket + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single socket object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/ip/tcp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/type.html new file mode 100644 index 0000000..7c4de08 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/type.html @@ -0,0 +1,42 @@ + + + +ip::tcp::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for the type + of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/v4.html new file mode 100644 index 0000000..ffd85fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/v4.html @@ -0,0 +1,41 @@ + + + +ip::tcp::v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct to represent the IPv4 TCP protocol. +

+
static tcp v4();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/v6.html new file mode 100644 index 0000000..f169942 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__tcp/v6.html @@ -0,0 +1,41 @@ + + + +ip::tcp::v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct to represent the IPv6 TCP protocol. +

+
static tcp v6();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp.html new file mode 100644 index 0000000..f878969 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp.html @@ -0,0 +1,263 @@ + + + +ip::udp + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for UDP. +

+
class udp
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint +

+ 		+

+ The type of a UDP endpoint. +

+
+

+ resolver +

+ 		+

+ The UDP resolver type. +

+
+

+ socket +

+ 		+

+ The UDP socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+

+ v4 + [static] +

+ 		+

+ Construct to represent the IPv4 UDP protocol. +

+
+

+ v6 + [static] +

+ 		+

+ Construct to represent the IPv6 UDP protocol. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two protocols for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two protocols for equality. +

+
+

+ The ip::udp + class contains flags necessary for UDP sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/ip/udp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/endpoint.html new file mode 100644 index 0000000..5361ae9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/endpoint.html @@ -0,0 +1,393 @@ + + + +ip::udp::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type of a UDP endpoint. +

+
typedef basic_endpoint< udp > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address +

+ 		+

+ Get the IP address associated with the endpoint.
—
+ Set the IP address associated with the endpoint. +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ 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.
—
Move + constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ 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. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The ip::basic_endpoint + class template describes an endpoint that may be associated with a particular + socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/udp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/family.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/family.html new file mode 100644 index 0000000..9e9da17 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/family.html @@ -0,0 +1,42 @@ + + + +ip::udp::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for the + protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/operator_eq__eq_.html new file mode 100644 index 0000000..5fde680 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +ip::udp::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two protocols + for equality. +

+
bool operator==(
+    const udp & p1,
+    const udp & p2);
+
+
+ + Requirements +
+

+ Header: asio/ip/udp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/operator_not__eq_.html new file mode 100644 index 0000000..5b666e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +ip::udp::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two protocols + for inequality. +

+
bool operator!=(
+    const udp & p1,
+    const udp & p2);
+
+
+ + Requirements +
+

+ Header: asio/ip/udp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/protocol.html new file mode 100644 index 0000000..4a3963b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/protocol.html @@ -0,0 +1,42 @@ + + + +ip::udp::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for + the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/resolver.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/resolver.html new file mode 100644 index 0000000..d7f434d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/resolver.html @@ -0,0 +1,391 @@ + + + +ip::udp::resolver + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The UDP resolver type. +

+
typedef basic_resolver< udp > resolver;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the resolver type to another executor. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ results_type +

+ 		+

+ The results type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ 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. +

+
+

+ basic_resolver [constructor] +

+ 		+

+ Construct with executor.
—
Construct with execution + context.
—
Move-construct a basic_resolver from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the resolver. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_resolver from another. +

+
+

+ resolve +

+ 		+

+ Perform forward resolution of a query to a list of entries. +
—
Perform reverse resolution of an endpoint to a + list of entries. +

+
+

+ ~basic_resolver [destructor] +

+ 		+

+ Destroys the resolver. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ address_configured [static] +

+ 		+

+ 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. +

+
+

+ all_matching [static] +

+ 		+

+ If used with v4_mapped, return all matching IPv6 and IPv4 addresses. +

+
+

+ canonical_name [static] +

+ 		+

+ Determine the canonical name of the host specified in the query. +

+
+

+ numeric_host [static] +

+ 		+

+ Host name should be treated as a numeric string defining an IPv4 + or IPv6 address and no name resolution should be attempted. +

+
+

+ numeric_service [static] +

+ 		+

+ Service name should be treated as a numeric string defining a + port number and no name resolution should be attempted. +

+
+

+ passive [static] +

+ 		+

+ Indicate that returned endpoint is intended for use as a locally + bound socket endpoint. +

+
+

+ v4_mapped [static] +

+ 		+

+ If the query protocol family is specified as IPv6, return IPv4-mapped + IPv6 addresses on finding no IPv6 addresses. +

+
+

+ The ip::basic_resolver + class template provides the ability to resolve a query to a list of endpoints. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/ip/udp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/socket.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/socket.html new file mode 100644 index 0000000..b9140b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/socket.html @@ -0,0 +1,912 @@ + + + +ip::udp::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The UDP socket type. +

+
typedef basic_datagram_socket< udp > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_datagram_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_datagram_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_datagram_socket from another.
—
+ Move-assign a basic_datagram_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive a datagram with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send a datagram to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_datagram_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_datagram_socket class template + provides asynchronous and blocking datagram-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/ip/udp.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/type.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/type.html new file mode 100644 index 0000000..198b100 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/type.html @@ -0,0 +1,42 @@ + + + +ip::udp::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain an identifier for the type + of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/v4.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/v4.html new file mode 100644 index 0000000..c92df85 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/v4.html @@ -0,0 +1,41 @@ + + + +ip::udp::v4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct to represent the IPv4 UDP protocol. +

+
static udp v4();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__udp/v6.html b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/v6.html new file mode 100644 index 0000000..aa4941d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__udp/v6.html @@ -0,0 +1,41 @@ + + + +ip::udp::v6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct to represent the IPv6 UDP protocol. +

+
static udp v6();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__unicast__hops.html b/Packages/asio-1.36.0/doc/asio/reference/ip__unicast__hops.html new file mode 100644 index 0000000..02a522f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__unicast__hops.html @@ -0,0 +1,77 @@ + + + +ip::unicast::hops + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Socket option for time-to-live associated with outgoing unicast packets. +

+
typedef implementation_defined hops;
+
+

+ Implements the IPPROTO_IP/IP_UNICAST_TTL socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::unicast::hops option(4);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::ip::unicast::hops option;
+socket.get_option(option);
+int ttl = option.value();
+
+
+ + Requirements +
+

+ Header: asio/ip/unicast.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__v4_mapped_t.html b/Packages/asio-1.36.0/doc/asio/reference/ip__v4_mapped_t.html new file mode 100644 index 0000000..1615087 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__v4_mapped_t.html @@ -0,0 +1,68 @@ + + + +ip::v4_mapped_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Tag type used for distinguishing overloads that deal in IPv4-mapped IPv6 + addresses. +

+
enum v4_mapped_t
+
+

+ +

+
+ + Values +
+
+

+
+
v4_mapped
+
+
+
+
+ + Requirements +
+

+ Header: asio/ip/address_v6.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ip__v6_only.html b/Packages/asio-1.36.0/doc/asio/reference/ip__v6_only.html new file mode 100644 index 0000000..b3944b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ip__v6_only.html @@ -0,0 +1,78 @@ + + + +ip::v6_only + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Socket option for determining whether an IPv6 socket supports IPv6 communication + only. +

+
typedef implementation_defined v6_only;
+
+

+ Implements the IPPROTO_IPV6/IPV6_V6ONLY socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::v6_only option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::ip::v6_only option;
+socket.get_option(option);
+bool v6_only = option.value();
+
+
+ + Requirements +
+

+ Header: asio/ip/v6_only.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_applicable_property.html b/Packages/asio-1.36.0/doc/asio/reference/is_applicable_property.html new file mode 100644 index 0000000..0f42f62 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_applicable_property.html @@ -0,0 +1,54 @@ + + + +is_applicable_property + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<
+    typename T,
+    typename Property,
+      = void>
+struct is_applicable_property
+
+
+ + Requirements +
+

+ Header: asio/is_applicable_property.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_async_operation.html b/Packages/asio-1.36.0/doc/asio/reference/is_async_operation.html new file mode 100644 index 0000000..e99a771 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_async_operation.html @@ -0,0 +1,68 @@ + + + +is_async_operation + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The is_async_operation + trait detects whether a type T + and arguments Args... may + be used to initiate an asynchronous operation. +

+
template<
+    typename T,
+    typename... Args>
+struct is_async_operation :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template is_async_operation + is a trait is derived from true_type + if the expression T(Args..., token) + initiates an asynchronous operation, where token + is an unspecified completion token type. Otherwise, is_async_operation + is derived from false_type. +

+
+ + Requirements +
+

+ Header: asio/async_result.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_completion_condition.html b/Packages/asio-1.36.0/doc/asio/reference/is_completion_condition.html new file mode 100644 index 0000000..2521375 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_completion_condition.html @@ -0,0 +1,87 @@ + + + +is_completion_condition + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait for determining whether a function object is a completion condition. +

+
template<
+    typename T>
+struct is_completion_condition
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/completion_condition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_completion_condition/value.html b/Packages/asio-1.36.0/doc/asio/reference/is_completion_condition/value.html new file mode 100644 index 0000000..4bf1503 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_completion_condition/value.html @@ -0,0 +1,40 @@ + + + +is_completion_condition::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static constexpr bool value = automatically_determined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_connect_condition.html b/Packages/asio-1.36.0/doc/asio/reference/is_connect_condition.html new file mode 100644 index 0000000..667011e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_connect_condition.html @@ -0,0 +1,93 @@ + + + +is_connect_condition + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait for determining whether a function object is a connect condition that + can be used with connect + and async_connect. +

+
template<
+    typename T,
+    typename Iterator>
+struct is_connect_condition
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+

+ The value member is true if the type may be used as a connect condition. +

+
+
+ + Requirements +
+

+ Header: asio/connect.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_connect_condition/value.html b/Packages/asio-1.36.0/doc/asio/reference/is_connect_condition/value.html new file mode 100644 index 0000000..8ba2b2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_connect_condition/value.html @@ -0,0 +1,42 @@ + + + +is_connect_condition::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The value + member is true if the type may be used as a connect condition. +

+
static constexpr bool value = automatically_determined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_const_buffer_sequence.html b/Packages/asio-1.36.0/doc/asio/reference/is_const_buffer_sequence.html new file mode 100644 index 0000000..3c7e97d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_const_buffer_sequence.html @@ -0,0 +1,56 @@ + + + +is_const_buffer_sequence + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait to determine whether a type satisfies the ConstBufferSequence requirements. +

+
template<
+    typename T>
+struct is_const_buffer_sequence :
+  public integral_constant< bool, automatically_determined >
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_contiguous_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/is_contiguous_iterator.html new file mode 100644 index 0000000..6b48450 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_contiguous_iterator.html @@ -0,0 +1,58 @@ + + + +is_contiguous_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The is_contiguous_iterator + class is a traits class that may be used to determine whether a type is a + contiguous iterator. +

+
template<
+    typename T>
+struct is_contiguous_iterator :
+  public integral_constant< bool, std::contiguous_iterator< T > >
+
+
+ + Requirements +
+

+ Header: asio/is_contiguous_iterator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_deferred.html b/Packages/asio-1.36.0/doc/asio/reference/is_deferred.html new file mode 100644 index 0000000..6cf6d43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_deferred.html @@ -0,0 +1,56 @@ + + + +is_deferred + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait for detecting objects that are usable as deferred operations. +

+
template<
+    typename T>
+struct is_deferred :
+  public false_type
+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_disposition.html b/Packages/asio-1.36.0/doc/asio/reference/is_disposition.html new file mode 100644 index 0000000..edcdec3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_disposition.html @@ -0,0 +1,78 @@ + + + +is_disposition + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait used for testing whether a type satisfies the requirements of a disposition. +

+
template<
+    typename T>
+struct is_disposition :
+  public integral_constant< bool, automatically_determined >
+
+

+ To be a valid disposition, a type must be nothrow default-constructible, + nothrow move-constructible, nothrow move-assignable, and there must be a + specialisation of the disposition_traits template for + the type that provides the following static member functions: * not_an_error: + Takes an argument of type const T& + and returns a bool. +

+
    +
  • + throw_exception: + Takes an argument of type T. + The caller of this function must not pass a disposition value for which + not_an_error returns + true. This function must not return. +
    • +
  • + to_exception_ptr: + Takes an argument of type T + and returns a value of type std::exception_ptr. +
    • +
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer.html new file mode 100644 index 0000000..17d7db3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer.html @@ -0,0 +1,62 @@ + + + +is_dynamic_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait to determine whether a type satisfies the DynamicBuffer requirements. +

+
template<
+    typename T>
+struct is_dynamic_buffer :
+  public integral_constant< bool, automatically_determined >
+
+

+ If ASIO_NO_DYNAMIC_BUFFER_V1 + is not defined, determines whether the type satisfies the DynamicBuffer_v1 + requirements. Otherwise, if ASIO_NO_DYNAMIC_BUFFER_V1 + is defined, determines whether the type satisfies the DynamicBuffer_v2 requirements. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer_v1.html b/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer_v1.html new file mode 100644 index 0000000..52e10f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer_v1.html @@ -0,0 +1,56 @@ + + + +is_dynamic_buffer_v1 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait to determine whether a type satisfies the DynamicBuffer_v1 requirements. +

+
template<
+    typename T>
+struct is_dynamic_buffer_v1 :
+  public integral_constant< bool, automatically_determined >
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer_v2.html b/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer_v2.html new file mode 100644 index 0000000..47568ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_dynamic_buffer_v2.html @@ -0,0 +1,56 @@ + + + +is_dynamic_buffer_v2 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait to determine whether a type satisfies the DynamicBuffer_v2 requirements. +

+
template<
+    typename T>
+struct is_dynamic_buffer_v2 :
+  public integral_constant< bool, automatically_determined >
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_endpoint_sequence.html b/Packages/asio-1.36.0/doc/asio/reference/is_endpoint_sequence.html new file mode 100644 index 0000000..7a18651 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_endpoint_sequence.html @@ -0,0 +1,93 @@ + + + +is_endpoint_sequence + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Type trait used to determine whether a type is an endpoint sequence that + can be used with with connect + and async_connect. +

+
template<
+    typename T>
+struct is_endpoint_sequence
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+

+ The value member is true if the type may be used as an endpoint + sequence. +

+
+
+ + Requirements +
+

+ Header: asio/connect.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_endpoint_sequence/value.html b/Packages/asio-1.36.0/doc/asio/reference/is_endpoint_sequence/value.html new file mode 100644 index 0000000..46b6c40 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_endpoint_sequence/value.html @@ -0,0 +1,42 @@ + + + +is_endpoint_sequence::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The value + member is true if the type may be used as an endpoint sequence. +

+
static const bool value = automatically_determined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_executor.html b/Packages/asio-1.36.0/doc/asio/reference/is_executor.html new file mode 100644 index 0000000..b1f1879 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_executor.html @@ -0,0 +1,63 @@ + + + +is_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The is_executor + trait detects whether a type T meets the Executor type requirements. +

+
template<
+    typename T>
+struct is_executor :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template is_executor + is a UnaryTypeTrait that is derived from true_type + if the type T meets the syntactic + requirements for Executor, otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/is_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_match_condition.html b/Packages/asio-1.36.0/doc/asio/reference/is_match_condition.html new file mode 100644 index 0000000..7f32875 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_match_condition.html @@ -0,0 +1,91 @@ + + + +is_match_condition + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ 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
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+

+ The value member is true if the type may be used as a match condition. +

+
+
+ + Requirements +
+

+ Header: asio/read_until.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_match_condition/value.html b/Packages/asio-1.36.0/doc/asio/reference/is_match_condition/value.html new file mode 100644 index 0000000..7806427 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_match_condition/value.html @@ -0,0 +1,42 @@ + + + +is_match_condition::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The value + member is true if the type may be used as a match condition. +

+
static const bool value;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_mutable_buffer_sequence.html b/Packages/asio-1.36.0/doc/asio/reference/is_mutable_buffer_sequence.html new file mode 100644 index 0000000..3922e91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_mutable_buffer_sequence.html @@ -0,0 +1,56 @@ + + + +is_mutable_buffer_sequence + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Trait to determine whether a type satisfies the MutableBufferSequence requirements. +

+
template<
+    typename T>
+struct is_mutable_buffer_sequence :
+  public integral_constant< bool, automatically_determined >
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_prefer.html b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_prefer.html new file mode 100644 index 0000000..07d900b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_prefer.html @@ -0,0 +1,65 @@ + + + +is_nothrow_prefer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a prefer + expression will not throw. +

+
template<
+    typename T,
+    typename... Properties>
+struct is_nothrow_prefer :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template is_nothrow_prefer + is a trait that is derived from true_type + if the expression asio::prefer(std::declval<T>(), + std::declval<Properties>()...) + is noexcept; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/prefer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_query.html b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_query.html new file mode 100644 index 0000000..b808935 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_query.html @@ -0,0 +1,65 @@ + + + +is_nothrow_query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a query + expression will not throw. +

+
template<
+    typename T,
+    typename Property>
+struct is_nothrow_query :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template is_nothrow_query + is a trait that is derived from true_type + if the expression asio::query(std::declval<T>(), + std::declval<Property>()) + is noexcept; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_require.html b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_require.html new file mode 100644 index 0000000..020b21e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_require.html @@ -0,0 +1,65 @@ + + + +is_nothrow_require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a require + expression will not throw. +

+
template<
+    typename T,
+    typename... Properties>
+struct is_nothrow_require :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template is_nothrow_require + is a trait that is derived from true_type + if the expression asio::require(std::declval<T>(), + std::declval<Properties>()...) + is noexcept; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/require.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_require_concept.html b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_require_concept.html new file mode 100644 index 0000000..62398f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_nothrow_require_concept.html @@ -0,0 +1,65 @@ + + + +is_nothrow_require_concept + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines whether a require_concept + expression will not throw. +

+
template<
+    typename T,
+    typename Property>
+struct is_nothrow_require_concept :
+  public integral_constant< bool, automatically_determined >
+
+

+ Class template is_nothrow_require_concept + is a trait that is derived from true_type + if the expression asio::require_concept(std::declval<T>(), + std::declval<Property>()) + is noexcept; otherwise false_type. +

+
+ + Requirements +
+

+ Header: asio/require_concept.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_read_buffered.html b/Packages/asio-1.36.0/doc/asio/reference/is_read_buffered.html new file mode 100644 index 0000000..8ca5c4b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_read_buffered.html @@ -0,0 +1,93 @@ + + + +is_read_buffered + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The 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
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+

+ The value member is true only if the Stream type supports buffering + of read data. +

+
+
+ + Requirements +
+

+ Header: asio/is_read_buffered.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_read_buffered/value.html b/Packages/asio-1.36.0/doc/asio/reference/is_read_buffered/value.html new file mode 100644 index 0000000..be2382d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_read_buffered/value.html @@ -0,0 +1,42 @@ + + + +is_read_buffered::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The value member + is true only if the Stream type supports buffering of read data. +

+
static const bool value;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_write_buffered.html b/Packages/asio-1.36.0/doc/asio/reference/is_write_buffered.html new file mode 100644 index 0000000..64556ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_write_buffered.html @@ -0,0 +1,93 @@ + + + +is_write_buffered + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The 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
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+

+ The value member is true only if the Stream type supports buffering + of written data. +

+
+
+ + Requirements +
+

+ Header: asio/is_write_buffered.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/is_write_buffered/value.html b/Packages/asio-1.36.0/doc/asio/reference/is_write_buffered/value.html new file mode 100644 index 0000000..54d4114 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/is_write_buffered/value.html @@ -0,0 +1,42 @@ + + + +is_write_buffered::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The value member + is true only if the Stream type supports buffering of written data. +

+
static const bool value;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint.html new file mode 100644 index 0000000..b211fcf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint.html @@ -0,0 +1,375 @@ + + + +local::basic_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Describes an endpoint for a UNIX socket. +

+
template<
+    typename Protocol>
+class basic_endpoint
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on the + underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint using + the specified path name.
—
Copy constructor.
+ —
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from another + endpoint. +

+
+

+ path +

+ 		+

+ Get the path associated with the endpoint.
—
Set the + path associated with the endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The local::basic_endpoint + class template describes an endpoint that may be associated with a particular + UNIX socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint.html new file mode 100644 index 0000000..9644471 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint.html @@ -0,0 +1,68 @@ + + + +local::basic_endpoint::basic_endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
basic_endpoint();
+  » more...
+
+

+ Construct an endpoint using the specified path name. +

+
basic_endpoint(
+    const char * path_name);
+  » more...
+
+basic_endpoint(
+    const std::string & path_name);
+  » more...
+
+

+ Copy constructor. +

+
basic_endpoint(
+    const basic_endpoint & other);
+  » more...
+
+

+ Move constructor. +

+
basic_endpoint(
+    basic_endpoint && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload1.html new file mode 100644 index 0000000..92901d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload1.html @@ -0,0 +1,41 @@ + + + +local::basic_endpoint::basic_endpoint (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
basic_endpoint();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload2.html new file mode 100644 index 0000000..ef0022e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload2.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::basic_endpoint (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an endpoint using the specified path name. +

+
basic_endpoint(
+    const char * path_name);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload3.html new file mode 100644 index 0000000..e36fdaf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload3.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::basic_endpoint (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an endpoint using the specified path name. +

+
basic_endpoint(
+    const std::string & path_name);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload4.html new file mode 100644 index 0000000..74ddbc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload4.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::basic_endpoint (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_endpoint(
+    const basic_endpoint & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload5.html new file mode 100644 index 0000000..3e50e74 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/basic_endpoint/overload5.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::basic_endpoint (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_endpoint(
+    basic_endpoint && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/capacity.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/capacity.html new file mode 100644 index 0000000..f600476 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/capacity.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::capacity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the capacity of the endpoint in the native type. +

+
std::size_t capacity() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data.html new file mode 100644 index 0000000..2c9f0c7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data.html @@ -0,0 +1,46 @@ + + + +local::basic_endpoint::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + underlying endpoint in the native type. +

+
data_type * data();
+  » more...
+
+const data_type * data() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data/overload1.html new file mode 100644 index 0000000..f24cf97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data/overload1.html @@ -0,0 +1,41 @@ + + + +local::basic_endpoint::data (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying endpoint in the native type. +

+
data_type * data();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data/overload2.html new file mode 100644 index 0000000..23c884d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data/overload2.html @@ -0,0 +1,41 @@ + + + +local::basic_endpoint::data (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the underlying endpoint in the native type. +

+
const data_type * data() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data_type.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data_type.html new file mode 100644 index 0000000..73ab0a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/data_type.html @@ -0,0 +1,53 @@ + + + +local::basic_endpoint::data_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the endpoint structure. This type is dependent on the underlying + implementation of the socket layer. +

+
typedef implementation_defined data_type;
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_.html new file mode 100644 index 0000000..26c6bcc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_.html @@ -0,0 +1,51 @@ + + + +local::basic_endpoint::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + from another endpoint. +

+
basic_endpoint & operator=(
+    const basic_endpoint & other);
+  » more...
+
+

+ Move-assign from another endpoint. +

+
basic_endpoint & operator=(
+    basic_endpoint && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_/overload1.html new file mode 100644 index 0000000..ec6d16f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign from another endpoint. +

+
basic_endpoint & operator=(
+    const basic_endpoint & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_/overload2.html new file mode 100644 index 0000000..cf86cbf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign from another endpoint. +

+
basic_endpoint & operator=(
+    basic_endpoint && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq__eq_.html new file mode 100644 index 0000000..5090526 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +local::basic_endpoint::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two endpoints for equality. +

+
bool operator==(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_gt_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_gt_.html new file mode 100644 index 0000000..dcc1649 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_gt_.html @@ -0,0 +1,54 @@ + + + +local::basic_endpoint::operator> + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator>(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_gt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_gt__eq_.html new file mode 100644 index 0000000..0484178 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_gt__eq_.html @@ -0,0 +1,54 @@ + + + +local::basic_endpoint::operator>= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator>=(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt_.html new file mode 100644 index 0000000..0906d3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt_.html @@ -0,0 +1,54 @@ + + + +local::basic_endpoint::operator< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator<(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt__eq_.html new file mode 100644 index 0000000..cfd1242 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt__eq_.html @@ -0,0 +1,54 @@ + + + +local::basic_endpoint::operator<= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + endpoints for ordering. +

+
bool operator<=(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt__lt_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt__lt_.html new file mode 100644 index 0000000..bb532d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_lt__lt_.html @@ -0,0 +1,76 @@ + + + +local::basic_endpoint::operator<< + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Output + an endpoint as a string. +

+
template<
+    typename Elem,
+    typename Traits,
+    typename Protocol>
+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. +

+
+ + Parameters +
+
+

+
+
os
+

+ The output stream to which the string will be written. +

+
endpoint
+

+ The endpoint to be written. +

+
+
+
+ + Return + Value +
+

+ The output stream. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_not__eq_.html new file mode 100644 index 0000000..7d78b9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +local::basic_endpoint::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two endpoints for inequality. +

+
bool operator!=(
+    const basic_endpoint< Protocol > & e1,
+    const basic_endpoint< Protocol > & e2);
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path.html new file mode 100644 index 0000000..c81a7fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path.html @@ -0,0 +1,54 @@ + + + +local::basic_endpoint::path + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + path associated with the endpoint. +

+
std::string path() const;
+  » more...
+
+

+ Set the path associated with the endpoint. +

+
void path(
+    const char * p);
+  » more...
+
+void path(
+    const std::string & p);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload1.html new file mode 100644 index 0000000..3d1d78b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload1.html @@ -0,0 +1,41 @@ + + + +local::basic_endpoint::path (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the path associated with the endpoint. +

+
std::string path() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload2.html new file mode 100644 index 0000000..1676e7b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload2.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::path (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the path associated with the endpoint. +

+
void path(
+    const char * p);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload3.html new file mode 100644 index 0000000..6c8831b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/path/overload3.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::path (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the path associated with the endpoint. +

+
void path(
+    const std::string & p);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/protocol.html new file mode 100644 index 0000000..a85d9d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/protocol.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol associated with the endpoint. +

+
protocol_type protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/protocol_type.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/protocol_type.html new file mode 100644 index 0000000..24aecc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/protocol_type.html @@ -0,0 +1,52 @@ + + + +local::basic_endpoint::protocol_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + protocol type associated with the endpoint. +

+
typedef Protocol protocol_type;
+
+
+ + Requirements +
+

+ Header: asio/local/basic_endpoint.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/resize.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/resize.html new file mode 100644 index 0000000..89c5d19 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/resize.html @@ -0,0 +1,43 @@ + + + +local::basic_endpoint::resize + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the underlying size of the endpoint in the native type. +

+
void resize(
+    std::size_t new_size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/size.html b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/size.html new file mode 100644 index 0000000..3b41722 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__basic_endpoint/size.html @@ -0,0 +1,42 @@ + + + +local::basic_endpoint::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + underlying size of the endpoint in the native type. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair.html b/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair.html new file mode 100644 index 0000000..9254687 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair.html @@ -0,0 +1,70 @@ + + + +local::connect_pair + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a pair of connected sockets. +

+
template<
+    typename Protocol,
+    typename Executor1,
+    typename Executor2>
+void connect_pair(
+    basic_socket< Protocol, Executor1 > & socket1,
+    basic_socket< Protocol, Executor2 > & socket2);
+  » more...
+
+template<
+    typename Protocol,
+    typename Executor1,
+    typename Executor2>
+void connect_pair(
+    basic_socket< Protocol, Executor1 > & socket1,
+    basic_socket< Protocol, Executor2 > & socket2,
+    asio::error_code & ec);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/local/connect_pair.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair/overload1.html new file mode 100644 index 0000000..4bb55af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair/overload1.html @@ -0,0 +1,47 @@ + + + +local::connect_pair (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a pair of connected sockets. +

+
template<
+    typename Protocol,
+    typename Executor1,
+    typename Executor2>
+void connect_pair(
+    basic_socket< Protocol, Executor1 > & socket1,
+    basic_socket< Protocol, Executor2 > & socket2);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair/overload2.html new file mode 100644 index 0000000..b932fc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__connect_pair/overload2.html @@ -0,0 +1,48 @@ + + + +local::connect_pair (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a pair of connected sockets. +

+
template<
+    typename Protocol,
+    typename Executor1,
+    typename Executor2>
+void connect_pair(
+    basic_socket< Protocol, Executor1 > & socket1,
+    basic_socket< Protocol, Executor2 > & socket2,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol.html new file mode 100644 index 0000000..974b72c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol.html @@ -0,0 +1,176 @@ + + + +local::datagram_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for datagram-oriented UNIX sockets. +

+
class datagram_protocol
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ endpoint +

+ 		+

+ The type of a UNIX domain endpoint. +

+
+

+ socket +

+ 		+

+ The UNIX domain socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+

+ The local::datagram_protocol class contains + flags necessary for datagram-oriented UNIX domain sockets. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/local/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/endpoint.html new file mode 100644 index 0000000..9d9bc96 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/endpoint.html @@ -0,0 +1,372 @@ + + + +local::datagram_protocol::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of a UNIX domain endpoint. +

+
typedef basic_endpoint< datagram_protocol > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint using + the specified path name.
—
Copy constructor.
+ —
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ path +

+ 		+

+ Get the path associated with the endpoint.
—
Set + the path associated with the endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The local::basic_endpoint class template + describes an endpoint that may be associated with a particular UNIX socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/local/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/family.html b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/family.html new file mode 100644 index 0000000..23e5334 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/family.html @@ -0,0 +1,42 @@ + + + +local::datagram_protocol::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/protocol.html new file mode 100644 index 0000000..d657bdf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/protocol.html @@ -0,0 +1,42 @@ + + + +local::datagram_protocol::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/socket.html b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/socket.html new file mode 100644 index 0000000..b2dbe4d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/socket.html @@ -0,0 +1,913 @@ + + + +local::datagram_protocol::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + UNIX domain socket type. +

+
typedef basic_datagram_socket< datagram_protocol > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive on a connected socket. +

+
+

+ async_receive_from +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send on a connected socket. +

+
+

+ async_send_to +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_datagram_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_datagram_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_datagram_socket from another.
—
+ Move-assign a basic_datagram_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on a connected socket. +

+
+

+ receive_from +

+ 		+

+ Receive a datagram with the endpoint of the sender. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on a connected socket. +

+
+

+ send_to +

+ 		+

+ Send a datagram to the specified endpoint. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_datagram_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_datagram_socket class template + provides asynchronous and blocking datagram-oriented socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, send_to, receive, + receive_from, connect, and shutdown + operations are thread safe with respect to each other, if the underlying + operating system calls are also thread safe. This means that it is permitted + to perform concurrent calls to these synchronous operations on a single + socket object. Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/local/datagram_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/type.html b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/type.html new file mode 100644 index 0000000..7e354f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__datagram_protocol/type.html @@ -0,0 +1,42 @@ + + + +local::datagram_protocol::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the type of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol.html new file mode 100644 index 0000000..0518e18 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol.html @@ -0,0 +1,189 @@ + + + +local::seq_packet_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for seq_packet UNIX sockets. +

+
class seq_packet_protocol
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ acceptor +

+ 		+

+ The UNIX domain acceptor type. +

+
+

+ endpoint +

+ 		+

+ The type of a UNIX domain endpoint. +

+
+

+ socket +

+ 		+

+ The UNIX domain socket type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+

+ The local::seq_packet_protocol class contains + flags necessary for sequenced packet UNIX domain sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/local/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/acceptor.html b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/acceptor.html new file mode 100644 index 0000000..ecf6138 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/acceptor.html @@ -0,0 +1,770 @@ + + + +local::seq_packet_protocol::acceptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + UNIX domain acceptor type. +

+
typedef basic_socket_acceptor< seq_packet_protocol > acceptor;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the acceptor type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of an acceptor. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ accept +

+ 		+

+ Accept a new connection.
—
Accept a new connection + and obtain the endpoint of the peer. +

+
+

+ assign +

+ 		+

+ Assigns an existing native acceptor to the acceptor. +

+
+

+ async_accept +

+ 		+

+ Start an asynchronous accept. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the acceptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_socket_acceptor [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_socket_acceptor from an acceptor of another protocol + type. +

+
+

+ bind +

+ 		+

+ Bind the acceptor to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the acceptor. +

+
+

+ close +

+ 		+

+ Close the acceptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the acceptor. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the acceptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the acceptor is open. +

+
+

+ listen +

+ 		+

+ Place the acceptor into the state where it will listen for new + connections. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the acceptor. +

+
+

+ native_handle +

+ 		+

+ Get the native acceptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native acceptor implementation. +
—
Sets the non-blocking mode of the native acceptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the acceptor.
—
Sets + the non-blocking mode of the acceptor. +

+
+

+ open +

+ 		+

+ Open the acceptor using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_acceptor from another.
—
+ Move-assign a basic_socket_acceptor from an acceptor of another + protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native acceptor. +

+
+

+ set_option +

+ 		+

+ Set an option on the acceptor. +

+
+

+ wait +

+ 		+

+ Wait for the acceptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_socket_acceptor [destructor] +

+ 		+

+ Destroys the acceptor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket_acceptor class template + is used for accepting new socket connections. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous accept operations + are thread safe, if the underlying operating system calls are also thread + safe. This means that it is permitted to perform concurrent calls to synchronous + accept operations on a + single socket object. Other synchronous operations, such as open or close, + are not thread safe. +

+
+ + Example +
+

+ Opening a socket acceptor with the SO_REUSEADDR option enabled: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::ip::tcp::endpoint endpoint(asio::ip::tcp::v4(), port);
+acceptor.open(endpoint.protocol());
+acceptor.set_option(asio::ip::tcp::acceptor::reuse_address(true));
+acceptor.bind(endpoint);
+acceptor.listen();
+
+
+ + Requirements +
+

+ Header: asio/local/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/endpoint.html new file mode 100644 index 0000000..fb33cb1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/endpoint.html @@ -0,0 +1,372 @@ + + + +local::seq_packet_protocol::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of a UNIX domain endpoint. +

+
typedef basic_endpoint< seq_packet_protocol > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint using + the specified path name.
—
Copy constructor.
+ —
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ path +

+ 		+

+ Get the path associated with the endpoint.
—
Set + the path associated with the endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The local::basic_endpoint class template + describes an endpoint that may be associated with a particular UNIX socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/local/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/family.html b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/family.html new file mode 100644 index 0000000..bb30d28 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/family.html @@ -0,0 +1,42 @@ + + + +local::seq_packet_protocol::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/protocol.html new file mode 100644 index 0000000..67f8f98 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/protocol.html @@ -0,0 +1,42 @@ + + + +local::seq_packet_protocol::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/socket.html b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/socket.html new file mode 100644 index 0000000..dee1f3a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/socket.html @@ -0,0 +1,866 @@ + + + +local::seq_packet_protocol::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + UNIX domain socket type. +

+
typedef basic_seq_packet_socket< seq_packet_protocol > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_seq_packet_socket [constructor] +

+ 		+

+ Construct a basic_seq_packet_socket without opening it.
+ —
Construct and open a basic_seq_packet_socket.
— +
Construct a basic_seq_packet_socket, opening it and binding + it to the given local endpoint.
—
Construct a basic_seq_packet_socket + on an existing native socket.
—
Move-construct a + basic_seq_packet_socket from another.
—
Move-construct + a basic_seq_packet_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_seq_packet_socket from another.
—
+ Move-assign a basic_seq_packet_socket from a socket of another + protocol type. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_seq_packet_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_seq_packet_socket class + template provides asynchronous and blocking sequenced packet socket functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single socket object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/local/seq_packet_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/type.html b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/type.html new file mode 100644 index 0000000..4717214 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__seq_packet_protocol/type.html @@ -0,0 +1,42 @@ + + + +local::seq_packet_protocol::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the type of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol.html new file mode 100644 index 0000000..f951267 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol.html @@ -0,0 +1,200 @@ + + + +local::stream_protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Encapsulates the flags needed for stream-oriented UNIX sockets. +

+
class stream_protocol
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ acceptor +

+ 		+

+ The UNIX domain acceptor type. +

+
+

+ endpoint +

+ 		+

+ The type of a UNIX domain endpoint. +

+
+

+ iostream +

+ 		+

+ The UNIX domain iostream type. +

+
+

+ socket +

+ 		+

+ The UNIX domain socket type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ family +

+ 		+

+ Obtain an identifier for the protocol family. +

+
+

+ protocol +

+ 		+

+ Obtain an identifier for the protocol. +

+
+

+ type +

+ 		+

+ Obtain an identifier for the type of the protocol. +

+
+

+ The local::stream_protocol + class contains flags necessary for stream-oriented UNIX domain sockets. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe. +

+
+ + Requirements +
+

+ Header: asio/local/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/acceptor.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/acceptor.html new file mode 100644 index 0000000..33c0cb7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/acceptor.html @@ -0,0 +1,770 @@ + + + +local::stream_protocol::acceptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + UNIX domain acceptor type. +

+
typedef basic_socket_acceptor< stream_protocol > acceptor;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the acceptor type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of an acceptor. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ accept +

+ 		+

+ Accept a new connection.
—
Accept a new connection + and obtain the endpoint of the peer. +

+
+

+ assign +

+ 		+

+ Assigns an existing native acceptor to the acceptor. +

+
+

+ async_accept +

+ 		+

+ Start an asynchronous accept. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the acceptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_socket_acceptor [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_socket_acceptor from an acceptor of another protocol + type. +

+
+

+ bind +

+ 		+

+ Bind the acceptor to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the acceptor. +

+
+

+ close +

+ 		+

+ Close the acceptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the acceptor. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the acceptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the acceptor is open. +

+
+

+ listen +

+ 		+

+ Place the acceptor into the state where it will listen for new + connections. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the acceptor. +

+
+

+ native_handle +

+ 		+

+ Get the native acceptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native acceptor implementation. +
—
Sets the non-blocking mode of the native acceptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the acceptor.
—
Sets + the non-blocking mode of the acceptor. +

+
+

+ open +

+ 		+

+ Open the acceptor using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_acceptor from another.
—
+ Move-assign a basic_socket_acceptor from an acceptor of another + protocol type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native acceptor. +

+
+

+ set_option +

+ 		+

+ Set an option on the acceptor. +

+
+

+ wait +

+ 		+

+ Wait for the acceptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ ~basic_socket_acceptor [destructor] +

+ 		+

+ Destroys the acceptor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_socket_acceptor class template + is used for accepting new socket connections. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous accept operations + are thread safe, if the underlying operating system calls are also thread + safe. This means that it is permitted to perform concurrent calls to synchronous + accept operations on a + single socket object. Other synchronous operations, such as open or close, + are not thread safe. +

+
+ + Example +
+

+ Opening a socket acceptor with the SO_REUSEADDR option enabled: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+asio::ip::tcp::endpoint endpoint(asio::ip::tcp::v4(), port);
+acceptor.open(endpoint.protocol());
+acceptor.set_option(asio::ip::tcp::acceptor::reuse_address(true));
+acceptor.bind(endpoint);
+acceptor.listen();
+
+
+ + Requirements +
+

+ Header: asio/local/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/endpoint.html new file mode 100644 index 0000000..e1c0c08 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/endpoint.html @@ -0,0 +1,372 @@ + + + +local::stream_protocol::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of a UNIX domain endpoint. +

+
typedef basic_endpoint< stream_protocol > endpoint;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data_type +

+ 		+

+ The type of the endpoint structure. This type is dependent on + the underlying implementation of the socket layer. +

+
+

+ protocol_type +

+ 		+

+ The protocol type associated with the endpoint. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_endpoint [constructor] +

+ 		+

+ Default constructor.
—
Construct an endpoint using + the specified path name.
—
Copy constructor.
+ —
Move constructor. +

+
+

+ capacity +

+ 		+

+ Get the capacity of the endpoint in the native type. +

+
+

+ data +

+ 		+

+ Get the underlying endpoint in the native type. +

+
+

+ operator= +

+ 		+

+ Assign from another endpoint.
—
Move-assign from + another endpoint. +

+
+

+ path +

+ 		+

+ Get the path associated with the endpoint.
—
Set + the path associated with the endpoint. +

+
+

+ protocol +

+ 		+

+ The protocol associated with the endpoint. +

+
+

+ resize +

+ 		+

+ Set the underlying size of the endpoint in the native type. +

+
+

+ size +

+ 		+

+ Get the underlying size of the endpoint in the native type. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two endpoints for inequality. +

+
+

+ operator< +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator<= +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator== +

+ 		+

+ Compare two endpoints for equality. +

+
+

+ operator> +

+ 		+

+ Compare endpoints for ordering. +

+
+

+ operator>= +

+ 		+

+ Compare endpoints for ordering. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator<< +

+ 		+

+ Output an endpoint as a string. +

+
+

+ The local::basic_endpoint class template + describes an endpoint that may be associated with a particular UNIX socket. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/local/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/family.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/family.html new file mode 100644 index 0000000..1b5a3cc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/family.html @@ -0,0 +1,42 @@ + + + +local::stream_protocol::family + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol family. +

+
int family() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/iostream.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/iostream.html new file mode 100644 index 0000000..055a48b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/iostream.html @@ -0,0 +1,286 @@ + + + +local::stream_protocol::iostream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + UNIX domain iostream type. +

+
typedef basic_socket_iostream< stream_protocol > iostream;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ time_point +

+ 		+

+ The time type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_socket_iostream [constructor] +

+ 		+

+ Construct a basic_socket_iostream without establishing a connection. +
—
Construct a basic_socket_iostream from the supplied + socket.
—
Move-construct a basic_socket_iostream + from another.
—
Establish a connection to an endpoint + corresponding to a resolver query. +

+
+

+ close +

+ 		+

+ Close the connection. +

+
+

+ connect +

+ 		+

+ Establish a connection to an endpoint corresponding to a resolver + query. +

+
+

+ error +

+ 		+

+ Get the last error associated with the stream. +

+
+

+ expires_after +

+ 		+

+ Set the stream's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the stream's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the stream's expiry time as an absolute time. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_socket_iostream from another. +

+
+

+ rdbuf +

+ 		+

+ Return a pointer to the underlying streambuf. +

+
+

+ socket +

+ 		+

+ Get a reference to the underlying socket. +

+
+
+ + Requirements +
+

+ Header: asio/local/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/protocol.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/protocol.html new file mode 100644 index 0000000..9eec10d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/protocol.html @@ -0,0 +1,42 @@ + + + +local::stream_protocol::protocol + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the protocol. +

+
int protocol() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/socket.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/socket.html new file mode 100644 index 0000000..7e86a24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/socket.html @@ -0,0 +1,915 @@ + + + +local::stream_protocol::socket + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + UNIX domain socket type. +

+
typedef basic_stream_socket< stream_protocol > socket;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the socket type to another executor. +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ endpoint_type +

+ 		+

+ The endpoint type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close + if unsent data is present. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_socket is always the lowest layer. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive + operations. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a socket. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ protocol_type +

+ 		+

+ The protocol type. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native socket to the socket. +

+
+

+ async_connect +

+ 		+

+ Start an asynchronous connect. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_receive +

+ 		+

+ Start an asynchronous receive. +

+
+

+ async_send +

+ 		+

+ Start an asynchronous send. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ at_mark +

+ 		+

+ Determine whether the socket is at the out-of-band data mark. +

+
+

+ available +

+ 		+

+ Determine the number of bytes available for reading. +

+
+

+ basic_stream_socket [constructor] +

+ 		+

+ 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.
—
Move-construct + a basic_stream_socket from a socket of another protocol type. +

+
+

+ bind +

+ 		+

+ Bind the socket to the given local endpoint. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the socket. +

+
+

+ close +

+ 		+

+ Close the socket. +

+
+

+ connect +

+ 		+

+ Connect the socket to the specified endpoint. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the socket. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the socket. +

+
+

+ is_open +

+ 		+

+ Determine whether the socket is open. +

+
+

+ local_endpoint +

+ 		+

+ Get the local endpoint of the socket. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native socket representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native socket implementation. +
—
Sets the non-blocking mode of the native socket + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the socket.
—
Sets + the non-blocking mode of the socket. +

+
+

+ open +

+ 		+

+ Open the socket using the specified protocol. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_socket from another.
—
+ Move-assign a basic_stream_socket from a socket of another protocol + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the socket. +

+
+

+ receive +

+ 		+

+ Receive some data on the socket.
—
Receive some data + on a connected socket. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native socket. +

+
+

+ remote_endpoint +

+ 		+

+ Get the remote endpoint of the socket. +

+
+

+ send +

+ 		+

+ Send some data on the socket. +

+
+

+ set_option +

+ 		+

+ Set an option on the socket. +

+
+

+ shutdown +

+ 		+

+ Disable sends or receives on the socket. +

+
+

+ wait +

+ 		+

+ Wait for the socket to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the socket. +

+
+

+ ~basic_stream_socket [destructor] +

+ 		+

+ Destroys the socket. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+

+ The basic_stream_socket + class template provides asynchronous and blocking stream-oriented socket + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous send, receive, connect, + and shutdown operations + are thread safe with respect to each other, if the underlying operating + system calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single socket object. + Other synchronous operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/local/stream_protocol.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/type.html b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/type.html new file mode 100644 index 0000000..1106202 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/local__stream_protocol/type.html @@ -0,0 +1,42 @@ + + + +local::stream_protocol::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an identifier for the type of the protocol. +

+
int type() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_strand.html b/Packages/asio-1.36.0/doc/asio/reference/make_strand.html new file mode 100644 index 0000000..e9802c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_strand.html @@ -0,0 +1,75 @@ + + + +make_strand + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The make_strand + function creates a strand + object for an executor or execution context. +

+

+ Create a strand + object for an executor. +

+
template<
+    typename Executor>
+strand< Executor > make_strand(
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ Create a strand + object for an execution context. +

+
template<
+    typename ExecutionContext>
+strand< typename ExecutionContext::executor_type > make_strand(
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_strand/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/make_strand/overload1.html new file mode 100644 index 0000000..994a581 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_strand/overload1.html @@ -0,0 +1,67 @@ + + + +make_strand (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a strand + object for an executor. +

+
template<
+    typename Executor>
+strand< Executor > make_strand(
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ex
+

+ An executor. +

+
+
+
+ + Return + Value +
+

+ A strand constructed with the specified executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_strand/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/make_strand/overload2.html new file mode 100644 index 0000000..0c8f402 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_strand/overload2.html @@ -0,0 +1,68 @@ + + + +make_strand (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a strand + object for an execution context. +

+
template<
+    typename ExecutionContext>
+strand< typename ExecutionContext::executor_type > make_strand(
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context, from which an executor will be obtained. +

+
+
+
+ + Return + Value +
+

+ A strand constructed with the execution context's executor, obtained by + performing ctx.get_executor(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_work_guard.html b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard.html new file mode 100644 index 0000000..1c88cb1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard.html @@ -0,0 +1,92 @@ + + + +make_work_guard + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create an executor_work_guard object. +

+
template<
+    typename Executor>
+executor_work_guard< Executor > make_work_guard(
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext>
+executor_work_guard< typename ExecutionContext::executor_type > make_work_guard(
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+template<
+    typename T>
+executor_work_guard< typename constraint_t< !is_executor< T >::value &&!execution::is_executor< T >::value &&!is_convertible< T &, execution_context & >::value, associated_executor< T > >::type > make_work_guard(
+    const T & t);
+  » more...
+
+template<
+    typename T,
+    typename Executor>
+executor_work_guard< associated_executor_t< T, Executor > > make_work_guard(
+    const T & t,
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename T,
+    typename ExecutionContext>
+executor_work_guard< associated_executor_t< T, typename ExecutionContext::executor_type > > make_work_guard(
+    const T & t,
+    ExecutionContext & ctx,
+    constraint_t< !is_executor< T >::value >  = 0,
+    constraint_t< !execution::is_executor< T >::value >  = 0,
+    constraint_t< !is_convertible< T &, execution_context & >::value >  = 0,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/executor_work_guard.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload1.html new file mode 100644 index 0000000..a44ad7a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload1.html @@ -0,0 +1,66 @@ + + + +make_work_guard (1 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an executor_work_guard object. +

+
template<
+    typename Executor>
+executor_work_guard< Executor > make_work_guard(
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ex
+

+ An executor. +

+
+
+
+ + Return + Value +
+

+ A work guard constructed with the specified executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload2.html new file mode 100644 index 0000000..34e67e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload2.html @@ -0,0 +1,67 @@ + + + +make_work_guard (2 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an executor_work_guard object. +

+
template<
+    typename ExecutionContext>
+executor_work_guard< typename ExecutionContext::executor_type > make_work_guard(
+    ExecutionContext & ctx,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context, from which an executor will be obtained. +

+
+
+
+ + Return + Value +
+

+ A work guard constructed with the execution context's executor, obtained + by performing ctx.get_executor(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload3.html new file mode 100644 index 0000000..03d13f8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload3.html @@ -0,0 +1,67 @@ + + + +make_work_guard (3 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an executor_work_guard object. +

+
template<
+    typename T>
+executor_work_guard< typename constraint_t< !is_executor< T >::value &&!execution::is_executor< T >::value &&!is_convertible< T &, execution_context & >::value, associated_executor< T > >::type > make_work_guard(
+    const T & t);
+
+
+ + Parameters +
+
+

+
+
t
+

+ An arbitrary object, such as a completion handler, for which the + associated executor will be obtained. +

+
+
+
+ + Return + Value +
+

+ A work guard constructed with the associated executor of the object t, which is obtained as if by calling + get_associated_executor(t). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload4.html new file mode 100644 index 0000000..564e844 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload4.html @@ -0,0 +1,76 @@ + + + +make_work_guard (4 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an executor_work_guard object. +

+
template<
+    typename T,
+    typename Executor>
+executor_work_guard< associated_executor_t< T, Executor > > make_work_guard(
+    const T & t,
+    const Executor & ex,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
t
+

+ An arbitrary object, such as a completion handler, for which the + associated executor will be obtained. +

+
ex
+

+ An executor to be used as the candidate object when determining the + associated executor. +

+
+
+
+ + Return + Value +
+

+ A work guard constructed with the associated executor of the object t, which is obtained as if by calling + get_associated_executor(t, + ex). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload5.html new file mode 100644 index 0000000..9094161 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/make_work_guard/overload5.html @@ -0,0 +1,79 @@ + + + +make_work_guard (5 of 5 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create an executor_work_guard object. +

+
template<
+    typename T,
+    typename ExecutionContext>
+executor_work_guard< associated_executor_t< T, typename ExecutionContext::executor_type > > make_work_guard(
+    const T & t,
+    ExecutionContext & ctx,
+    constraint_t< !is_executor< T >::value >  = 0,
+    constraint_t< !execution::is_executor< T >::value >  = 0,
+    constraint_t< !is_convertible< T &, execution_context & >::value >  = 0,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
t
+

+ An arbitrary object, such as a completion handler, for which the + associated executor will be obtained. +

+
ctx
+

+ An execution context, from which an executor is obtained to use as + the candidate object for determining the associated executor. +

+
+
+
+ + Return + Value +
+

+ A work guard constructed with the associated executor of the object t, which is obtained as if by calling + get_associated_executor(t, + ctx.get_executor()). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions.html b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions.html new file mode 100644 index 0000000..7d87db7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions.html @@ -0,0 +1,115 @@ + + + +multiple_exceptions + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Exception thrown when there are multiple pending exceptions to rethrow. +

+
class multiple_exceptions :
+  public exception
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ first_exception +

+ 		+

+ Obtain a pointer to the first exception. +

+
+

+ multiple_exceptions [constructor] +

+ 		+

+ Constructor. +

+
+

+ what +

+ 		+

+ Obtain message associated with exception. +

+
+
+ + Requirements +
+

+ Header: asio/multiple_exceptions.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/first_exception.html b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/first_exception.html new file mode 100644 index 0000000..4ae1173 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/first_exception.html @@ -0,0 +1,42 @@ + + + +multiple_exceptions::first_exception + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + a pointer to the first exception. +

+
std::exception_ptr first_exception() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/multiple_exceptions.html b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/multiple_exceptions.html new file mode 100644 index 0000000..9332d23 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/multiple_exceptions.html @@ -0,0 +1,42 @@ + + + +multiple_exceptions::multiple_exceptions + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
multiple_exceptions(
+    std::exception_ptr first);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/what.html b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/what.html new file mode 100644 index 0000000..c303c1d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/multiple_exceptions/what.html @@ -0,0 +1,42 @@ + + + +multiple_exceptions::what + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain message + associated with exception. +

+
virtual const char * what() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer.html new file mode 100644 index 0000000..681c0a6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer.html @@ -0,0 +1,186 @@ + + + +mutable_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Holds a buffer that can be modified. +

+
class mutable_buffer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ mutable_buffer [constructor] +

+ 		+

+ Construct an empty buffer.
—
Construct a buffer to + represent a given memory range.
—
Construct a buffer + from a span of bytes. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new modifiable buffer that is offset from the start of + another. +

+
+

+ The 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::mutable_buffer b1 = ...;
+std::size_t s1 = b1.size();
+unsigned char* p1 = static_cast<unsigned char*>(b1.data());
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/data.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/data.html new file mode 100644 index 0000000..7df3247 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/data.html @@ -0,0 +1,42 @@ + + + +mutable_buffer::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a pointer to the + beginning of the memory range. +

+
void * data() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer.html new file mode 100644 index 0000000..b7197d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer.html @@ -0,0 +1,65 @@ + + + +mutable_buffer::mutable_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an empty buffer. +

+
mutable_buffer();
+  » more...
+
+

+ Construct a buffer to represent a given memory range. +

+
mutable_buffer(
+    void * data,
+    std::size_t size);
+  » more...
+
+

+ Construct a buffer from a span of bytes. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+mutable_buffer(
+    const Span< T, Extent > & span,
+    constraint_t< !is_const< T >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload1.html new file mode 100644 index 0000000..254aefb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload1.html @@ -0,0 +1,41 @@ + + + +mutable_buffer::mutable_buffer (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an empty buffer. +

+
mutable_buffer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload2.html new file mode 100644 index 0000000..188e36f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload2.html @@ -0,0 +1,43 @@ + + + +mutable_buffer::mutable_buffer (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a buffer to represent a given memory range. +

+
mutable_buffer(
+    void * data,
+    std::size_t size);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload3.html new file mode 100644 index 0000000..b905147 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/mutable_buffer/overload3.html @@ -0,0 +1,49 @@ + + + +mutable_buffer::mutable_buffer (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a buffer from a span of bytes. +

+
template<
+    template< typename, std::size_t > class Span,
+    typename T,
+    std::size_t Extent>
+mutable_buffer(
+    const Span< T, Extent > & span,
+    constraint_t< !is_const< T >::value, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< sizeof(T)==1, defaulted_constraint >  = defaulted_constraint(),
+    constraint_t< is_same< decltype(span.subspan(0, 0)), Span< T, static_cast< std::size_t >(-1)> >::value, defaulted_constraint >  = defaulted_constraint());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_.html new file mode 100644 index 0000000..9b99798 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_.html @@ -0,0 +1,50 @@ + + + +mutable_buffer::operator+ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + a new modifiable buffer that is offset from the start of another. +

+
mutable_buffer operator+(
+    const mutable_buffer & b,
+    std::size_t n);
+  » more...
+
+mutable_buffer operator+(
+    std::size_t n,
+    const mutable_buffer & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_/overload1.html new file mode 100644 index 0000000..5a68190 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_/overload1.html @@ -0,0 +1,43 @@ + + + +mutable_buffer::operator+ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that is offset from the start of another. +

+
mutable_buffer operator+(
+    const mutable_buffer & b,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_/overload2.html new file mode 100644 index 0000000..3678eb1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus_/overload2.html @@ -0,0 +1,43 @@ + + + +mutable_buffer::operator+ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that is offset from the start of another. +

+
mutable_buffer operator+(
+    std::size_t n,
+    const mutable_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus__eq_.html new file mode 100644 index 0000000..ca2b976 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/operator_plus__eq_.html @@ -0,0 +1,43 @@ + + + +mutable_buffer::operator+= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move + the start of the buffer by the specified number of bytes. +

+
mutable_buffer & operator+=(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/size.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/size.html new file mode 100644 index 0000000..275d7b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_buffer/size.html @@ -0,0 +1,42 @@ + + + +mutable_buffer::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the size of the + memory range. +

+
std::size_t size() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer.html new file mode 100644 index 0000000..4b60d77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer.html @@ -0,0 +1,194 @@ + + + +mutable_registered_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Holds a registered buffer over modifiable data. +

+
class mutable_registered_buffer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ buffer +

+ 		+

+ Get the underlying mutable buffer. +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ id +

+ 		+

+ Get the registered buffer identifier. +

+
+

+ mutable_registered_buffer [constructor] +

+ 		+

+ Default constructor creates an invalid registered buffer. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new modifiable registered buffer that is offset from the + start of another. +

+

+ Create a new modifiable buffer that is offset from the start of + another. +

+
+

+ Satisfies the MutableBufferSequence + type requirements. +

+
+ + Requirements +
+

+ Header: asio/registered_buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/buffer.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/buffer.html new file mode 100644 index 0000000..36c58fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/buffer.html @@ -0,0 +1,42 @@ + + + +mutable_registered_buffer::buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the underlying mutable buffer. +

+
const mutable_buffer & buffer() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/data.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/data.html new file mode 100644 index 0000000..12f04d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/data.html @@ -0,0 +1,50 @@ + + + +mutable_registered_buffer::data + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a pointer to the beginning of the memory range. +

+
void * data() const;
+
+
+ + Return + Value +
+

+ buffer().data(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/id.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/id.html new file mode 100644 index 0000000..174e9d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/id.html @@ -0,0 +1,42 @@ + + + +mutable_registered_buffer::id + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the registered buffer identifier. +

+
const registered_buffer_id & id() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/mutable_registered_buffer.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/mutable_registered_buffer.html new file mode 100644 index 0000000..5eb4411 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/mutable_registered_buffer.html @@ -0,0 +1,42 @@ + + + +mutable_registered_buffer::mutable_registered_buffer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor creates an invalid registered buffer. +

+
mutable_registered_buffer();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_.html new file mode 100644 index 0000000..5f8a5a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_.html @@ -0,0 +1,53 @@ + + + +mutable_registered_buffer::operator+ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Create + a new modifiable registered buffer that is offset from the start of another. +

+
mutable_registered_buffer operator+(
+    const mutable_registered_buffer & b,
+    std::size_t n);
+  » more...
+
+

+ Create a new modifiable buffer that is offset from the start of another. +

+
mutable_registered_buffer operator+(
+    std::size_t n,
+    const mutable_registered_buffer & b);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_/overload1.html new file mode 100644 index 0000000..015ca6c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_/overload1.html @@ -0,0 +1,44 @@ + + + +mutable_registered_buffer::operator+ (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable registered buffer that is offset from the start + of another. +

+
mutable_registered_buffer operator+(
+    const mutable_registered_buffer & b,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_/overload2.html new file mode 100644 index 0000000..4d2ca21 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus_/overload2.html @@ -0,0 +1,43 @@ + + + +mutable_registered_buffer::operator+ (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a new modifiable buffer that is offset from the start of another. +

+
mutable_registered_buffer operator+(
+    std::size_t n,
+    const mutable_registered_buffer & b);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus__eq_.html new file mode 100644 index 0000000..df8de5e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/operator_plus__eq_.html @@ -0,0 +1,43 @@ + + + +mutable_registered_buffer::operator+= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move + the start of the buffer by the specified number of bytes. +

+
mutable_registered_buffer & operator+=(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/size.html b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/size.html new file mode 100644 index 0000000..434e023 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/mutable_registered_buffer/size.html @@ -0,0 +1,50 @@ + + + +mutable_registered_buffer::size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the size of the memory range. +

+
std::size_t size() const;
+
+
+ + Return + Value +
+

+ buffer().size(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error.html b/Packages/asio-1.36.0/doc/asio/reference/no_error.html new file mode 100644 index 0000000..2434f67 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error.html @@ -0,0 +1,53 @@ + + + +no_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A special value used to indicate the absence of an error. +

+
constexpr no_error_t no_error;
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t.html new file mode 100644 index 0000000..da1abcf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t.html @@ -0,0 +1,138 @@ + + + +no_error_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A tag type used to indicate the absence of an error. +

+
struct no_error_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ no_error_t [constructor] +

+ 		+

+ Default constructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Inequality operator.
—
Inequality operator, returns + true if the disposition contains an error. +

+
+

+ operator== +

+ 		+

+ Equality operator.
—
Equality operator, returns true + if the disposition does not contain an error. +

+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/no_error_t.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/no_error_t.html new file mode 100644 index 0000000..4600df0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/no_error_t.html @@ -0,0 +1,41 @@ + + + +no_error_t::no_error_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
constexpr no_error_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_.html new file mode 100644 index 0000000..5a60841 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_.html @@ -0,0 +1,63 @@ + + + +no_error_t::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. +

+
constexpr bool operator==(
+    const no_error_t & ,
+    const no_error_t & );
+  » more...
+
+

+ Equality operator, returns true if the disposition does not contain an + error. +

+
template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator==(
+    const no_error_t & ,
+    const Disposition & d);
+  » more...
+
+template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator==(
+    const Disposition & d,
+    const no_error_t & );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload1.html new file mode 100644 index 0000000..4fa7dcc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload1.html @@ -0,0 +1,53 @@ + + + +no_error_t::operator== (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator. +

+
constexpr bool operator==(
+    const no_error_t & ,
+    const no_error_t & );
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload2.html new file mode 100644 index 0000000..d83c3aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload2.html @@ -0,0 +1,56 @@ + + + +no_error_t::operator== (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator, returns true if the disposition does not contain an + error. +

+
template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator==(
+    const no_error_t & ,
+    const Disposition & d);
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload3.html new file mode 100644 index 0000000..64ddeb9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_eq__eq_/overload3.html @@ -0,0 +1,56 @@ + + + +no_error_t::operator== (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Equality operator, returns true if the disposition does not contain an + error. +

+
template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator==(
+    const Disposition & d,
+    const no_error_t & );
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_.html new file mode 100644 index 0000000..edce8c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_.html @@ -0,0 +1,62 @@ + + + +no_error_t::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. +

+
constexpr bool operator!=(
+    const no_error_t & ,
+    const no_error_t & );
+  » more...
+
+

+ Inequality operator, returns true if the disposition contains an error. +

+
template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator!=(
+    const no_error_t & ,
+    const Disposition & d);
+  » more...
+
+template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator!=(
+    const Disposition & d,
+    const no_error_t & );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload1.html new file mode 100644 index 0000000..8c04318 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload1.html @@ -0,0 +1,53 @@ + + + +no_error_t::operator!= (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator. +

+
constexpr bool operator!=(
+    const no_error_t & ,
+    const no_error_t & );
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload2.html new file mode 100644 index 0000000..9c1637c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload2.html @@ -0,0 +1,55 @@ + + + +no_error_t::operator!= (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator, returns true if the disposition contains an error. +

+
template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator!=(
+    const no_error_t & ,
+    const Disposition & d);
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload3.html new file mode 100644 index 0000000..329c4d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/no_error_t/operator_not__eq_/overload3.html @@ -0,0 +1,55 @@ + + + +no_error_t::operator!= (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inequality operator, returns true if the disposition contains an error. +

+
template<
+    typename Disposition>
+constexpr constraint_t< is_disposition< Disposition >::value, bool > operator!=(
+    const Disposition & d,
+    const no_error_t & );
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/null_buffers.html b/Packages/asio-1.36.0/doc/asio/reference/null_buffers.html new file mode 100644 index 0000000..f4fa39c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/null_buffers.html @@ -0,0 +1,152 @@ + + + +null_buffers + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ (Deprecated: Use the socket/descriptor wait() and async_wait() member functions.) + An implementation of both the ConstBufferSequence and MutableBufferSequence + concepts to represent a null buffer sequence. +

+
class null_buffers
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_iterator +

+ 		+

+ A random-access iterator type that may be used to read elements. +

+
+

+ value_type +

+ 		+

+ The type for each element in the list of buffers. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ begin +

+ 		+

+ Get a random-access iterator to the first element. +

+
+

+ end +

+ 		+

+ Get a random-access iterator for one past the last element. +

+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/null_buffers/begin.html b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/begin.html new file mode 100644 index 0000000..a5a582c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/begin.html @@ -0,0 +1,42 @@ + + + +null_buffers::begin + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a random-access iterator + to the first element. +

+
const_iterator begin() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/null_buffers/const_iterator.html b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/const_iterator.html new file mode 100644 index 0000000..ed7d94c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/const_iterator.html @@ -0,0 +1,52 @@ + + + +null_buffers::const_iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A random-access + iterator type that may be used to read elements. +

+
typedef const mutable_buffer * const_iterator;
+
+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/null_buffers/end.html b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/end.html new file mode 100644 index 0000000..655f14c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/end.html @@ -0,0 +1,42 @@ + + + +null_buffers::end + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a random-access iterator + for one past the last element. +

+
const_iterator end() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/null_buffers/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/value_type.html new file mode 100644 index 0000000..bf0eda8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/null_buffers/value_type.html @@ -0,0 +1,185 @@ + + + +null_buffers::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type for + each element in the list of buffers. +

+
typedef mutable_buffer value_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ data +

+ 		+

+ Get a pointer to the beginning of the memory range. +

+
+

+ mutable_buffer [constructor] +

+ 		+

+ Construct an empty buffer.
—
Construct a buffer to + represent a given memory range.
—
Construct a buffer + from a span of bytes. +

+
+

+ operator+= +

+ 		+

+ Move the start of the buffer by the specified number of bytes. +

+
+

+ size +

+ 		+

+ Get the size of the memory range. +

+
+
+ + Related + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator+ +

+ 		+

+ Create a new modifiable buffer that is offset from the start + of another. +

+
+

+ The 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. +

+
+ + Accessing + Buffer Contents +
+

+ The contents of a buffer may be accessed using the data() and size() member functions: +

+
asio::mutable_buffer b1 = ...;
+std::size_t s1 = b1.size();
+unsigned char* p1 = static_cast<unsigned char*>(b1.data());
+
+

+ The data() + member function permits violations of type safety, so uses of it in application + code should be carefully considered. +

+
+ + Requirements +
+

+ Header: asio/buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/operator_pipe_.html b/Packages/asio-1.36.0/doc/asio/reference/operator_pipe_.html new file mode 100644 index 0000000..9ce651c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/operator_pipe_.html @@ -0,0 +1,58 @@ + + + +operator| + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Pipe operator used to chain deferred operations. +

+
template<
+    typename Head,
+    typename Tail>
+auto operator|(
+    Head head,
+    Tail && tail);
+
+
+ + Requirements +
+

+ Header: asio/deferred.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder.html new file mode 100644 index 0000000..ada2c4d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder.html @@ -0,0 +1,142 @@ + + + +partial_allocator_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to specify that the completion handler should have the supplied + allocator as its associated allocator. +

+
template<
+    typename Allocator>
+struct partial_allocator_binder
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + should have the allocator as its associated allocator. +

+
+

+ partial_allocator_binder [constructor] +

+ 		+

+ Constructor that specifies associated allocator. +

+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/bind_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/allocator_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/allocator_.html new file mode 100644 index 0000000..3609bb5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/allocator_.html @@ -0,0 +1,40 @@ + + + +partial_allocator_binder::allocator_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Allocator allocator_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/operator_lp__rp_.html new file mode 100644 index 0000000..5991924 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_allocator_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler should have the allocator as its + associated allocator. +

+
template<
+    typename CompletionToken>
+constexpr allocator_binder< decay_t< CompletionToken >, Allocator > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/partial_allocator_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/partial_allocator_binder.html new file mode 100644 index 0000000..fcd6f04 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_allocator_binder/partial_allocator_binder.html @@ -0,0 +1,43 @@ + + + +partial_allocator_binder::partial_allocator_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies associated allocator. +

+
partial_allocator_binder(
+    const Allocator & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple.html b/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple.html new file mode 100644 index 0000000..c09c089 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple.html @@ -0,0 +1,109 @@ + + + +partial_as_tuple + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to specify that the completion handler arguments should be combined + into a single tuple argument. +

+
struct partial_as_tuple
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + arguments should be combined into a single tuple argument. +

+
+

+ partial_as_tuple [constructor] +

+ 		+

+ Default constructor. +

+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/as_tuple.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple/operator_lp__rp_.html new file mode 100644 index 0000000..bf427f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_as_tuple::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler arguments should be combined into + a single tuple argument. +

+
template<
+    typename CompletionToken>
+constexpr as_tuple_t< decay_t< CompletionToken > > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple/partial_as_tuple.html b/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple/partial_as_tuple.html new file mode 100644 index 0000000..bb86e29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_as_tuple/partial_as_tuple.html @@ -0,0 +1,42 @@ + + + +partial_as_tuple::partial_as_tuple + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr partial_as_tuple();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after.html new file mode 100644 index 0000000..8661024 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after.html @@ -0,0 +1,154 @@ + + + +partial_cancel_after + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to cancel an operation after a timeout. +

+
template<
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>>
+class partial_cancel_after
+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + arguments should be combined into a single tuple argument. +

+
+

+ partial_cancel_after [constructor] +

+ 		+

+ Constructor that specifies the timeout duration and cancellation + type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ timeout_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/cancel_after.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/cancel_type_.html new file mode 100644 index 0000000..045bf92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/cancel_type_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_after::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/operator_lp__rp_.html new file mode 100644 index 0000000..ee198d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_cancel_after::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler arguments should be combined into + a single tuple argument. +

+
template<
+    typename CompletionToken>
+cancel_after_t< decay_t< CompletionToken >, Clock, WaitTraits > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/partial_cancel_after.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/partial_cancel_after.html new file mode 100644 index 0000000..0a32e85 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/partial_cancel_after.html @@ -0,0 +1,44 @@ + + + +partial_cancel_after::partial_cancel_after + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies the timeout duration and cancellation type. +

+
partial_cancel_after(
+    const typename Clock::duration & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/timeout_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/timeout_.html new file mode 100644 index 0000000..5d56f70 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after/timeout_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_after::timeout_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::duration timeout_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer.html new file mode 100644 index 0000000..88aed63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer.html @@ -0,0 +1,164 @@ + + + +partial_cancel_after_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to cancel an operation after a timeout. +

+
template<
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>,
+    typename Executor = any_io_executor>
+class partial_cancel_after_timer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + arguments should be combined into a single tuple argument. +

+
+

+ partial_cancel_after_timer [constructor] +

+ 		+

+ Constructor that specifies the timeout duration and cancellation + type. +

+
+
+ + Data Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ timeout_ +

+ 		+
+

+ timer_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/cancel_after.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/cancel_type_.html new file mode 100644 index 0000000..d87ccc2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/cancel_type_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_after_timer::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/operator_lp__rp_.html new file mode 100644 index 0000000..9db58d1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_cancel_after_timer::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler arguments should be combined into + a single tuple argument. +

+
template<
+    typename CompletionToken>
+cancel_after_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/partial_cancel_after_timer.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/partial_cancel_after_timer.html new file mode 100644 index 0000000..7dfc4d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/partial_cancel_after_timer.html @@ -0,0 +1,45 @@ + + + +partial_cancel_after_timer::partial_cancel_after_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies the timeout duration and cancellation type. +

+
partial_cancel_after_timer(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const typename Clock::duration & timeout,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/timeout_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/timeout_.html new file mode 100644 index 0000000..01bf605 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/timeout_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_after_timer::timeout_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::duration timeout_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/timer_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/timer_.html new file mode 100644 index 0000000..98208fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_after_timer/timer_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_after_timer::timer_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
basic_waitable_timer< Clock, WaitTraits, Executor > & timer_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at.html new file mode 100644 index 0000000..263ea43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at.html @@ -0,0 +1,154 @@ + + + +partial_cancel_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to cancel an operation at a given time. +

+
template<
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>>
+class partial_cancel_at
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + arguments should be combined into a single tuple argument. +

+
+

+ partial_cancel_at [constructor] +

+ 		+

+ Constructor that specifies the expiry and cancellation type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ expiry_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/cancel_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/cancel_type_.html new file mode 100644 index 0000000..e512aa6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/cancel_type_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_at::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/expiry_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/expiry_.html new file mode 100644 index 0000000..ac56dcf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/expiry_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_at::expiry_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::time_point expiry_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/operator_lp__rp_.html new file mode 100644 index 0000000..5d06bae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_cancel_at::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler arguments should be combined into + a single tuple argument. +

+
template<
+    typename CompletionToken>
+constexpr cancel_at_t< decay_t< CompletionToken >, Clock, WaitTraits > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/partial_cancel_at.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/partial_cancel_at.html new file mode 100644 index 0000000..cae85f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at/partial_cancel_at.html @@ -0,0 +1,44 @@ + + + +partial_cancel_at::partial_cancel_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies the expiry and cancellation type. +

+
partial_cancel_at(
+    const typename Clock::time_point & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer.html new file mode 100644 index 0000000..650f84a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer.html @@ -0,0 +1,164 @@ + + + +partial_cancel_at_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to cancel an operation at a given time. +

+
template<
+    typename Clock,
+    typename WaitTraits = asio::wait_traits<Clock>,
+    typename Executor = any_io_executor>
+class partial_cancel_at_timer
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + arguments should be combined into a single tuple argument. +

+
+

+ partial_cancel_at_timer [constructor] +

+ 		+

+ Constructor that specifies the expiry and cancellation type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancel_type_ +

+ 		+
+

+ expiry_ +

+ 		+
+

+ timer_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/cancel_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/cancel_type_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/cancel_type_.html new file mode 100644 index 0000000..6c91d89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/cancel_type_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_at_timer::cancel_type_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
cancellation_type_t cancel_type_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/expiry_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/expiry_.html new file mode 100644 index 0000000..e958fe2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/expiry_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_at_timer::expiry_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Clock::time_point expiry_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/operator_lp__rp_.html new file mode 100644 index 0000000..1fc4016 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_cancel_at_timer::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler arguments should be combined into + a single tuple argument. +

+
template<
+    typename CompletionToken>
+cancel_at_timer< decay_t< CompletionToken >, Clock, WaitTraits, Executor > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/partial_cancel_at_timer.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/partial_cancel_at_timer.html new file mode 100644 index 0000000..1bbd31e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/partial_cancel_at_timer.html @@ -0,0 +1,45 @@ + + + +partial_cancel_at_timer::partial_cancel_at_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies the expiry and cancellation type. +

+
partial_cancel_at_timer(
+    basic_waitable_timer< Clock, WaitTraits, Executor > & timer,
+    const typename Clock::time_point & expiry,
+    cancellation_type_t cancel_type = cancellation_type::terminal);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/timer_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/timer_.html new file mode 100644 index 0000000..7a0d24f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancel_at_timer/timer_.html @@ -0,0 +1,40 @@ + + + +partial_cancel_at_timer::timer_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
basic_waitable_timer< Clock, WaitTraits, Executor > & timer_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder.html new file mode 100644 index 0000000..7583da5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder.html @@ -0,0 +1,145 @@ + + + +partial_cancellation_slot_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to specify that the completion handler should have the supplied + cancellation slot as its associated cancellation slot. +

+
template<
+    typename CancellationSlot>
+struct partial_cancellation_slot_binder
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + should have the cancellation slot as its associated cancellation + slot. +

+
+

+ partial_cancellation_slot_binder + [constructor] +

+ 		+

+ Constructor that specifies associated cancellation slot. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancellation_slot_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/bind_cancellation_slot.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/cancellation_slot_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/cancellation_slot_.html new file mode 100644 index 0000000..2baa0ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/cancellation_slot_.html @@ -0,0 +1,40 @@ + + + +partial_cancellation_slot_binder::cancellation_slot_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CancellationSlot cancellation_slot_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/operator_lp__rp_.html new file mode 100644 index 0000000..2372301 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_cancellation_slot_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler should have the cancellation slot + as its associated cancellation slot. +

+
template<
+    typename CompletionToken>
+constexpr cancellation_slot_binder< decay_t< CompletionToken >, CancellationSlot > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/partial_cancellation_slot_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/partial_cancellation_slot_binder.html new file mode 100644 index 0000000..a3eadc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_cancellation_slot_binder/partial_cancellation_slot_binder.html @@ -0,0 +1,43 @@ + + + +partial_cancellation_slot_binder::partial_cancellation_slot_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies associated cancellation slot. +

+
partial_cancellation_slot_binder(
+    const CancellationSlot & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder.html new file mode 100644 index 0000000..35a7e3c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder.html @@ -0,0 +1,143 @@ + + + +partial_executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to specify that the completion handler should have the supplied + executor as its associated executor. +

+
template<
+    typename Executor>
+struct partial_executor_binder
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + should have the executor as its associated executor. +

+
+

+ partial_executor_binder [constructor] +

+ 		+

+ Constructor that specifies associated executor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/bind_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/executor_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/executor_.html new file mode 100644 index 0000000..12e4005 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/executor_.html @@ -0,0 +1,40 @@ + + + +partial_executor_binder::executor_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Executor executor_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/operator_lp__rp_.html new file mode 100644 index 0000000..0b81628 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_executor_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler should have the executor as its + associated executor. +

+
template<
+    typename CompletionToken>
+constexpr executor_binder< decay_t< CompletionToken >, Executor > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/partial_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/partial_executor_binder.html new file mode 100644 index 0000000..bd4f6e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_executor_binder/partial_executor_binder.html @@ -0,0 +1,43 @@ + + + +partial_executor_binder::partial_executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies associated executor. +

+
partial_executor_binder(
+    const Executor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder.html new file mode 100644 index 0000000..df52d6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder.html @@ -0,0 +1,144 @@ + + + +partial_immediate_executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to specify that the completion handler should have the supplied + executor as its associated immediate executor. +

+
template<
+    typename Executor>
+struct partial_immediate_executor_binder
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + should have the executor as its associated immediate executor. +

+
+

+ partial_immediate_executor_binder + [constructor] +

+ 		+

+ Constructor that specifies associated executor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/bind_immediate_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/executor_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/executor_.html new file mode 100644 index 0000000..e90b7d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/executor_.html @@ -0,0 +1,40 @@ + + + +partial_immediate_executor_binder::executor_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
Executor executor_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/operator_lp__rp_.html new file mode 100644 index 0000000..2d69c63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_immediate_executor_binder::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler should have the executor as its + associated immediate executor. +

+
template<
+    typename CompletionToken>
+constexpr immediate_executor_binder< decay_t< CompletionToken >, Executor > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/partial_immediate_executor_binder.html b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/partial_immediate_executor_binder.html new file mode 100644 index 0000000..3eb1044 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_immediate_executor_binder/partial_immediate_executor_binder.html @@ -0,0 +1,43 @@ + + + +partial_immediate_executor_binder::partial_immediate_executor_binder + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies associated executor. +

+
partial_immediate_executor_binder(
+    const Executor & ex);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error.html b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error.html new file mode 100644 index 0000000..2ce4720 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error.html @@ -0,0 +1,140 @@ + + + +partial_redirect_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A function object type that adapts a completion + token to capture error_code values to a variable. +

+
class partial_redirect_error
+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator() +

+ 		+

+ Adapt a completion token to specify that the completion handler + should capture error_code values to a variable. +

+
+

+ partial_redirect_error [constructor] +

+ 		+

+ Constructor that specifies the variable used to capture error_code + values. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ec_ +

+ 		+
+

+ May also be used directly as a completion token, in which case it adapts + the asynchronous operation's default completion token (or deferred if no default is available). +

+
+ + Requirements +
+

+ Header: asio/redirect_error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/ec_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/ec_.html new file mode 100644 index 0000000..15f31be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/ec_.html @@ -0,0 +1,40 @@ + + + +partial_redirect_error::ec_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
asio::error_code & ec_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/operator_lp__rp_.html new file mode 100644 index 0000000..b273ef5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/operator_lp__rp_.html @@ -0,0 +1,47 @@ + + + +partial_redirect_error::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Adapt + a completion token + to specify that the completion handler should capture error_code values + to a variable. +

+
template<
+    typename CompletionToken>
+constexpr redirect_error_t< decay_t< CompletionToken > > operator()(
+    CompletionToken && completion_token) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/partial_redirect_error.html b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/partial_redirect_error.html new file mode 100644 index 0000000..539ae75 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/partial_redirect_error/partial_redirect_error.html @@ -0,0 +1,43 @@ + + + +partial_redirect_error::partial_redirect_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor + that specifies the variable used to capture error_code values. +

+
partial_redirect_error(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/placeholders__bytes_transferred.html b/Packages/asio-1.36.0/doc/asio/reference/placeholders__bytes_transferred.html new file mode 100644 index 0000000..e7175d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/placeholders__bytes_transferred.html @@ -0,0 +1,55 @@ + + + +placeholders::bytes_transferred + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An argument placeholder, for use with std::bind() or boost::bind(), that + corresponds to the bytes_transferred argument of a handler for asynchronous + functions such as asio::basic_stream_socket::async_write_some or async_write. +

+
unspecified bytes_transferred;
+
+
+ + Requirements +
+

+ Header: asio/placeholders.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/placeholders__endpoint.html b/Packages/asio-1.36.0/doc/asio/reference/placeholders__endpoint.html new file mode 100644 index 0000000..e794bac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/placeholders__endpoint.html @@ -0,0 +1,55 @@ + + + +placeholders::endpoint + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An argument placeholder, for use with std::bind() or boost::bind(), that + corresponds to the results argument of a handler for asynchronous functions + such as async_connect. +

+
unspecified endpoint;
+
+
+ + Requirements +
+

+ Header: asio/placeholders.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/placeholders__error.html b/Packages/asio-1.36.0/doc/asio/reference/placeholders__error.html new file mode 100644 index 0000000..a978cfa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/placeholders__error.html @@ -0,0 +1,55 @@ + + + +placeholders::error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An argument placeholder, for use with std::bind() or boost::bind(), that + corresponds to the error argument of a handler for any of the asynchronous + functions. +

+
unspecified error;
+
+
+ + Requirements +
+

+ Header: asio/placeholders.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/placeholders__iterator.html b/Packages/asio-1.36.0/doc/asio/reference/placeholders__iterator.html new file mode 100644 index 0000000..515d8c4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/placeholders__iterator.html @@ -0,0 +1,55 @@ + + + +placeholders::iterator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An argument placeholder, for use with std::bind() or boost::bind(), that + corresponds to the iterator argument of a handler for asynchronous functions + such as async_connect. +

+
unspecified iterator;
+
+
+ + Requirements +
+

+ Header: asio/placeholders.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/placeholders__results.html b/Packages/asio-1.36.0/doc/asio/reference/placeholders__results.html new file mode 100644 index 0000000..ba5834f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/placeholders__results.html @@ -0,0 +1,55 @@ + + + +placeholders::results + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An argument placeholder, for use with std::bind() or boost::bind(), that + corresponds to the results argument of a handler for asynchronous functions + such as asio::basic_resolver::async_resolve. +

+
unspecified results;
+
+
+ + Requirements +
+

+ Header: asio/placeholders.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/placeholders__signal_number.html b/Packages/asio-1.36.0/doc/asio/reference/placeholders__signal_number.html new file mode 100644 index 0000000..c5d605a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/placeholders__signal_number.html @@ -0,0 +1,55 @@ + + + +placeholders::signal_number + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An argument placeholder, for use with std::bind() or boost::bind(), that + corresponds to the signal_number argument of a handler for asynchronous functions + such as asio::signal_set::async_wait. +

+
unspecified signal_number;
+
+
+ + Requirements +
+

+ Header: asio/placeholders.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor.html new file mode 100644 index 0000000..2b75672 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor.html @@ -0,0 +1,417 @@ + + + +posix::basic_descriptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides POSIX descriptor functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_descriptor :
+  public posix::descriptor_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_descriptor [constructor] +

+ 		+

+ Construct a descriptor without opening it.
—
Construct + a descriptor on an existing native descriptor.
—
Move-construct + a descriptor from another.
—
Move-construct a basic_descriptor + from a descriptor of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a descriptor from another.
—
Move-assign + a basic_descriptor from a descriptor of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_descriptor [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The posix::basic_descriptor class template + provides the ability to wrap a POSIX descriptor. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/posix/basic_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/_basic_descriptor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/_basic_descriptor.html new file mode 100644 index 0000000..ff1905b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/_basic_descriptor.html @@ -0,0 +1,46 @@ + + + +posix::basic_descriptor::~basic_descriptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~basic_descriptor();
+
+

+ This function destroys the descriptor, cancelling any outstanding asynchronous + wait operations associated with the descriptor as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign.html new file mode 100644 index 0000000..6b4c2a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign.html @@ -0,0 +1,49 @@ + + + +posix::basic_descriptor::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native descriptor to the descriptor. +

+
void assign(
+    const native_handle_type & native_descriptor);
+  » more...
+
+void assign(
+    const native_handle_type & native_descriptor,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign/overload1.html new file mode 100644 index 0000000..9e143e3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign/overload1.html @@ -0,0 +1,42 @@ + + + +posix::basic_descriptor::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native descriptor to the descriptor. +

+
void assign(
+    const native_handle_type & native_descriptor);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign/overload2.html new file mode 100644 index 0000000..12dfd8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/assign/overload2.html @@ -0,0 +1,43 @@ + + + +posix::basic_descriptor::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native descriptor to the descriptor. +

+
void assign(
+    const native_handle_type & native_descriptor,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/async_wait.html new file mode 100644 index 0000000..e98b617 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/async_wait.html @@ -0,0 +1,136 @@ + + + +posix::basic_descriptor::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + wait for the descriptor to become ready to read, ready to write, or to + have pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for a descriptor + to enter a ready to read, write or error condition state. It is an initiating + function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired descriptor state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::posix::stream_descriptor descriptor(my_context);
+...
+descriptor.async_wait(
+    asio::posix::stream_descriptor::wait_read,
+    wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor.html new file mode 100644 index 0000000..214d1e7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor.html @@ -0,0 +1,85 @@ + + + +posix::basic_descriptor::basic_descriptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a descriptor without opening it. +

+
explicit basic_descriptor(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_descriptor(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a descriptor on an existing native descriptor. +

+
basic_descriptor(
+    const executor_type & ex,
+    const native_handle_type & native_descriptor);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_descriptor(
+    ExecutionContext & context,
+    const native_handle_type & native_descriptor,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a descriptor from another. +

+
basic_descriptor(
+    basic_descriptor && other);
+  » more...
+
+

+ Move-construct a posix::basic_descriptor from a descriptor + of another executor type. +

+
template<
+    typename Executor1>
+basic_descriptor(
+    basic_descriptor< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload1.html new file mode 100644 index 0000000..604562c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload1.html @@ -0,0 +1,59 @@ + + + +posix::basic_descriptor::basic_descriptor (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a descriptor without opening it. +

+
basic_descriptor(
+    const executor_type & ex);
+
+

+ This constructor creates a descriptor without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the descriptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the descriptor. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload2.html new file mode 100644 index 0000000..39c545b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload2.html @@ -0,0 +1,63 @@ + + + +posix::basic_descriptor::basic_descriptor (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a descriptor without opening it. +

+
template<
+    typename ExecutionContext>
+basic_descriptor(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a descriptor without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the descriptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the descriptor. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload3.html new file mode 100644 index 0000000..394cb2b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload3.html @@ -0,0 +1,78 @@ + + + +posix::basic_descriptor::basic_descriptor (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a descriptor on an existing native descriptor. +

+
basic_descriptor(
+    const executor_type & ex,
+    const native_handle_type & native_descriptor);
+
+

+ This constructor creates a descriptor object to hold an existing native + descriptor. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the descriptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the descriptor. +

+
native_descriptor
+

+ A native descriptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload4.html new file mode 100644 index 0000000..f26d8b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload4.html @@ -0,0 +1,82 @@ + + + +posix::basic_descriptor::basic_descriptor (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a descriptor on an existing native descriptor. +

+
template<
+    typename ExecutionContext>
+basic_descriptor(
+    ExecutionContext & context,
+    const native_handle_type & native_descriptor,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a descriptor object to hold an existing native + descriptor. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the descriptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the descriptor. +

+
native_descriptor
+

+ A native descriptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload5.html new file mode 100644 index 0000000..689b689 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload5.html @@ -0,0 +1,67 @@ + + + +posix::basic_descriptor::basic_descriptor (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a descriptor from another. +

+
basic_descriptor(
+    basic_descriptor && other);
+
+

+ This constructor moves a descriptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other descriptor object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload6.html new file mode 100644 index 0000000..6c4ba0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/basic_descriptor/overload6.html @@ -0,0 +1,72 @@ + + + +posix::basic_descriptor::basic_descriptor (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a posix::basic_descriptor from a descriptor + of another executor type. +

+
template<
+    typename Executor1>
+basic_descriptor(
+    basic_descriptor< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a descriptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other posix::basic_descriptor object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/bytes_readable.html new file mode 100644 index 0000000..2cd2231 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/bytes_readable.html @@ -0,0 +1,68 @@ + + + +posix::basic_descriptor::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::descriptor_base. +

+

+ +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. +

+
+ + Example +
+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::descriptor_base::bytes_readable command(true);
+descriptor.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/posix/basic_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel.html new file mode 100644 index 0000000..557cfb7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel.html @@ -0,0 +1,47 @@ + + + +posix::basic_descriptor::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the descriptor. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel/overload1.html new file mode 100644 index 0000000..443cb52 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel/overload1.html @@ -0,0 +1,59 @@ + + + +posix::basic_descriptor::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the descriptor. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel/overload2.html new file mode 100644 index 0000000..cc4f456 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/cancel/overload2.html @@ -0,0 +1,60 @@ + + + +posix::basic_descriptor::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the descriptor. +

+
void cancel(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close.html new file mode 100644 index 0000000..2c3c062 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close.html @@ -0,0 +1,47 @@ + + + +posix::basic_descriptor::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the descriptor. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close/overload1.html new file mode 100644 index 0000000..c17ff86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close/overload1.html @@ -0,0 +1,60 @@ + + + +posix::basic_descriptor::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the descriptor. +

+
void close();
+
+

+ This function is used to close the descriptor. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close/overload2.html new file mode 100644 index 0000000..e79154c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/close/overload2.html @@ -0,0 +1,61 @@ + + + +posix::basic_descriptor::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the descriptor. +

+
void close(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/executor_type.html new file mode 100644 index 0000000..5873081 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/executor_type.html @@ -0,0 +1,52 @@ + + + +posix::basic_descriptor::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/posix/basic_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/get_executor.html new file mode 100644 index 0000000..62a85f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/get_executor.html @@ -0,0 +1,42 @@ + + + +posix::basic_descriptor::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control.html new file mode 100644 index 0000000..5f308de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control.html @@ -0,0 +1,53 @@ + + + +posix::basic_descriptor::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + an IO control command on the descriptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control/overload1.html new file mode 100644 index 0000000..e228eed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control/overload1.html @@ -0,0 +1,86 @@ + + + +posix::basic_descriptor::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform an IO control command on the descriptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the descriptor. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the descriptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::posix::stream_descriptor::bytes_readable command;
+descriptor.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control/overload2.html new file mode 100644 index 0000000..96306aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/io_control/overload2.html @@ -0,0 +1,83 @@ + + + +posix::basic_descriptor::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform an IO control command on the descriptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the descriptor. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the descriptor. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::posix::stream_descriptor::bytes_readable command;
+asio::error_code ec;
+descriptor.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/is_open.html new file mode 100644 index 0000000..9efb715 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/is_open.html @@ -0,0 +1,42 @@ + + + +posix::basic_descriptor::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the descriptor is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer.html new file mode 100644 index 0000000..2fec1db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer.html @@ -0,0 +1,49 @@ + + + +posix::basic_descriptor::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer/overload1.html new file mode 100644 index 0000000..90750f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer/overload1.html @@ -0,0 +1,55 @@ + + + +posix::basic_descriptor::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 descriptor cannot contain any further layers, it simply returns + a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer/overload2.html new file mode 100644 index 0000000..613cfab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer/overload2.html @@ -0,0 +1,55 @@ + + + +posix::basic_descriptor::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a descriptor cannot contain any further layers, it simply + returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer_type.html new file mode 100644 index 0000000..2883cf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/lowest_layer_type.html @@ -0,0 +1,414 @@ + + + +posix::basic_descriptor::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +A + descriptor is always the lowest layer. +

+
typedef basic_descriptor lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_descriptor [constructor] +

+ 		+

+ Construct a descriptor without opening it.
—
Construct + a descriptor on an existing native descriptor.
—
+ Move-construct a descriptor from another.
—
Move-construct + a basic_descriptor from a descriptor of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a descriptor from another.
—
Move-assign + a basic_descriptor from a descriptor of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_descriptor [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The posix::basic_descriptor class template + provides the ability to wrap a POSIX descriptor. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/posix/basic_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_handle.html new file mode 100644 index 0000000..71137bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_handle.html @@ -0,0 +1,47 @@ + + + +posix::basic_descriptor::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_handle_type.html new file mode 100644 index 0000000..359522f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_handle_type.html @@ -0,0 +1,52 @@ + + + +posix::basic_descriptor::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a descriptor. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/posix/basic_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking.html new file mode 100644 index 0000000..932892c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +posix::basic_descriptor::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native descriptor implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native descriptor implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload1.html new file mode 100644 index 0000000..1d76d1a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload1.html @@ -0,0 +1,65 @@ + + + +posix::basic_descriptor::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Gets the non-blocking mode of the native descriptor implementation. +

+
bool native_non_blocking() const;
+
+

+ 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. +

+
+ + Return + Value +
+

+ true if the underlying descriptor + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload2.html new file mode 100644 index 0000000..ec876ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload2.html @@ -0,0 +1,80 @@ + + + +posix::basic_descriptor::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the native descriptor implementation. +

+
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. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + descriptor is put into non-blocking mode and direct system calls + may fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload3.html new file mode 100644 index 0000000..84dd5a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/native_non_blocking/overload3.html @@ -0,0 +1,71 @@ + + + +posix::basic_descriptor::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the native descriptor implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + descriptor is put into non-blocking mode and direct system calls + may fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking.html new file mode 100644 index 0000000..c843e6b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking.html @@ -0,0 +1,55 @@ + + + +posix::basic_descriptor::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the descriptor. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the descriptor. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload1.html new file mode 100644 index 0000000..79146e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload1.html @@ -0,0 +1,61 @@ + + + +posix::basic_descriptor::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Gets the non-blocking mode of the descriptor. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the descriptor's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload2.html new file mode 100644 index 0000000..bec846b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload2.html @@ -0,0 +1,80 @@ + + + +posix::basic_descriptor::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the descriptor. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the descriptor's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload3.html new file mode 100644 index 0000000..50dd49c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/non_blocking/overload3.html @@ -0,0 +1,72 @@ + + + +posix::basic_descriptor::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Sets the non-blocking mode of the descriptor. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the descriptor's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_.html new file mode 100644 index 0000000..d6c9e33 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_.html @@ -0,0 +1,54 @@ + + + +posix::basic_descriptor::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a descriptor from another. +

+
basic_descriptor & operator=(
+    basic_descriptor && other);
+  » more...
+
+

+ Move-assign a posix::basic_descriptor from a descriptor + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_descriptor & > operator=(
+    basic_descriptor< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_/overload1.html new file mode 100644 index 0000000..bffdd5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_/overload1.html @@ -0,0 +1,67 @@ + + + +posix::basic_descriptor::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a descriptor from another. +

+
basic_descriptor & operator=(
+    basic_descriptor && other);
+
+

+ This assignment operator moves a descriptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other descriptor object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_/overload2.html new file mode 100644 index 0000000..0e0b934 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +posix::basic_descriptor::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a posix::basic_descriptor from a descriptor + of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_descriptor & > operator=(
+    basic_descriptor< Executor1 > && other);
+
+

+ This assignment operator moves a descriptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other posix::basic_descriptor object + from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/release.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/release.html new file mode 100644 index 0000000..7ed0ee4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/release.html @@ -0,0 +1,51 @@ + + + +posix::basic_descriptor::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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 asio::error::operation_aborted error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait.html new file mode 100644 index 0000000..3af8972 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait.html @@ -0,0 +1,50 @@ + + + +posix::basic_descriptor::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait + for the descriptor to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait/overload1.html new file mode 100644 index 0000000..863d743 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait/overload1.html @@ -0,0 +1,71 @@ + + + +posix::basic_descriptor::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for the descriptor to become ready to read, ready to write, or to + have pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for a descriptor to + enter a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired descriptor state. +

+
+
+
+ + Example +
+

+ Waiting for a descriptor to become readable. +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+descriptor.wait(asio::posix::stream_descriptor::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait/overload2.html new file mode 100644 index 0000000..3b12df6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait/overload2.html @@ -0,0 +1,77 @@ + + + +posix::basic_descriptor::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wait for the descriptor to become ready to read, ready to write, or to + have pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for a descriptor to + enter a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired descriptor state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for a descriptor to become readable. +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::error_code ec;
+descriptor.wait(asio::posix::stream_descriptor::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait_type.html new file mode 100644 index 0000000..dbaf285 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor/wait_type.html @@ -0,0 +1,74 @@ + + + +posix::basic_descriptor::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::descriptor_base. +

+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a descriptor to become ready to read. +

+
wait_write
+

+ Wait for a descriptor to become ready to write. +

+
wait_error
+

+ Wait for a descriptor to have error conditions pending. +

+
+
+

+ For use with descriptor::wait() and descriptor::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor__rebind_executor.html new file mode 100644 index 0000000..a56883e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor__rebind_executor.html @@ -0,0 +1,89 @@ + + + +posix::basic_descriptor::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the descriptor type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The descriptor type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/posix/basic_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor__rebind_executor/other.html new file mode 100644 index 0000000..f032413 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_descriptor__rebind_executor/other.html @@ -0,0 +1,414 @@ + + + +posix::basic_descriptor::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + descriptor type when rebound to the specified executor. +

+
typedef basic_descriptor< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_descriptor [constructor] +

+ 		+

+ Construct a descriptor without opening it.
—
Construct + a descriptor on an existing native descriptor.
—
+ Move-construct a descriptor from another.
—
Move-construct + a basic_descriptor from a descriptor of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a descriptor from another.
—
Move-assign + a basic_descriptor from a descriptor of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_descriptor [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The posix::basic_descriptor class template + provides the ability to wrap a POSIX descriptor. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/posix/basic_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor.html new file mode 100644 index 0000000..7bbedd8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor.html @@ -0,0 +1,442 @@ + + + +posix::basic_stream_descriptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides stream-oriented descriptor functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_stream_descriptor :
+  public posix::basic_descriptor< any_io_executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_descriptor [constructor] +

+ 		+

+ Construct a stream descriptor without opening it.
—
+ Construct a stream descriptor on an existing native descriptor. +
—
Move-construct a stream descriptor from another. +
—
Move-construct a basic_stream_descriptor from a descriptor + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a stream descriptor from another.
—
Move-assign + a basic_stream_descriptor from a descriptor of another executor + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the descriptor. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the descriptor. +

+
+

+ The posix::basic_stream_descriptor class template + provides asynchronous and blocking stream-oriented descriptor functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous read_some and + write_some operations are + thread safe with respect to each other, if the underlying operating system + calls are also thread safe. This means that it is permitted to perform concurrent + calls to these synchronous operations on a single descriptor object. Other + synchronous operations, such as close, + are not thread safe. +

+
+ + Requirements +
+

+ Header: asio/posix/basic_stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign.html new file mode 100644 index 0000000..86feb4c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign.html @@ -0,0 +1,49 @@ + + + +posix::basic_stream_descriptor::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native descriptor to the descriptor. +

+
void assign(
+    const native_handle_type & native_descriptor);
+  » more...
+
+void assign(
+    const native_handle_type & native_descriptor,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign/overload1.html new file mode 100644 index 0000000..97de77d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign/overload1.html @@ -0,0 +1,45 @@ + + + +posix::basic_stream_descriptor::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Assign an existing native descriptor to the descriptor. +

+
void assign(
+    const native_handle_type & native_descriptor);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign/overload2.html new file mode 100644 index 0000000..563d8de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/assign/overload2.html @@ -0,0 +1,46 @@ + + + +posix::basic_stream_descriptor::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Assign an existing native descriptor to the descriptor. +

+
void assign(
+    const native_handle_type & native_descriptor,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_read_some.html new file mode 100644 index 0000000..0b972a0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_read_some.html @@ -0,0 +1,143 @@ + + + +posix::basic_stream_descriptor::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the stream descriptor. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
descriptor.async_read_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_wait.html new file mode 100644 index 0000000..baf819e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_wait.html @@ -0,0 +1,139 @@ + + + +posix::basic_stream_descriptor::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ +Asynchronously + wait for the descriptor to become ready to read, ready to write, or to + have pending error conditions. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    wait_type w,
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to perform an asynchronous wait for a descriptor + to enter a ready to read, write or error condition state. It is an initiating + function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired descriptor state. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Example +
+
void wait_handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Wait succeeded.
+  }
+}
+
+...
+
+asio::posix::stream_descriptor descriptor(my_context);
+...
+descriptor.async_wait(
+    asio::posix::stream_descriptor::wait_read,
+    wait_handler);
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_write_some.html new file mode 100644 index 0000000..72931c8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/async_write_some.html @@ -0,0 +1,143 @@ + + + +posix::basic_stream_descriptor::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the stream descriptor. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
descriptor.async_write_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor.html new file mode 100644 index 0000000..c1abb47 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor.html @@ -0,0 +1,85 @@ + + + +posix::basic_stream_descriptor::basic_stream_descriptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a stream descriptor without opening it. +

+
explicit basic_stream_descriptor(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_stream_descriptor(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a stream descriptor on an existing native descriptor. +

+
basic_stream_descriptor(
+    const executor_type & ex,
+    const native_handle_type & native_descriptor);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_descriptor(
+    ExecutionContext & context,
+    const native_handle_type & native_descriptor,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a stream descriptor from another. +

+
basic_stream_descriptor(
+    basic_stream_descriptor && other);
+  » more...
+
+

+ Move-construct a posix::basic_stream_descriptor from a + descriptor of another executor type. +

+
template<
+    typename Executor1>
+basic_stream_descriptor(
+    basic_stream_descriptor< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload1.html new file mode 100644 index 0000000..6d3896c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload1.html @@ -0,0 +1,61 @@ + + + +posix::basic_stream_descriptor::basic_stream_descriptor (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream descriptor without opening it. +

+
basic_stream_descriptor(
+    const executor_type & ex);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the descriptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the descriptor. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload2.html new file mode 100644 index 0000000..4e6b7d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload2.html @@ -0,0 +1,65 @@ + + + +posix::basic_stream_descriptor::basic_stream_descriptor (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream descriptor without opening it. +

+
template<
+    typename ExecutionContext>
+basic_stream_descriptor(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the descriptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the descriptor. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload3.html new file mode 100644 index 0000000..726db30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload3.html @@ -0,0 +1,78 @@ + + + +posix::basic_stream_descriptor::basic_stream_descriptor (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream descriptor on an existing native descriptor. +

+
basic_stream_descriptor(
+    const executor_type & ex,
+    const native_handle_type & native_descriptor);
+
+

+ This constructor creates a stream descriptor object to hold an existing + native descriptor. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the descriptor will use, by default, to dispatch + handlers for any asynchronous operations performed on the descriptor. +

+
native_descriptor
+

+ The new underlying descriptor implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload4.html new file mode 100644 index 0000000..a1cf267 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload4.html @@ -0,0 +1,82 @@ + + + +posix::basic_stream_descriptor::basic_stream_descriptor (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream descriptor on an existing native descriptor. +

+
template<
+    typename ExecutionContext>
+basic_stream_descriptor(
+    ExecutionContext & context,
+    const native_handle_type & native_descriptor,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a stream descriptor object to hold an existing + native descriptor. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the descriptor + will use, by default, to dispatch handlers for any asynchronous + operations performed on the descriptor. +

+
native_descriptor
+

+ The new underlying descriptor implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload5.html new file mode 100644 index 0000000..952b59f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload5.html @@ -0,0 +1,67 @@ + + + +posix::basic_stream_descriptor::basic_stream_descriptor (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a stream descriptor from another. +

+
basic_stream_descriptor(
+    basic_stream_descriptor && other);
+
+

+ This constructor moves a stream descriptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other stream descriptor object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload6.html new file mode 100644 index 0000000..ca26518 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload6.html @@ -0,0 +1,72 @@ + + + +posix::basic_stream_descriptor::basic_stream_descriptor (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a posix::basic_stream_descriptor from + a descriptor of another executor type. +

+
template<
+    typename Executor1>
+basic_stream_descriptor(
+    basic_stream_descriptor< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a descriptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other posix::basic_stream_descriptor + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/bytes_readable.html new file mode 100644 index 0000000..d6a130d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/bytes_readable.html @@ -0,0 +1,68 @@ + + + +posix::basic_stream_descriptor::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::descriptor_base. +

+

+ +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. +

+
+ + Example +
+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::descriptor_base::bytes_readable command(true);
+descriptor.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/posix/basic_stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel.html new file mode 100644 index 0000000..69e8f23 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel.html @@ -0,0 +1,47 @@ + + + +posix::basic_stream_descriptor::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the descriptor. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel/overload1.html new file mode 100644 index 0000000..88c4a0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel/overload1.html @@ -0,0 +1,62 @@ + + + +posix::basic_stream_descriptor::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Cancel all asynchronous operations associated with the descriptor. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel/overload2.html new file mode 100644 index 0000000..1fffd29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/cancel/overload2.html @@ -0,0 +1,63 @@ + + + +posix::basic_stream_descriptor::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Cancel all asynchronous operations associated with the descriptor. +

+
void cancel(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close.html new file mode 100644 index 0000000..c653d54 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close.html @@ -0,0 +1,47 @@ + + + +posix::basic_stream_descriptor::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the descriptor. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close/overload1.html new file mode 100644 index 0000000..3af017a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close/overload1.html @@ -0,0 +1,63 @@ + + + +posix::basic_stream_descriptor::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Close the descriptor. +

+
void close();
+
+

+ This function is used to close the descriptor. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close/overload2.html new file mode 100644 index 0000000..7335b7f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/close/overload2.html @@ -0,0 +1,64 @@ + + + +posix::basic_stream_descriptor::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Close the descriptor. +

+
void close(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/executor_type.html new file mode 100644 index 0000000..5faedc5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/executor_type.html @@ -0,0 +1,52 @@ + + + +posix::basic_stream_descriptor::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/posix/basic_stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/get_executor.html new file mode 100644 index 0000000..e86b4c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/get_executor.html @@ -0,0 +1,45 @@ + + + +posix::basic_stream_descriptor::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control.html new file mode 100644 index 0000000..5aba094 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control.html @@ -0,0 +1,53 @@ + + + +posix::basic_stream_descriptor::io_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + an IO control command on the descriptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+  » more...
+
+template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control/overload1.html new file mode 100644 index 0000000..4deffa0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control/overload1.html @@ -0,0 +1,89 @@ + + + +posix::basic_stream_descriptor::io_control (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Perform an IO control command on the descriptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command);
+
+

+ This function is used to execute an IO control command on the descriptor. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the descriptor. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::posix::stream_descriptor::bytes_readable command;
+descriptor.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control/overload2.html new file mode 100644 index 0000000..7035a60 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/io_control/overload2.html @@ -0,0 +1,86 @@ + + + +posix::basic_stream_descriptor::io_control (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Perform an IO control command on the descriptor. +

+
template<
+    typename IoControlCommand>
+void io_control(
+    IoControlCommand & command,
+    asio::error_code & ec);
+
+

+ This function is used to execute an IO control command on the descriptor. +

+
+ + Parameters +
+
+

+
+
command
+

+ The IO control command to be performed on the descriptor. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Getting the number of bytes ready to read: +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::posix::stream_descriptor::bytes_readable command;
+asio::error_code ec;
+descriptor.io_control(command, ec);
+if (ec)
+{
+  // An error occurred.
+}
+std::size_t bytes_readable = command.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/is_open.html new file mode 100644 index 0000000..e76a01f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/is_open.html @@ -0,0 +1,45 @@ + + + +posix::basic_stream_descriptor::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ +Determine + whether the descriptor is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer.html new file mode 100644 index 0000000..6a44a9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer.html @@ -0,0 +1,49 @@ + + + +posix::basic_stream_descriptor::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer/overload1.html new file mode 100644 index 0000000..1d628c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer/overload1.html @@ -0,0 +1,58 @@ + + + +posix::basic_stream_descriptor::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ 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 descriptor cannot contain any further layers, it simply returns + a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer/overload2.html new file mode 100644 index 0000000..fcdfe6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer/overload2.html @@ -0,0 +1,58 @@ + + + +posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since a descriptor cannot contain any further layers, it simply + returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer_type.html new file mode 100644 index 0000000..0eaee82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/lowest_layer_type.html @@ -0,0 +1,417 @@ + + + +posix::basic_stream_descriptor::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ +A + descriptor is always the lowest layer. +

+
typedef basic_descriptor lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_descriptor [constructor] +

+ 		+

+ Construct a descriptor without opening it.
—
Construct + a descriptor on an existing native descriptor.
—
+ Move-construct a descriptor from another.
—
Move-construct + a basic_descriptor from a descriptor of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a descriptor from another.
—
Move-assign + a basic_descriptor from a descriptor of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_descriptor [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The posix::basic_descriptor class template + provides the ability to wrap a POSIX descriptor. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/posix/basic_stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_handle.html new file mode 100644 index 0000000..476b5c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_handle.html @@ -0,0 +1,50 @@ + + + +posix::basic_stream_descriptor::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_handle_type.html new file mode 100644 index 0000000..75920f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_handle_type.html @@ -0,0 +1,414 @@ + + + +posix::basic_stream_descriptor::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a descriptor. +

+
typedef basic_descriptor< Executor >::native_handle_type native_handle_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_descriptor [constructor] +

+ 		+

+ Construct a descriptor without opening it.
—
Construct + a descriptor on an existing native descriptor.
—
+ Move-construct a descriptor from another.
—
Move-construct + a basic_descriptor from a descriptor of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a descriptor from another.
—
Move-assign + a basic_descriptor from a descriptor of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_descriptor [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The posix::basic_descriptor class template + provides the ability to wrap a POSIX descriptor. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/posix/basic_stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking.html new file mode 100644 index 0000000..f35d8d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking.html @@ -0,0 +1,55 @@ + + + +posix::basic_stream_descriptor::native_non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the native descriptor implementation. +

+
bool native_non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the native descriptor implementation. +

+
void native_non_blocking(
+    bool mode);
+  » more...
+
+void native_non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload1.html new file mode 100644 index 0000000..e870113 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload1.html @@ -0,0 +1,68 @@ + + + +posix::basic_stream_descriptor::native_non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Gets the non-blocking mode of the native descriptor implementation. +

+
bool native_non_blocking() const;
+
+

+ 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. +

+
+ + Return + Value +
+

+ true if the underlying descriptor + is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system + error). +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload2.html new file mode 100644 index 0000000..65af574 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload2.html @@ -0,0 +1,83 @@ + + + +posix::basic_stream_descriptor::native_non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Sets the non-blocking mode of the native descriptor implementation. +

+
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. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + descriptor is put into non-blocking mode and direct system calls + may fail with asio::error::would_block + (or the equivalent system error). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the mode + is false, but the + current value of non_blocking() is true, + this function fails with asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload3.html new file mode 100644 index 0000000..c05d01c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload3.html @@ -0,0 +1,74 @@ + + + +posix::basic_stream_descriptor::native_non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Sets the non-blocking mode of the native descriptor implementation. +

+
void native_non_blocking(
+    bool mode,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the underlying + descriptor is put into non-blocking mode and direct system calls + may fail with 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 asio::error::invalid_argument, + as the combination does not make sense. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking.html new file mode 100644 index 0000000..3212412 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking.html @@ -0,0 +1,55 @@ + + + +posix::basic_stream_descriptor::non_blocking + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Gets + the non-blocking mode of the descriptor. +

+
bool non_blocking() const;
+  » more...
+
+

+ Sets the non-blocking mode of the descriptor. +

+
void non_blocking(
+    bool mode);
+  » more...
+
+void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload1.html new file mode 100644 index 0000000..73b811c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload1.html @@ -0,0 +1,64 @@ + + + +posix::basic_stream_descriptor::non_blocking (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Gets the non-blocking mode of the descriptor. +

+
bool non_blocking() const;
+
+
+ + Return + Value +
+

+ true if the descriptor's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. If + false, synchronous operations + will block until complete. +

+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload2.html new file mode 100644 index 0000000..ba4cc6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload2.html @@ -0,0 +1,83 @@ + + + +posix::basic_stream_descriptor::non_blocking (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Sets the non-blocking mode of the descriptor. +

+
void non_blocking(
+    bool mode);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the descriptor's + synchronous operations will fail with asio::error::would_block + if they are unable to perform the requested operation immediately. + If false, synchronous + operations will block until complete. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload3.html new file mode 100644 index 0000000..8d94272 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/non_blocking/overload3.html @@ -0,0 +1,75 @@ + + + +posix::basic_stream_descriptor::non_blocking (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Sets the non-blocking mode of the descriptor. +

+
void non_blocking(
+    bool mode,
+    asio::error_code & ec);
+
+
+ + Parameters +
+
+

+
+
mode
+

+ If true, the descriptor's + synchronous operations will fail with 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. +

+
+
+
+ + Remarks +
+

+ The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error asio::error::would_block. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_.html new file mode 100644 index 0000000..4f0f599 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_.html @@ -0,0 +1,54 @@ + + + +posix::basic_stream_descriptor::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a stream descriptor from another. +

+
basic_stream_descriptor & operator=(
+    basic_stream_descriptor && other);
+  » more...
+
+

+ Move-assign a posix::basic_stream_descriptor from a + descriptor of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_stream_descriptor & > operator=(
+    basic_stream_descriptor< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_/overload1.html new file mode 100644 index 0000000..89e3b0a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_/overload1.html @@ -0,0 +1,68 @@ + + + +posix::basic_stream_descriptor::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a stream descriptor from another. +

+
basic_stream_descriptor & operator=(
+    basic_stream_descriptor && other);
+
+

+ This assignment operator moves a stream descriptor from one object to + another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other stream descriptor object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_/overload2.html new file mode 100644 index 0000000..cf8e86f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/operator_eq_/overload2.html @@ -0,0 +1,71 @@ + + + +posix::basic_stream_descriptor::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a posix::basic_stream_descriptor from + a descriptor of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_stream_descriptor & > operator=(
+    basic_stream_descriptor< Executor1 > && other);
+
+

+ This assignment operator moves a descriptor from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other posix::basic_stream_descriptor + object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_descriptor(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some.html new file mode 100644 index 0000000..29609b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some.html @@ -0,0 +1,53 @@ + + + +posix::basic_stream_descriptor::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the descriptor. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some/overload1.html new file mode 100644 index 0000000..1cf57b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some/overload1.html @@ -0,0 +1,108 @@ + + + +posix::basic_stream_descriptor::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the descriptor. +

+
template<
+    typename 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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
descriptor.read_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some/overload2.html new file mode 100644 index 0000000..4707e58 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/read_some/overload2.html @@ -0,0 +1,85 @@ + + + +posix::basic_stream_descriptor::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the descriptor. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/release.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/release.html new file mode 100644 index 0000000..bbfef01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/release.html @@ -0,0 +1,54 @@ + + + +posix::basic_stream_descriptor::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_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 asio::error::operation_aborted error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait.html new file mode 100644 index 0000000..4efa2f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait.html @@ -0,0 +1,50 @@ + + + +posix::basic_stream_descriptor::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait + for the descriptor to become ready to read, ready to write, or to have + pending error conditions. +

+
void wait(
+    wait_type w);
+  » more...
+
+void wait(
+    wait_type w,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait/overload1.html new file mode 100644 index 0000000..1a06776 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait/overload1.html @@ -0,0 +1,74 @@ + + + +posix::basic_stream_descriptor::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Wait for the descriptor to become ready to read, ready to write, or to + have pending error conditions. +

+
void wait(
+    wait_type w);
+
+

+ This function is used to perform a blocking wait for a descriptor to + enter a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired descriptor state. +

+
+
+
+ + Example +
+

+ Waiting for a descriptor to become readable. +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+descriptor.wait(asio::posix::stream_descriptor::wait_read);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait/overload2.html new file mode 100644 index 0000000..4cffefb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait/overload2.html @@ -0,0 +1,80 @@ + + + +posix::basic_stream_descriptor::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::basic_descriptor. +

+

+ Wait for the descriptor to become ready to read, ready to write, or to + have pending error conditions. +

+
void wait(
+    wait_type w,
+    asio::error_code & ec);
+
+

+ This function is used to perform a blocking wait for a descriptor to + enter a ready to read, write or error condition state. +

+
+ + Parameters +
+
+

+
+
w
+

+ Specifies the desired descriptor state. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Example +
+

+ Waiting for a descriptor to become readable. +

+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::error_code ec;
+descriptor.wait(asio::posix::stream_descriptor::wait_read, ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait_type.html new file mode 100644 index 0000000..f531189 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/wait_type.html @@ -0,0 +1,74 @@ + + + +posix::basic_stream_descriptor::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from posix::descriptor_base. +

+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a descriptor to become ready to read. +

+
wait_write
+

+ Wait for a descriptor to become ready to write. +

+
wait_error
+

+ Wait for a descriptor to have error conditions pending. +

+
+
+

+ For use with descriptor::wait() and descriptor::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some.html new file mode 100644 index 0000000..5e3b838 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some.html @@ -0,0 +1,53 @@ + + + +posix::basic_stream_descriptor::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the descriptor. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some/overload1.html new file mode 100644 index 0000000..29958d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some/overload1.html @@ -0,0 +1,107 @@ + + + +posix::basic_stream_descriptor::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the descriptor. +

+
template<
+    typename 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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the descriptor. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
descriptor.write_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some/overload2.html new file mode 100644 index 0000000..a0d0dea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor/write_some/overload2.html @@ -0,0 +1,84 @@ + + + +posix::basic_stream_descriptor::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the descriptor. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the descriptor. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor__rebind_executor.html new file mode 100644 index 0000000..a136aee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor__rebind_executor.html @@ -0,0 +1,89 @@ + + + +posix::basic_stream_descriptor::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the descriptor type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The descriptor type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/posix/basic_stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor__rebind_executor/other.html new file mode 100644 index 0000000..c3fa63a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__basic_stream_descriptor__rebind_executor/other.html @@ -0,0 +1,439 @@ + + + +posix::basic_stream_descriptor::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + descriptor type when rebound to the specified executor. +

+
typedef basic_stream_descriptor< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read + without blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_descriptor [constructor] +

+ 		+

+ Construct a stream descriptor without opening it.
—
+ Construct a stream descriptor on an existing native descriptor. +
—
Move-construct a stream descriptor from another. +
—
Move-construct a basic_stream_descriptor from a + descriptor of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a stream descriptor from another.
—
Move-assign + a basic_stream_descriptor from a descriptor of another executor + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the descriptor. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the descriptor. +

+
+

+ The posix::basic_stream_descriptor class + template provides asynchronous and blocking stream-oriented descriptor + functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous read_some and + write_some operations are + thread safe with respect to each other, if the underlying operating system + calls are also thread safe. This means that it is permitted to perform + concurrent calls to these synchronous operations on a single descriptor + object. Other synchronous operations, such as close, + are not thread safe. +

+
+ + Requirements +
+

+ Header: asio/posix/basic_stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor.html new file mode 100644 index 0000000..41c4b8b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor.html @@ -0,0 +1,415 @@ + + + +posix::descriptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of posix::basic_descriptor. +

+
typedef basic_descriptor descriptor;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ basic_descriptor [constructor] +

+ 		+

+ Construct a descriptor without opening it.
—
Construct + a descriptor on an existing native descriptor.
—
Move-construct + a descriptor from another.
—
Move-construct a basic_descriptor + from a descriptor of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a descriptor from another.
—
Move-assign + a basic_descriptor from a descriptor of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_descriptor [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The posix::basic_descriptor class template + provides the ability to wrap a POSIX descriptor. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/posix/descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base.html b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base.html new file mode 100644 index 0000000..e1b2bb9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base.html @@ -0,0 +1,139 @@ + + + +posix::descriptor_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The posix::descriptor_base + class is used as a base for the descriptor class as a place to define the + associated IO control commands. +

+
class descriptor_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~descriptor_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Requirements +
+

+ Header: asio/posix/descriptor_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/_descriptor_base.html b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/_descriptor_base.html new file mode 100644 index 0000000..f2c0983 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/_descriptor_base.html @@ -0,0 +1,42 @@ + + + +posix::descriptor_base::~descriptor_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~descriptor_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/bytes_readable.html new file mode 100644 index 0000000..dbdb8d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/bytes_readable.html @@ -0,0 +1,65 @@ + + + +posix::descriptor_base::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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. +

+
+ + Example +
+
asio::posix::stream_descriptor descriptor(my_context);
+...
+asio::descriptor_base::bytes_readable command(true);
+descriptor.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/posix/descriptor_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/wait_type.html new file mode 100644 index 0000000..977c90e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__descriptor_base/wait_type.html @@ -0,0 +1,71 @@ + + + +posix::descriptor_base::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait + types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a descriptor to become ready to read. +

+
wait_write
+

+ Wait for a descriptor to become ready to write. +

+
wait_error
+

+ Wait for a descriptor to have error conditions pending. +

+
+
+

+ For use with descriptor::wait() and descriptor::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/posix__stream_descriptor.html b/Packages/asio-1.36.0/doc/asio/reference/posix__stream_descriptor.html new file mode 100644 index 0000000..dd2ecca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/posix__stream_descriptor.html @@ -0,0 +1,438 @@ + + + +posix::stream_descriptor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a stream-oriented descriptor. +

+
typedef basic_stream_descriptor stream_descriptor;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the descriptor type to another executor. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A descriptor is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a descriptor. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native descriptor to the descriptor. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_wait +

+ 		+

+ Asynchronously wait for the descriptor to become ready to read, + ready to write, or to have pending error conditions. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_descriptor [constructor] +

+ 		+

+ Construct a stream descriptor without opening it.
—
+ Construct a stream descriptor on an existing native descriptor. +
—
Move-construct a stream descriptor from another. +
—
Move-construct a basic_stream_descriptor from a descriptor + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the descriptor. +

+
+

+ close +

+ 		+

+ Close the descriptor. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ io_control +

+ 		+

+ Perform an IO control command on the descriptor. +

+
+

+ is_open +

+ 		+

+ Determine whether the descriptor is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native descriptor representation. +

+
+

+ native_non_blocking +

+ 		+

+ Gets the non-blocking mode of the native descriptor implementation. +
—
Sets the non-blocking mode of the native descriptor + implementation. +

+
+

+ non_blocking +

+ 		+

+ Gets the non-blocking mode of the descriptor.
—
Sets + the non-blocking mode of the descriptor. +

+
+

+ operator= +

+ 		+

+ Move-assign a stream descriptor from another.
—
Move-assign + a basic_stream_descriptor from a descriptor of another executor + type. +

+
+

+ read_some +

+ 		+

+ Read some data from the descriptor. +

+
+

+ release +

+ 		+

+ Release ownership of the native descriptor implementation. +

+
+

+ wait +

+ 		+

+ Wait for the descriptor to become ready to read, ready to write, + or to have pending error conditions. +

+
+

+ write_some +

+ 		+

+ Write some data to the descriptor. +

+
+

+ The posix::basic_stream_descriptor class template + provides asynchronous and blocking stream-oriented descriptor functionality. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous read_some and + write_some operations are + thread safe with respect to each other, if the underlying operating system + calls are also thread safe. This means that it is permitted to perform concurrent + calls to these synchronous operations on a single descriptor object. Other + synchronous operations, such as close, + are not thread safe. +

+
+ + Requirements +
+

+ Header: asio/posix/stream_descriptor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/post.html b/Packages/asio-1.36.0/doc/asio/reference/post.html new file mode 100644 index 0000000..0d73117 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/post.html @@ -0,0 +1,75 @@ + + + +post + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+post +

+

+ +

+

+ Submits a completion token or function object for execution. +

+
template<
+    typename NullaryToken>
+auto post(
+    NullaryToken && token);
+  » more...
+
+template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+auto post(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t<(execution::is_executor< Executor >::value &&can_require< Executor, execution::blocking_t::never_t >::value)||is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+auto post(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/post.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/post/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/post/overload1.html new file mode 100644 index 0000000..1580926 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/post/overload1.html @@ -0,0 +1,138 @@ + + + +post (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename NullaryToken>
+auto post(
+    NullaryToken && token);
+
+

+ This function submits an object for execution using the object's associated + executor. The function object is queued for execution, and is never called + from the current thread prior to returning from post(). +

+

+ The use of post(), + rather than defer, + indicates the caller's preference that the function object be eagerly queued + for execution. +

+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ This function returns async_initiate<NullaryToken, void()>(Init{}, token), + where Init is a function + object type defined as: +

+
class Init
+{
+public:
+  template <typename CompletionHandler>
+    void operator()(CompletionHandler&& completion_handler) const;
+};
+
+

+ The function call operator of Init: +

+
    +
  • +

    + Obtains the handler's associated executor object ex + of type Ex by performing +

    +

    + auto ex = get_associated_executor(handler); +

    +
    • +
  • +

    + Obtains the handler's associated allocator object alloc + by performing +

    +

    + auto alloc = get_associated_allocator(handler); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is true, performs +

    +

    + prefer( require(ex, execution::blocking.never), execution::relationship.fork, + execution::allocator(alloc) ).execute(std::forward<CompletionHandler>(completion_handler)); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is false, performs +

    +

    + ex.post( std::forward<CompletionHandler>(completion_handler), + alloc); +

    +
    • +
+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/post/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/post/overload2.html new file mode 100644 index 0000000..ec34b8d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/post/overload2.html @@ -0,0 +1,177 @@ + + + +post (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename Executor,
+    typename NullaryToken = default_completion_token_t<Executor>>
+auto post(
+    const Executor & ex,
+    NullaryToken && token = default_completion_token_t< Executor >(),
+    constraint_t<(execution::is_executor< Executor >::value &&can_require< Executor, execution::blocking_t::never_t >::value)||is_executor< Executor >::value >  = 0);
+
+

+ This function submits an object for execution using the specified executor. + The function object is queued for execution, and is never called from the + current thread prior to returning from post(). +

+

+ The use of post(), + rather than defer, + indicates the caller's preference that the function object be eagerly queued + for execution. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The target executor. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ This function returns async_initiate<NullaryToken, void()>(Init{ex}, token), + where Init is a function + object type defined as: +

+
class Init
+{
+public:
+  using executor_type = Executor;
+  explicit Init(const Executor& ex) : ex_(ex) {}
+  executor_type get_executor() const noexcept { return ex_; }
+  template <typename CompletionHandler>
+    void operator()(CompletionHandler&& completion_handler) const;
+private:
+  Executor ex_; // exposition only
+};
+
+

+ The function call operator of Init: +

+
    +
  • +

    + Obtains the handler's associated executor object ex1 + of type Ex1 by performing +

    +

    + auto ex1 = get_associated_executor(handler, ex); +

    +
    • +
  • +

    + Obtains the handler's associated allocator object alloc + by performing +

    +

    + auto alloc = get_associated_allocator(handler); +

    +
    • +
  • +

    + If execution::is_executor<Ex1>::value is true, constructs a function + object f with a member + executor_ that is initialised + with prefer(ex1, execution::outstanding_work.tracked), + a member handler_ that + is a decay-copy of completion_handler, + and a function call operator that performs: +

    +

    + auto a = get_associated_allocator(handler_); prefer(executor_, execution::allocator(a)).execute(std::move(handler_)); +

    +
    • +
  • +

    + If execution::is_executor<Ex1>::value is false, constructs a function + object f with a member + work_ that is initialised + with make_work_guard(ex1), a member handler_ + that is a decay-copy of completion_handler, + and a function call operator that performs: +

    +

    + auto a = get_associated_allocator(handler_); work_.get_executor().dispatch(std::move(handler_), + a); work_.reset(); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is true, performs +

    +

    + prefer( require(ex, execution::blocking.never), execution::relationship.fork, + execution::allocator(alloc) ).execute(std::move(f)); +

    +
    • +
  • +

    + If execution::is_executor<Ex>::value is false, performs +

    +

    + ex.post(std::move(f), alloc); +

    +
    • +
+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/post/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/post/overload3.html new file mode 100644 index 0000000..3cf42fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/post/overload3.html @@ -0,0 +1,85 @@ + + + +post (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Submits a completion token or function object for execution. +

+
template<
+    typename ExecutionContext,
+    typename NullaryToken = default_completion_token_t<typename ExecutionContext::executor_type>>
+auto post(
+    ExecutionContext & ctx,
+    NullaryToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+ + Parameters +
+
+

+
+
ctx
+

+ An execution context, from which the target executor is obtained. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler. The + function signature of the completion handler must be: +

+
void handler();
+
+
+
+
+
+ + Return + Value +
+

+ post(ctx.get_executor(), + forward<NullaryToken>(token)). +

+
+ + Completion + Signature +
+
void()
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prefer.html b/Packages/asio-1.36.0/doc/asio/reference/prefer.html new file mode 100644 index 0000000..7e56ce3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prefer.html @@ -0,0 +1,119 @@ + + + +prefer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+prefer +

+

+ +

+

+ A customisation point that attempts to apply a property to an object. +

+
constexpr unspecified prefer = unspecified;
+
+

+ The name prefer denotes a + customisation point object. The expression asio::prefer(E, + P0, Pn...) + for some subexpressions E + and P0, and where Pn... represents + N subexpressions (where + N is 0 or more, and with + types T = + decay_t<decltype(E)> + and Prop0 = + decay_t<decltype(P0)>) + is expression-equivalent to: +

+
    +
  • + If is_applicable_property_v<T, Prop0> && + Prop0::is_preferable is not a well-formed + constant expression with value true, + asio::prefer(E, P0, Pn...) + is ill-formed. +
    • +
  • + Otherwise, E if N == 0 and the expression Prop0::template static_query_v<T> == Prop0::value() is a well-formed constant expression + with value true. +
    • +
  • + Otherwise, (E).require(P0) if N + == 0 + and the expression (E).require(P0) is a valid expression. +
    • +
  • + Otherwise, require(E, P0) + if N == + 0 and the expression require(E, P0) + is a valid expression with overload resolution performed in a context + that does not include the declaration of the require + customization point object. +
    • +
  • + Otherwise, (E).prefer(P0) if N + == 0 + and the expression (E).prefer(P0) is a valid expression. +
    • +
  • + Otherwise, prefer(E, P0) + if N == + 0 and the expression prefer(E, P0) + is a valid expression with overload resolution performed in a context + that does not include the declaration of the prefer + customization point object. +
    • +
  • + Otherwise, E if N == 0. +
    • +
  • + Otherwise, asio::prefer(asio::prefer(E, P0), Pn...) + if N > + 0 and the expression asio::prefer(asio::prefer(E, P0), Pn...) + is a valid expression. +
    • +
  • + Otherwise, asio::prefer(E, P0, Pn...) + is ill-formed. +
    • +
+
+ + Requirements +
+

+ Header: asio/prefer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prefer_result.html b/Packages/asio-1.36.0/doc/asio/reference/prefer_result.html new file mode 100644 index 0000000..98b0b95 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prefer_result.html @@ -0,0 +1,96 @@ + + + +prefer_result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines the result type of a prefer + expression. +

+
template<
+    typename T,
+    typename... Properties>
+struct prefer_result
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ The result of the prefer expression. +

+
+

+ Class template prefer_result + is a trait that determines the result type of the expression asio::prefer(std::declval<T>(), + std::declval<Properties>()...). +

+
+ + Requirements +
+

+ Header: asio/prefer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prefer_result/type.html b/Packages/asio-1.36.0/doc/asio/reference/prefer_result/type.html new file mode 100644 index 0000000..6e52e20 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prefer_result/type.html @@ -0,0 +1,51 @@ + + + +prefer_result::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The result of the prefer expression. +

+
typedef automatically_determined type;
+
+
+ + Requirements +
+

+ Header: asio/prefer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prepend.html b/Packages/asio-1.36.0/doc/asio/reference/prepend.html new file mode 100644 index 0000000..96fb3b5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prepend.html @@ -0,0 +1,59 @@ + + + +prepend + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Completion token type used to specify that the completion handler arguments + should be passed additional values before the results of the operation. +

+
template<
+    typename CompletionToken,
+    typename... Values>
+constexpr prepend_t< decay_t< CompletionToken >, decay_t< Values >... > prepend(
+    CompletionToken && completion_token,
+    Values &&... values);
+
+
+ + Requirements +
+

+ Header: asio/prepend.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prepend_t.html b/Packages/asio-1.36.0/doc/asio/reference/prepend_t.html new file mode 100644 index 0000000..9a2f3ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prepend_t.html @@ -0,0 +1,136 @@ + + + +prepend_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Completion token type used to specify that the completion handler arguments + should be passed additional values before the results of the operation. +

+
template<
+    typename CompletionToken,
+    typename... Values>
+class prepend_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ prepend_t + [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ token_ +

+ 		+
+

+ values_ +

+ 		+
+
+ + Requirements +
+

+ Header: asio/prepend.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prepend_t/prepend_t.html b/Packages/asio-1.36.0/doc/asio/reference/prepend_t/prepend_t.html new file mode 100644 index 0000000..b262870 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prepend_t/prepend_t.html @@ -0,0 +1,46 @@ + + + +prepend_t::prepend_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T,
+    typename... V>
+constexpr prepend_t(
+    T && completion_token,
+    V &&... values);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prepend_t/token_.html b/Packages/asio-1.36.0/doc/asio/reference/prepend_t/token_.html new file mode 100644 index 0000000..6826ded --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prepend_t/token_.html @@ -0,0 +1,40 @@ + + + +prepend_t::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/prepend_t/values_.html b/Packages/asio-1.36.0/doc/asio/reference/prepend_t/values_.html new file mode 100644 index 0000000..22d74d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/prepend_t/values_.html @@ -0,0 +1,40 @@ + + + +prepend_t::values_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
std::tuple< Values... > values_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/query.html b/Packages/asio-1.36.0/doc/asio/reference/query.html new file mode 100644 index 0000000..c92883f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/query.html @@ -0,0 +1,89 @@ + + + +query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+query +

+

+ +

+

+ A customisation point that queries the value of a property. +

+
constexpr unspecified query = unspecified;
+
+

+ The name query denotes a + customization point object. The expression asio::query(E, + P) + for some subexpressions E + and P (with types T = decay_t<decltype(E)> + and Prop = + decay_t<decltype(P)>) + is expression-equivalent to: +

+
    +
  • + If is_applicable_property_v<T, Prop> is not a well-formed constant expression + with value true, asio::query(E, P) + is ill-formed. +
    • +
  • + Otherwise, Prop::template static_query_v<T> if the expression Prop::template static_query_v<T> + is a well-formed constant expression. +
    • +
  • + Otherwise, (E).query(P) if the expression (E).query(P) + is well-formed. +
    • +
  • + Otherwise, query(E, P) + if the expression query(E, P) is a valid expression with overload + resolution performed in a context that does not include the declaration + of the query customization + point object. +
    • +
  • + Otherwise, asio::query(E, P) + is ill-formed. +
    • +
+
+ + Requirements +
+

+ Header: asio/query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/query_result.html b/Packages/asio-1.36.0/doc/asio/reference/query_result.html new file mode 100644 index 0000000..a492a95 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/query_result.html @@ -0,0 +1,96 @@ + + + +query_result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines the result type of a query + expression. +

+
template<
+    typename T,
+    typename Property>
+struct query_result
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ The result of the query expression. +

+
+

+ Class template query_result + is a trait that determines the result type of the expression asio::query(std::declval<T>(), + std::declval<Property>()). +

+
+ + Requirements +
+

+ Header: asio/query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/query_result/type.html b/Packages/asio-1.36.0/doc/asio/reference/query_result/type.html new file mode 100644 index 0000000..b0a87f7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/query_result/type.html @@ -0,0 +1,51 @@ + + + +query_result::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The result of the query expression. +

+
typedef automatically_determined type;
+
+
+ + Requirements +
+

+ Header: asio/query.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/random_access_file.html b/Packages/asio-1.36.0/doc/asio/reference/random_access_file.html new file mode 100644 index 0000000..327722e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/random_access_file.html @@ -0,0 +1,544 @@ + + + +random_access_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a random-access file. +

+
typedef basic_random_access_file random_access_file;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ async_read_some_at +

+ 		+

+ Start an asynchronous read at the specified offset. +

+
+

+ async_write_some_at +

+ 		+

+ Start an asynchronous write at the specified offset. +

+
+

+ basic_random_access_file [constructor] +

+ 		+

+ Construct a basic_random_access_file without opening it.
+ —
Construct and open a basic_random_access_file.
—
+ Construct a basic_random_access_file on an existing native file. +
—
Move-construct a basic_random_access_file from another. +
—
Move-construct a basic_random_access_file from a + file of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_random_access_file from another.
—
+ Move-assign a basic_random_access_file from a file of another executor + type. +

+
+

+ read_some_at +

+ 		+

+ Read some data from the handle at the specified offset. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+

+ write_some_at +

+ 		+

+ Write some data to the handle at the specified offset. +

+
+

+ ~basic_random_access_file [destructor] +

+ 		+

+ Destroys the file. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_random_access_file class template + provides asynchronous and blocking random-access file functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+

+ Synchronous read_some_at + and write_some_at operations + are thread safe with respect to each other, if the underlying operating system + calls are also thread safe. This means that it is permitted to perform concurrent + calls to these synchronous operations on a single file object. Other synchronous + operations, such as open + or close, are not thread + safe. +

+
+ + Requirements +
+

+ Header: asio/random_access_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read.html b/Packages/asio-1.36.0/doc/asio/reference/read.html new file mode 100644 index 0000000..ccee026 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read.html @@ -0,0 +1,231 @@ + + + +read + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+read +

+

+ +

+

+ The read function is a composed + operation that reads a certain amount of data from a stream before returning. +

+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename MutableBufferSequence>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename MutableBufferSequence>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/impl/read.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload1.html new file mode 100644 index 0000000..28361cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload1.html @@ -0,0 +1,129 @@ + + + +read (1 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename MutableBufferSequence>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 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: +

+
    +
  • + The supplied buffers are full. That is, the bytes transferred is equal + to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::read(s, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload10.html new file mode 100644 index 0000000..98dfb90 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload10.html @@ -0,0 +1,104 @@ + + + +read (10 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    asio::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: +

+
    +
  • + The supplied buffer is full (that is, it has reached maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
b
+

+ The basic_streambuf object into + which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, b,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload11.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload11.html new file mode 100644 index 0000000..433544f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload11.html @@ -0,0 +1,124 @@ + + + +read (11 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The supplied buffer is full (that is, it has reached maximum size). +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
b
+

+ The 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 asio::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload12.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload12.html new file mode 100644 index 0000000..87c20b4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload12.html @@ -0,0 +1,117 @@ + + + +read (12 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The supplied buffer is full (that is, it has reached maximum size). +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
b
+

+ The 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 asio::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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload13.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload13.html new file mode 100644 index 0000000..f0d598e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload13.html @@ -0,0 +1,113 @@ + + + +read (13 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 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: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload14.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload14.html new file mode 100644 index 0000000..5f8f376 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload14.html @@ -0,0 +1,104 @@ + + + +read (14 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 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: +

+
    +
  • + The supplied buffer is full (that is, it has reached maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload15.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload15.html new file mode 100644 index 0000000..0c0cdd5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload15.html @@ -0,0 +1,125 @@ + + + +read (15 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 asio::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload16.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload16.html new file mode 100644 index 0000000..7233374 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload16.html @@ -0,0 +1,118 @@ + + + +read (16 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 asio::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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload2.html new file mode 100644 index 0000000..628f622 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload2.html @@ -0,0 +1,121 @@ + + + +read (2 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename MutableBufferSequence>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 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: +

+
    +
  • + The supplied buffers are full. That is, the bytes transferred is equal + to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
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. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::read(s, asio::buffer(data, size), ec);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload3.html new file mode 100644 index 0000000..ae5fdab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload3.html @@ -0,0 +1,142 @@ + + + +read (3 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The supplied buffers are full. That is, the bytes transferred is equal + to the sum of the buffer sizes. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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 asio::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::read(s, asio::buffer(data, size),
+   asio::transfer_at_least(32));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload4.html new file mode 100644 index 0000000..375aa4d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload4.html @@ -0,0 +1,120 @@ + + + +read (4 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_mutable_buffer_sequence< MutableBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The supplied buffers are full. That is, the bytes transferred is equal + to the sum of the buffer sizes. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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 asio::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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload5.html new file mode 100644 index 0000000..2d859ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload5.html @@ -0,0 +1,114 @@ + + + +read (5 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 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: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload6.html new file mode 100644 index 0000000..e6b5300 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload6.html @@ -0,0 +1,105 @@ + + + +read (6 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 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: +

+
    +
  • + The supplied buffer is full (that is, it has reached maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload7.html new file mode 100644 index 0000000..9d410a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload7.html @@ -0,0 +1,126 @@ + + + +read (7 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 asio::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload8.html new file mode 100644 index 0000000..61022e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload8.html @@ -0,0 +1,119 @@ + + + +read (8 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t read(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 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: +

+
    +
  • + The specified dynamic buffer sequence is full (that is, it has reached + maximum size). +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence 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 asio::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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/read/overload9.html new file mode 100644 index 0000000..c5be4d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read/overload9.html @@ -0,0 +1,112 @@ + + + +read (9 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data from a stream before returning. +

+
template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read(
+    SyncReadStream & s,
+    basic_streambuf< Allocator > & b);
+
+

+ 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 buffer is full (that is, it has reached maximum size). +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
b
+

+ The basic_streambuf object into + which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read(
+   s, b,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at.html b/Packages/asio-1.36.0/doc/asio/reference/read_at.html new file mode 100644 index 0000000..0dd7456 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at.html @@ -0,0 +1,144 @@ + + + +read_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The read_at function is a + composed operation that reads a certain amount of data at the specified offset + before returning. +

+

+ Attempt to read a certain amount of data at the specified offset before returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b);
+  » more...
+
+template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/impl/read_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload1.html new file mode 100644 index 0000000..b23a5ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload1.html @@ -0,0 +1,135 @@ + + + +read_at (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers);
+
+

+ 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. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + read_some_at function. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::read_at(d, 42, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read_at(
+   d, 42, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload2.html new file mode 100644 index 0000000..cc1cad1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload2.html @@ -0,0 +1,128 @@ + + + +read_at (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    asio::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: +

+
    +
  • + The supplied buffers are full. That is, the bytes transferred is equal + to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + read_some_at function. +

+
+ + Parameters +
+
+

+
+
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. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::read_at(d, 42,
+   asio::buffer(data, size), ec);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read_at(
+   d, 42, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload3.html new file mode 100644 index 0000000..2619444 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload3.html @@ -0,0 +1,148 @@ + + + +read_at (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ 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. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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 asio::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
asio::read_at(d, 42, asio::buffer(data, size),
+   asio::transfer_at_least(32));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload4.html new file mode 100644 index 0000000..3a375b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload4.html @@ -0,0 +1,126 @@ + + + +read_at (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename MutableBufferSequence,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ 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. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
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 asio::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. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload5.html new file mode 100644 index 0000000..41948de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload5.html @@ -0,0 +1,114 @@ + + + +read_at (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b);
+
+

+ 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. +
+

+ This operation is implemented in terms of zero or more calls to the device's + read_some_at function. +

+
+ + Parameters +
+
+

+
+
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. +

+
b
+

+ The basic_streambuf object into + which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read_at(
+   d, 42, b,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload6.html new file mode 100644 index 0000000..92d23de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload6.html @@ -0,0 +1,106 @@ + + + +read_at (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    asio::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. +
+

+ This operation is implemented in terms of zero or more calls to the device's + read_some_at function. +

+
+ + Parameters +
+
+

+
+
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. +

+
b
+

+ The basic_streambuf object into + which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::read_at(
+   d, 42, b,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload7.html new file mode 100644 index 0000000..85b1d54 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload7.html @@ -0,0 +1,126 @@ + + + +read_at (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ 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 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
b
+

+ The 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 asio::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_at/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload8.html new file mode 100644 index 0000000..fb74cfe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_at/overload8.html @@ -0,0 +1,119 @@ + + + +read_at (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Attempt to read a certain amount of data at the specified offset before + returning. +

+
template<
+    typename SyncRandomAccessReadDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t read_at(
+    SyncRandomAccessReadDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ 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 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
b
+

+ The 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 asio::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. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until.html b/Packages/asio-1.36.0/doc/asio/reference/read_until.html new file mode 100644 index 0000000..b865445 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until.html @@ -0,0 +1,356 @@ + + + +read_until + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The read_until function is + a composed operation that reads data into a dynamic buffer sequence, or into + a streambuf, until it contains a delimiter, matches a regular expression, + or a function object indicates a match. +

+

+ Read data into a dynamic buffer sequence until it contains a specified delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    char delim,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    char delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    string_view delim,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    string_view delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+

+ Read data into a dynamic buffer sequence until some part of the data it contains + matches a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+

+ Read data into a dynamic buffer sequence until a function object indicates + a match. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    MatchCondition match_condition,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    MatchCondition match_condition,
+    asio::error_code & ec,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+

+ Read data into a streambuf until it contains a specified delimiter. +

+
template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    char delim);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    char delim,
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    string_view delim);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    string_view delim,
+    asio::error_code & ec);
+  » more...
+
+

+ Read data into a streambuf until some part of the data it contains matches + a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    const boost::basic_regex< char, Traits > & expr);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    const boost::basic_regex< char, Traits > & expr,
+    asio::error_code & ec);
+  » more...
+
+

+ Read data into a streambuf until a function object indicates a match. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    MatchCondition match_condition,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    MatchCondition match_condition,
+    asio::error_code & ec,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0);
+  » more...
+
+

+ Read data into a dynamic buffer sequence until it contains a specified delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    char delim,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    char delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    string_view delim,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    string_view delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+

+ Read data into a dynamic buffer sequence until some part of the data it contains + matches a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+

+ Read data into a dynamic buffer sequence until a function object indicates + a match. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    MatchCondition match_condition,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    MatchCondition match_condition,
+    asio::error_code & ec,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/impl/read_until.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload1.html new file mode 100644 index 0000000..c76116e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload1.html @@ -0,0 +1,162 @@ + + + +read_until (1 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    char delim,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter character. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+ + Example +
+

+ To read data into a std::string + until a newline is encountered: +

+
std::string data;
+std::size_t n = asio::read_until(s,
+    asio::dynamic_buffer(data), '\n');
+std::string line = data.substr(0, n);
+data.erase(0, n);
+
+

+ After the read_until operation + completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload10.html new file mode 100644 index 0000000..915e036 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload10.html @@ -0,0 +1,110 @@ + + + +read_until (10 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until it contains a specified delimiter. +

+
template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    char delim,
+    asio::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: +

+
    +
  • + The get area of the streambuf contains the specified delimiter. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the streambuf's get area up to and including the + delimiter. Returns 0 if an error occurred. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload11.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload11.html new file mode 100644 index 0000000..0136671 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload11.html @@ -0,0 +1,154 @@ + + + +read_until (11 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until it contains a specified delimiter. +

+
template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    string_view delim);
+
+

+ 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. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the streambuf's get area up to and including the + delimiter. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+ + Example +
+

+ To read data into a streambuf until a newline is encountered: +

+
asio::streambuf b;
+asio::read_until(s, b, "\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 delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to std::getline then extracts the data up to + and including the newline (which is discarded), so that the string line contains: +

+
{ 'a', 'b', ..., 'c', '\r' }
+
+

+ The remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload12.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload12.html new file mode 100644 index 0000000..f1a9bc9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload12.html @@ -0,0 +1,110 @@ + + + +read_until (12 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until it contains a specified delimiter. +

+
template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    string_view delim,
+    asio::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: +

+
    +
  • + The get area of the streambuf contains the specified delimiter. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the streambuf's get area up to and including the + delimiter. Returns 0 if an error occurred. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload13.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload13.html new file mode 100644 index 0000000..0c19b0c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload13.html @@ -0,0 +1,157 @@ + + + +read_until (13 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until some part of the data it contains matches + a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    const boost::basic_regex< char, Traits > & 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: +

+
    +
  • + 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. If the streambuf's get area already contains data that + matches the regular expression, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
expr
+

+ The regular expression. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the streambuf's get area up to and including the + substring that matches the regular expression. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+ + Example +
+

+ To read data into a streambuf until a CR-LF sequence is encountered: +

+
asio::streambuf b;
+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: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to std::getline then extracts the data up to + and including the newline (which is discarded), so that the string line contains: +

+
{ 'a', 'b', ..., 'c', '\r' }
+
+

+ The remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload14.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload14.html new file mode 100644 index 0000000..5be2a6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload14.html @@ -0,0 +1,113 @@ + + + +read_until (14 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until some part of the data it contains matches + a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    const boost::basic_regex< char, Traits > & expr,
+    asio::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: +

+
    +
  • + 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. If the streambuf's get area already contains data that + matches the regular expression, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
expr
+

+ The regular expression. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + 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. +

+
+ + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload15.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload15.html new file mode 100644 index 0000000..9a6066d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload15.html @@ -0,0 +1,210 @@ + + + +read_until (15 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until a function object indicates a match. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    MatchCondition match_condition,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0);
+
+

+ 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 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. If the match condition function object already indicates + a match, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes in the streambuf's get area that have been fully consumed + by the match function. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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 read_until + operation to examine. +

+
+ + Remarks +
+

+ 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. +

+
+ + Examples +
+

+ To read data into a streambuf until whitespace is encountered: +

+
typedef asio::buffers_iterator<
+    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);
+}
+...
+asio::streambuf b;
+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
+...
+asio::streambuf b;
+asio::read_until(s, b, match_char('a'));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload16.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload16.html new file mode 100644 index 0000000..5d427a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload16.html @@ -0,0 +1,148 @@ + + + +read_until (16 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until a function object indicates a match. +

+
template<
+    typename SyncReadStream,
+    typename Allocator,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    MatchCondition match_condition,
+    asio::error_code & ec,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0);
+
+

+ 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 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. If the match condition function object already indicates + a match, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
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. +

+
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. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + 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. +

+
+ + 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 read_until + operation to examine. +

+
+ + Remarks +
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload17.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload17.html new file mode 100644 index 0000000..de6584a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload17.html @@ -0,0 +1,161 @@ + + + +read_until (17 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    char delim,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter character. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+ + Example +
+

+ To read data into a std::string + until a newline is encountered: +

+
std::string data;
+std::size_t n = asio::read_until(s,
+    asio::dynamic_buffer(data), '\n');
+std::string line = data.substr(0, n);
+data.erase(0, n);
+
+

+ After the read_until operation + completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload18.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload18.html new file mode 100644 index 0000000..367f188 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload18.html @@ -0,0 +1,114 @@ + + + +read_until (18 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    char delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter character. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload19.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload19.html new file mode 100644 index 0000000..458ec63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload19.html @@ -0,0 +1,148 @@ + + + +read_until (19 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    string_view delim,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter string. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+ + Example +
+

+ To read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+std::size_t n = asio::read_until(s,
+    asio::dynamic_buffer(data), "\r\n");
+std::string line = data.substr(0, n);
+data.erase(0, n);
+
+

+ After the read_until operation + completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload2.html new file mode 100644 index 0000000..bec6e61 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload2.html @@ -0,0 +1,115 @@ + + + +read_until (2 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    char delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter character. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload20.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload20.html new file mode 100644 index 0000000..d321b04 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload20.html @@ -0,0 +1,114 @@ + + + +read_until (20 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    string_view delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter string. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload21.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload21.html new file mode 100644 index 0000000..e09b348 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload21.html @@ -0,0 +1,163 @@ + + + +read_until (21 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until some part of the data it + contains matches a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains some data that matches + a regular expression. The call will block until one of the following conditions + is true: +

+
    +
  • + A substring of the dynamic buffer sequence'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. If the dynamic buffer sequence's get area already contains + data that matches the regular expression, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence into which the data will be read. +

+
expr
+

+ The regular expression. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the substring that matches the regular expression. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the regular expression. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+ + Example +
+

+ To read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+std::size_t n = asio::read_until(s,
+    asio::dynamic_buffer(data), boost::regex("\r\n"));
+std::string line = data.substr(0, n);
+data.erase(0, n);
+
+

+ After the read_until operation + completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload22.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload22.html new file mode 100644 index 0000000..4689108 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload22.html @@ -0,0 +1,117 @@ + + + +read_until (22 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until some part of the data it + contains matches a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains some data that matches + a regular expression. The call will block until one of the following conditions + is true: +

+
    +
  • + A substring of the dynamic buffer sequence'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. If the dynamic buffer sequence's get area already contains + data that matches the regular expression, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence into which the data will be read. +

+
expr
+

+ The regular expression. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the substring that matches the regular expression. Returns 0 + if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the regular expression. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload23.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload23.html new file mode 100644 index 0000000..db238ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload23.html @@ -0,0 +1,213 @@ + + + +read_until (23 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until a function object indicates + a match. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    MatchCondition match_condition,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until a user-defined match condition function object, when applied to the + data contained in the dynamic buffer sequence, indicates a successful match. + The call will block until one of the following conditions is true: +

+
    +
  • + 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. If the match condition function object already indicates + a match, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence 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<typename DynamicBuffer_v2::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic_buffer's get area that have been fully + consumed by the match function. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the function object. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+ + Remarks +
+

+ 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. +

+
+ + Examples +
+

+ To read data into a dynamic buffer sequence until whitespace is encountered: +

+
typedef asio::buffers_iterator<
+    asio::const_buffer> 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);
+}
+...
+std::string data;
+asio::read_until(s, data, match_whitespace);
+
+

+ To read data into a std::string + 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
+...
+std::string data;
+asio::read_until(s, data, match_char('a'));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload24.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload24.html new file mode 100644 index 0000000..4f20c56 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload24.html @@ -0,0 +1,150 @@ + + + +read_until (24 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until a function object indicates + a match. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v2,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v2 buffers,
+    MatchCondition match_condition,
+    asio::error_code & ec,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until a user-defined match condition function object, when applied to the + data contained in the dynamic buffer sequence, indicates a successful match. + The call will block until one of the following conditions is true: +

+
    +
  • + 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. If the match condition function object already indicates + a match, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence 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<DynamicBuffer_v2::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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area that have + been fully consumed by the match function. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the function object. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+ + Remarks +
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload3.html new file mode 100644 index 0000000..a7a9dbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload3.html @@ -0,0 +1,149 @@ + + + +read_until (3 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    string_view delim,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter string. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+ + Example +
+

+ To read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+std::size_t n = asio::read_until(s,
+    asio::dynamic_buffer(data), "\r\n");
+std::string line = data.substr(0, n);
+data.erase(0, n);
+
+

+ After the read_until operation + completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload4.html new file mode 100644 index 0000000..533e73c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload4.html @@ -0,0 +1,115 @@ + + + +read_until (4 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until it contains a specified + delimiter. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    string_view delim,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains the specified delimiter. + The call will block until one of the following conditions is true: +

+
    +
  • + The get area of the dynamic buffer sequence contains the specified + delimiter. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + read_some function. If the dynamic buffer sequence's get area already contains + the delimiter, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ The dynamic buffer sequence into which the data will be read. +

+
delim
+

+ The delimiter string. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the delimiter. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond the delimiter. An application will typically + leave that data in the dynamic buffer sequence for a subsequent read_until + operation to examine. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload5.html new file mode 100644 index 0000000..9bf4296 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload5.html @@ -0,0 +1,164 @@ + + + +read_until (5 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until some part of the data it + contains matches a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains some data that matches + a regular expression. The call will block until one of the following conditions + is true: +

+
    +
  • + A substring of the dynamic buffer sequence'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. If the dynamic buffer sequence's get area already contains + data that matches the regular expression, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence into which the data will be read. +

+
expr
+

+ The regular expression. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the substring that matches the regular expression. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the regular expression. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+ + Example +
+

+ To read data into a std::string + until a CR-LF sequence is encountered: +

+
std::string data;
+std::size_t n = asio::read_until(s,
+    asio::dynamic_buffer(data), boost::regex("\r\n"));
+std::string line = data.substr(0, n);
+data.erase(0, n);
+
+

+ After the read_until operation + completes successfully, the string data + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+
+

+ The call to substr then + extracts the data up to and including the delimiter, so that the string + line contains: +

+
{ 'a', 'b', ..., 'c', '\r', '\n' }
+
+

+ After the call to erase, + the remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload6.html new file mode 100644 index 0000000..ba72578 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload6.html @@ -0,0 +1,118 @@ + + + +read_until (6 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until some part of the data it + contains matches a regular expression. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename Traits>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    const boost::basic_regex< char, Traits > & expr,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until the dynamic buffer sequence's get area contains some data that matches + a regular expression. The call will block until one of the following conditions + is true: +

+
    +
  • + A substring of the dynamic buffer sequence'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. If the dynamic buffer sequence's get area already contains + data that matches the regular expression, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence into which the data will be read. +

+
expr
+

+ The regular expression. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area up to and + including the substring that matches the regular expression. Returns 0 + if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the regular expression. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload7.html new file mode 100644 index 0000000..7ac2c6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload7.html @@ -0,0 +1,214 @@ + + + +read_until (7 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until a function object indicates + a match. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    MatchCondition match_condition,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until a user-defined match condition function object, when applied to the + data contained in the dynamic buffer sequence, indicates a successful match. + The call will block until one of the following conditions is true: +

+
    +
  • + 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. If the match condition function object already indicates + a match, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence 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<typename DynamicBuffer_v1::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. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic_buffer's get area that have been fully + consumed by the match function. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the function object. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+ + Remarks +
+

+ 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. +

+
+ + Examples +
+

+ To read data into a dynamic buffer sequence until whitespace is encountered: +

+
typedef asio::buffers_iterator<
+    asio::const_buffer> 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);
+}
+...
+std::string data;
+asio::read_until(s, data, match_whitespace);
+
+

+ To read data into a std::string + 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
+...
+std::string data;
+asio::read_until(s, data, match_char('a'));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload8.html new file mode 100644 index 0000000..a7b02b0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload8.html @@ -0,0 +1,151 @@ + + + +read_until (8 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a dynamic buffer sequence until a function object indicates + a match. +

+
template<
+    typename SyncReadStream,
+    typename DynamicBuffer_v1,
+    typename MatchCondition>
+std::size_t read_until(
+    SyncReadStream & s,
+    DynamicBuffer_v1 && buffers,
+    MatchCondition match_condition,
+    asio::error_code & ec,
+    constraint_t< is_match_condition< MatchCondition >::value >  = 0,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to read data into the specified dynamic buffer sequence + until a user-defined match condition function object, when applied to the + data contained in the dynamic buffer sequence, indicates a successful match. + The call will block until one of the following conditions is true: +

+
    +
  • + 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. If the match condition function object already indicates + a match, the function returns immediately. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream from which the data is to be read. The type must support + the SyncReadStream concept. +

+
buffers
+

+ A dynamic buffer sequence 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<DynamicBuffer_v1::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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the dynamic buffer sequence's get area that have + been fully consumed by the match function. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ After a successful read_until operation, the dynamic buffer sequence may + contain additional data beyond that which matched the function object. + An application will typically leave that data in the dynamic buffer sequence + for a subsequent read_until operation to examine. +

+
+ + Remarks +
+

+ 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_until/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload9.html new file mode 100644 index 0000000..52b8201 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_until/overload9.html @@ -0,0 +1,154 @@ + + + +read_until (9 of 24 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read data into a streambuf until it contains a specified delimiter. +

+
template<
+    typename SyncReadStream,
+    typename Allocator>
+std::size_t read_until(
+    SyncReadStream & s,
+    asio::basic_streambuf< Allocator > & b,
+    char delim);
+
+

+ 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. +
    • +
  • + 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. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Return + Value +
+

+ The number of bytes in the streambuf's get area up to and including the + delimiter. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + 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. +

+
+ + Example +
+

+ To read data into a streambuf until a newline is encountered: +

+
asio::streambuf b;
+asio::read_until(s, b, '\n');
+std::istream is(&b);
+std::string line;
+std::getline(is, line);
+
+

+ After the read_until operation + completes successfully, the buffer b + contains the delimiter: +

+
{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
+
+

+ The call to std::getline then extracts the data up to + and including the newline (which is discarded), so that the string line contains: +

+
{ 'a', 'b', ..., 'c' }
+
+

+ The remaining data is left in the buffer b + as follows: +

+
{ 'd', 'e', ... }
+
+

+ This data may be the start of a new line, to be extracted by a subsequent + read_until operation. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/read_write_operations.html b/Packages/asio-1.36.0/doc/asio/reference/read_write_operations.html new file mode 100644 index 0000000..1126805 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/read_write_operations.html @@ -0,0 +1,66 @@ + + + +Requirements on read and write operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ A read operation is an operation that reads data into + a mutable buffer sequence argument of a type meeting MutableBufferSequence requirements. + The mutable buffer sequence specifies memory where the data should be placed. + A read operation shall always fill a buffer in the sequence completely before + proceeding to the next. +

+

+ A write operation is an operation that writes data from + a constant buffer sequence argument of a type meeting ConstBufferSequence requirements. + The constant buffer sequence specifies memory where the data to be written + is located. A write operation shall always write a buffer in the sequence + completely before proceeding to the next. +

+

+ If a read or write operation is also an asynchronous + operation, the operation shall maintain one or more copies of the + buffer sequence until such time as the operation no longer requires access + to the memory specified by the buffers in the sequence. The program shall + ensure the memory remains valid until: +

+

+ — the last copy of the buffer sequence is destroyed, or +

+

+ — the completion handler for the asynchronous operation is invoked, +

+

+ whichever comes first. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/readable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/readable_pipe.html new file mode 100644 index 0000000..bb263af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/readable_pipe.html @@ -0,0 +1,327 @@ + + + +readable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a readable pipe. +

+
typedef basic_readable_pipe readable_pipe;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_readable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ basic_readable_pipe [constructor] +

+ 		+

+ Construct a basic_readable_pipe without opening it.
—
+ Construct a basic_readable_pipe on an existing native pipe.
+ —
Move-construct a basic_readable_pipe from another.
+ —
Move-construct a basic_readable_pipe from a pipe of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_readable_pipe from another.
—
Move-assign + a basic_readable_pipe from a pipe of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the pipe. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ ~basic_readable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_readable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/readable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator.html new file mode 100644 index 0000000..f53d3e2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator.html @@ -0,0 +1,194 @@ + + + +recycling_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An allocator that caches memory blocks in thread-local storage for reuse. +

+
template<
+    typename T>
+class recycling_allocator
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind +

+ 		+

+ Rebind the allocator to another value_type. +

+
+

+ value_type +

+ 		+

+ The type of object allocated by the recycling allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate memory for the specified number of values. +

+
+

+ deallocate +

+ 		+

+ Deallocate memory for the specified number of values. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. Always returns false. +

+
+

+ operator== +

+ 		+

+ Equality operator. Always returns true. +

+
+

+ recycling_allocator [constructor] +

+ 		+

+ Default constructor.
—
Converting constructor. +

+
+

+ The @recycling_allocator uses a simple strategy where a limited number of + small memory blocks are cached in thread-local storage, if the current thread + is running an io_context + or is part of a thread_pool. +

+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/allocate.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/allocate.html new file mode 100644 index 0000000..fdaefe8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/allocate.html @@ -0,0 +1,43 @@ + + + +recycling_allocator::allocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Allocate + memory for the specified number of values. +

+
T * allocate(
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/deallocate.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/deallocate.html new file mode 100644 index 0000000..5739ada --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/deallocate.html @@ -0,0 +1,44 @@ + + + +recycling_allocator::deallocate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Deallocate + memory for the specified number of values. +

+
void deallocate(
+    T * p,
+    std::size_t n);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/operator_eq__eq_.html new file mode 100644 index 0000000..4454091 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/operator_eq__eq_.html @@ -0,0 +1,43 @@ + + + +recycling_allocator::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality + operator. Always returns true. +

+
constexpr bool operator==(
+    const recycling_allocator & ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/operator_not__eq_.html new file mode 100644 index 0000000..33ae26a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/operator_not__eq_.html @@ -0,0 +1,43 @@ + + + +recycling_allocator::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality + operator. Always returns false. +

+
constexpr bool operator!=(
+    const recycling_allocator & ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator.html new file mode 100644 index 0000000..fc2ab0f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator.html @@ -0,0 +1,52 @@ + + + +recycling_allocator::recycling_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr recycling_allocator();
+  » more...
+
+

+ Converting constructor. +

+
template<
+    typename U>
+constexpr recycling_allocator(
+    const recycling_allocator< U > & );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator/overload1.html new file mode 100644 index 0000000..16ac838 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator/overload1.html @@ -0,0 +1,41 @@ + + + +recycling_allocator::recycling_allocator (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr recycling_allocator();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator/overload2.html new file mode 100644 index 0000000..690a1b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/recycling_allocator/overload2.html @@ -0,0 +1,44 @@ + + + +recycling_allocator::recycling_allocator (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Converting constructor. +

+
template<
+    typename U>
+constexpr recycling_allocator(
+    const recycling_allocator< U > & );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/value_type.html new file mode 100644 index 0000000..4d559e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator/value_type.html @@ -0,0 +1,52 @@ + + + +recycling_allocator::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of object allocated by the recycling allocator. +

+
typedef T value_type;
+
+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator__rebind.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator__rebind.html new file mode 100644 index 0000000..86014c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator__rebind.html @@ -0,0 +1,89 @@ + + + +recycling_allocator::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebind the allocator to another value_type. +

+
template<
+    typename U>
+struct rebind
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The rebound allocator type. +

+
+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator__rebind/other.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator__rebind/other.html new file mode 100644 index 0000000..566d56f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator__rebind/other.html @@ -0,0 +1,191 @@ + + + +recycling_allocator::rebind::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + rebound allocator type. +

+
typedef recycling_allocator< U > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind +

+ 		+

+ Rebind the allocator to another value_type. +

+
+

+ value_type +

+ 		+

+ The type of object allocated by the recycling allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate memory for the specified number of values. +

+
+

+ deallocate +

+ 		+

+ Deallocate memory for the specified number of values. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. Always returns false. +

+
+

+ operator== +

+ 		+

+ Equality operator. Always returns true. +

+
+

+ recycling_allocator [constructor] +

+ 		+

+ Default constructor.
—
Converting constructor. +

+
+

+ The @recycling_allocator uses a simple strategy where a limited number + of small memory blocks are cached in thread-local storage, if the current + thread is running an io_context + or is part of a thread_pool. +

+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_.html new file mode 100644 index 0000000..4a1c447 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_.html @@ -0,0 +1,170 @@ + + + +recycling_allocator< void > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A proto-allocator that caches memory blocks in thread-local storage for reuse. +

+
template<>
+class recycling_allocator< void >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ recycling_allocator< void >::rebind +

+ 		+

+ Rebind the allocator to another value_type. +

+
+

+ value_type +

+ 		+

+ No values are allocated by a proto-allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Inequality operator. Always returns false. +

+
+

+ operator== +

+ 		+

+ Equality operator. Always returns true. +

+
+

+ recycling_allocator +

+ 		+

+ Default constructor.
—
Converting constructor. +

+
+

+ The @recycling_allocator uses a simple strategy where a limited number of + small memory blocks are cached in thread-local storage, if the current thread + is running an io_context + or is part of a thread_pool. +

+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/operator_eq__eq_.html new file mode 100644 index 0000000..b19a09f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/operator_eq__eq_.html @@ -0,0 +1,43 @@ + + + +recycling_allocator< void >::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Equality operator. Always returns true. +

+
constexpr bool operator==(
+    const recycling_allocator & ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/operator_not__eq_.html new file mode 100644 index 0000000..a8329ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/operator_not__eq_.html @@ -0,0 +1,43 @@ + + + +recycling_allocator< void >::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inequality operator. Always returns false. +

+
constexpr bool operator!=(
+    const recycling_allocator & ) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator.html new file mode 100644 index 0000000..b1d305b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator.html @@ -0,0 +1,52 @@ + + + +recycling_allocator< void >::recycling_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
constexpr recycling_allocator();
+  » more...
+
+

+ Converting constructor. +

+
template<
+    typename U>
+constexpr recycling_allocator(
+    const recycling_allocator< U > & );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator/overload1.html new file mode 100644 index 0000000..18e84f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator/overload1.html @@ -0,0 +1,41 @@ + + + +recycling_allocator< void >::recycling_allocator (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr recycling_allocator();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator/overload2.html new file mode 100644 index 0000000..7f9b07f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/recycling_allocator/overload2.html @@ -0,0 +1,44 @@ + + + +recycling_allocator< void >::recycling_allocator (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Converting constructor. +

+
template<
+    typename U>
+constexpr recycling_allocator(
+    const recycling_allocator< U > & );
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/value_type.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/value_type.html new file mode 100644 index 0000000..65c3a80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt_/value_type.html @@ -0,0 +1,52 @@ + + + +recycling_allocator< void >::value_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +No values are allocated by a proto-allocator. +

+
typedef void value_type;
+
+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt___rebind.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt___rebind.html new file mode 100644 index 0000000..bdfb1dc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt___rebind.html @@ -0,0 +1,89 @@ + + + +recycling_allocator< void >::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebind the allocator to another value_type. +

+
template<>
+struct recycling_allocator< void >::rebind
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The rebound allocator type. +

+
+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt___rebind/other.html b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt___rebind/other.html new file mode 100644 index 0000000..95a5c12 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/recycling_allocator_lt__void__gt___rebind/other.html @@ -0,0 +1,192 @@ + + + +recycling_allocator< void >::rebind::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The rebound allocator + type. +

+
typedef recycling_allocator< U > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind +

+ 		+

+ Rebind the allocator to another value_type. +

+
+

+ value_type +

+ 		+

+ The type of object allocated by the recycling allocator. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocate +

+ 		+

+ Allocate memory for the specified number of values. +

+
+

+ deallocate +

+ 		+

+ Deallocate memory for the specified number of values. +

+
+

+ operator!= +

+ 		+

+ Inequality operator. Always returns false. +

+
+

+ operator== +

+ 		+

+ Equality operator. Always returns true. +

+
+

+ recycling_allocator [constructor] +

+ 		+

+ Default constructor.
—
Converting constructor. +

+
+

+ The @recycling_allocator uses a simple strategy where a limited number + of small memory blocks are cached in thread-local storage, if the current + thread is running an io_context + or is part of a thread_pool. +

+
+ + Requirements +
+

+ Header: asio/recycling_allocator.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/redirect_error.html b/Packages/asio-1.36.0/doc/asio/reference/redirect_error.html new file mode 100644 index 0000000..5d9bf9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/redirect_error.html @@ -0,0 +1,67 @@ + + + +redirect_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Create a partial completion token adapter that captures error_code values + to a variable. +

+
partial_redirect_error redirect_error(
+    asio::error_code & ec);
+  » more...
+
+

+ Adapt a completion + token to capture error_code values to a variable. +

+
template<
+    typename CompletionToken>
+redirect_error_t< decay_t< CompletionToken > > redirect_error(
+    CompletionToken && completion_token,
+    asio::error_code & ec);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/redirect_error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/redirect_error/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/redirect_error/overload1.html new file mode 100644 index 0000000..654a4e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/redirect_error/overload1.html @@ -0,0 +1,43 @@ + + + +redirect_error (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Create a partial completion token adapter that captures error_code values + to a variable. +

+
partial_redirect_error redirect_error(
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/redirect_error/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/redirect_error/overload2.html new file mode 100644 index 0000000..a858409 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/redirect_error/overload2.html @@ -0,0 +1,46 @@ + + + +redirect_error (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Adapt a completion + token to capture error_code values to a variable. +

+
template<
+    typename CompletionToken>
+redirect_error_t< decay_t< CompletionToken > > redirect_error(
+    CompletionToken && completion_token,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t.html b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t.html new file mode 100644 index 0000000..7074ae6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t.html @@ -0,0 +1,140 @@ + + + +redirect_error_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + adapter used to specify that an error produced by an asynchronous operation + is captured to an error_code variable. +

+
template<
+    typename CompletionToken>
+class redirect_error_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ redirect_error_t [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ec_ +

+ 		+
+

+ token_ +

+ 		+
+

+ The redirect_error_t + class is used to indicate that any error_code produced by an asynchronous + operation is captured to a specified variable. +

+
+ + Requirements +
+

+ Header: asio/redirect_error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/ec_.html b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/ec_.html new file mode 100644 index 0000000..f6ac72d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/ec_.html @@ -0,0 +1,40 @@ + + + +redirect_error_t::ec_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
asio::error_code & ec_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/redirect_error_t.html b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/redirect_error_t.html new file mode 100644 index 0000000..a303fcb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/redirect_error_t.html @@ -0,0 +1,45 @@ + + + +redirect_error_t::redirect_error_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
template<
+    typename T>
+redirect_error_t(
+    T && completion_token,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/token_.html b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/token_.html new file mode 100644 index 0000000..8a64d35 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/redirect_error_t/token_.html @@ -0,0 +1,40 @@ + + + +redirect_error_t::token_ + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
CompletionToken token_;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/register_buffers.html b/Packages/asio-1.36.0/doc/asio/reference/register_buffers.html new file mode 100644 index 0000000..bb8bbaa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/register_buffers.html @@ -0,0 +1,91 @@ + + + +register_buffers + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Register buffers with an execution context. +

+
template<
+    typename Executor,
+    typename MutableBufferSequence>
+buffer_registration< MutableBufferSequence > register_buffers(
+    const Executor & ex,
+    const MutableBufferSequence & buffer_sequence,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename Executor,
+    typename MutableBufferSequence,
+    typename Allocator>
+buffer_registration< MutableBufferSequence, Allocator > register_buffers(
+    const Executor & ex,
+    const MutableBufferSequence & buffer_sequence,
+    const Allocator & alloc,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename MutableBufferSequence>
+buffer_registration< MutableBufferSequence > register_buffers(
+    ExecutionContext & ctx,
+    const MutableBufferSequence & buffer_sequence,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+template<
+    typename ExecutionContext,
+    typename MutableBufferSequence,
+    typename Allocator>
+buffer_registration< MutableBufferSequence, Allocator > register_buffers(
+    ExecutionContext & ctx,
+    const MutableBufferSequence & buffer_sequence,
+    const Allocator & alloc,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/buffer_registration.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload1.html new file mode 100644 index 0000000..b5707f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload1.html @@ -0,0 +1,47 @@ + + + +register_buffers (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Register buffers with an execution context. +

+
template<
+    typename Executor,
+    typename MutableBufferSequence>
+buffer_registration< MutableBufferSequence > register_buffers(
+    const Executor & ex,
+    const MutableBufferSequence & buffer_sequence,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload2.html new file mode 100644 index 0000000..b1b85eb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload2.html @@ -0,0 +1,49 @@ + + + +register_buffers (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Register buffers with an execution context. +

+
template<
+    typename Executor,
+    typename MutableBufferSequence,
+    typename Allocator>
+buffer_registration< MutableBufferSequence, Allocator > register_buffers(
+    const Executor & ex,
+    const MutableBufferSequence & buffer_sequence,
+    const Allocator & alloc,
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload3.html new file mode 100644 index 0000000..21035d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload3.html @@ -0,0 +1,47 @@ + + + +register_buffers (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Register buffers with an execution context. +

+
template<
+    typename ExecutionContext,
+    typename MutableBufferSequence>
+buffer_registration< MutableBufferSequence > register_buffers(
+    ExecutionContext & ctx,
+    const MutableBufferSequence & buffer_sequence,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload4.html new file mode 100644 index 0000000..7c9250c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/register_buffers/overload4.html @@ -0,0 +1,49 @@ + + + +register_buffers (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Register buffers with an execution context. +

+
template<
+    typename ExecutionContext,
+    typename MutableBufferSequence,
+    typename Allocator>
+buffer_registration< MutableBufferSequence, Allocator > register_buffers(
+    ExecutionContext & ctx,
+    const MutableBufferSequence & buffer_sequence,
+    const Allocator & alloc,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id.html b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id.html new file mode 100644 index 0000000..5a3c32a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id.html @@ -0,0 +1,183 @@ + + + +registered_buffer_id + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Type used to identify a registered buffer. +

+
class registered_buffer_id
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ native_handle_type +

+ 		+

+ The native buffer identifier type. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ native_handle +

+ 		+

+ Get the native buffer identifier type. +

+
+

+ registered_buffer_id [constructor] +

+ 		+

+ Default constructor creates an invalid registered buffer identifier. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two IDs for equality. +

+
+

+ operator== +

+ 		+

+ Compare two IDs for equality. +

+
+
+ + Requirements +
+

+ Header: asio/registered_buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/native_handle.html new file mode 100644 index 0000000..4618f4c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/native_handle.html @@ -0,0 +1,42 @@ + + + +registered_buffer_id::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the native buffer identifier type. +

+
native_handle_type native_handle() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/native_handle_type.html new file mode 100644 index 0000000..2f4795a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/native_handle_type.html @@ -0,0 +1,52 @@ + + + +registered_buffer_id::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native buffer identifier type. +

+
typedef int native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/registered_buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/operator_eq__eq_.html new file mode 100644 index 0000000..368e0ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/operator_eq__eq_.html @@ -0,0 +1,54 @@ + + + +registered_buffer_id::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two IDs for equality. +

+
bool operator==(
+    const registered_buffer_id & lhs,
+    const registered_buffer_id & rhs);
+
+
+ + Requirements +
+

+ Header: asio/registered_buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/operator_not__eq_.html new file mode 100644 index 0000000..c0b4d8a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/operator_not__eq_.html @@ -0,0 +1,54 @@ + + + +registered_buffer_id::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two IDs for equality. +

+
bool operator!=(
+    const registered_buffer_id & lhs,
+    const registered_buffer_id & rhs);
+
+
+ + Requirements +
+

+ Header: asio/registered_buffer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/registered_buffer_id.html b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/registered_buffer_id.html new file mode 100644 index 0000000..122d09b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/registered_buffer_id/registered_buffer_id.html @@ -0,0 +1,42 @@ + + + +registered_buffer_id::registered_buffer_id + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor creates an invalid registered buffer identifier. +

+
registered_buffer_id();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/require.html b/Packages/asio-1.36.0/doc/asio/reference/require.html new file mode 100644 index 0000000..7b2dec6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/require.html @@ -0,0 +1,103 @@ + + + +require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A customisation point that applies a concept-preserving property to an object. +

+
constexpr unspecified require = unspecified;
+
+

+ The name require denotes + a customisation point object. The expression asio::require(E, + P0, Pn...) + for some subexpressions E + and P0, and where Pn... represents + N subexpressions (where + N is 0 or more, and with + types T = + decay_t<decltype(E)> + and Prop0 = + decay_t<decltype(P0)>) + is expression-equivalent to: +

+
    +
  • + If is_applicable_property_v<T, Prop0> && + Prop0::is_requirable is not a well-formed + constant expression with value true, + asio::require(E, P0, Pn...) + is ill-formed. +
    • +
  • + Otherwise, E if N == 0 and the expression Prop0::template static_query_v<T> == Prop0::value() is a well-formed constant expression + with value true. +
    • +
  • + Otherwise, (E).require(P0) if N + == 0 + and the expression (E).require(P0) is a valid expression. +
    • +
  • + Otherwise, require(E, P0) + if N == + 0 and the expression require(E, P0) + is a valid expression with overload resolution performed in a context + that does not include the declaration of the require + customization point object. +
    • +
  • + Otherwise, asio::require(asio::require(E, P0), Pn...) + if N > + 0 and the expression asio::require(asio::require(E, P0), Pn...) + is a valid expression. +
    • +
  • + Otherwise, asio::require(E, P0, Pn...) + is ill-formed. +
    • +
+
+ + Requirements +
+

+ Header: asio/require.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/require_concept.html b/Packages/asio-1.36.0/doc/asio/reference/require_concept.html new file mode 100644 index 0000000..8f051c4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/require_concept.html @@ -0,0 +1,91 @@ + + + +require_concept + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A customisation point that applies a concept-enforcing property to an object. +

+
constexpr unspecified require_concept = unspecified;
+
+

+ The name require_concept + denotes a customization point object. The expression asio::require_concept(E, + P) + for some subexpressions E + and P (with types T = decay_t<decltype(E)> + and Prop = + decay_t<decltype(P)>) + is expression-equivalent to: +

+
    +
  • + If is_applicable_property_v<T, Prop> && + Prop::is_requirable_concept is not a well-formed + constant expression with value true, + asio::require_concept(E, P) + is ill-formed. +
    • +
  • + Otherwise, E if the expression + Prop::template static_query_v<T> == Prop::value() + is a well-formed constant expression with value true. +
    • +
  • + Otherwise, (E).require_concept(P) if the expression (E).require_concept(P) + is well-formed. +
    • +
  • + Otherwise, require_concept(E, P) if the expression require_concept(E, P) is a valid expression with overload + resolution performed in a context that does not include the declaration + of the require_concept + customization point object. +
    • +
  • + Otherwise, asio::require_concept(E, P) + is ill-formed. +
    • +
+
+ + Requirements +
+

+ Header: asio/require_concept.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/require_concept_result.html b/Packages/asio-1.36.0/doc/asio/reference/require_concept_result.html new file mode 100644 index 0000000..2f3545f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/require_concept_result.html @@ -0,0 +1,96 @@ + + + +require_concept_result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines the result type of a require_concept + expression. +

+
template<
+    typename T,
+    typename Property>
+struct require_concept_result
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ The result of the require_concept expression. +

+
+

+ Class template require_concept_result + is a trait that determines the result type of the expression asio::require_concept(std::declval<T>(), + std::declval<Property>()). +

+
+ + Requirements +
+

+ Header: asio/require_concept.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/require_concept_result/type.html b/Packages/asio-1.36.0/doc/asio/reference/require_concept_result/type.html new file mode 100644 index 0000000..9dea575 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/require_concept_result/type.html @@ -0,0 +1,53 @@ + + + +require_concept_result::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + result of the require_concept + expression. +

+
typedef automatically_determined type;
+
+
+ + Requirements +
+

+ Header: asio/require_concept.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/require_result.html b/Packages/asio-1.36.0/doc/asio/reference/require_result.html new file mode 100644 index 0000000..764bdc0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/require_result.html @@ -0,0 +1,96 @@ + + + +require_result + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A type trait that determines the result type of a require + expression. +

+
template<
+    typename T,
+    typename... Properties>
+struct require_result
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+

+ The result of the require expression. +

+
+

+ Class template require_result + is a trait that determines the result type of the expression asio::require(std::declval<T>(), + std::declval<Properties>()...). +

+
+ + Requirements +
+

+ Header: asio/require.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/require_result/type.html b/Packages/asio-1.36.0/doc/asio/reference/require_result/type.html new file mode 100644 index 0000000..5c11563 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/require_result/type.html @@ -0,0 +1,52 @@ + + + +require_result::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The result of the + require expression. +

+
typedef automatically_determined type;
+
+
+ + Requirements +
+

+ Header: asio/require.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/resolver_errc__try_again.html b/Packages/asio-1.36.0/doc/asio/reference/resolver_errc__try_again.html new file mode 100644 index 0000000..9aad749 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/resolver_errc__try_again.html @@ -0,0 +1,50 @@ + + + +resolver_errc::try_again + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const error::netdb_errors try_again = error::host_not_found_try_again;
+
+
+ + Requirements +
+

+ Header: asio/error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port.html new file mode 100644 index 0000000..b4c0095 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port.html @@ -0,0 +1,388 @@ + + + +serial_port + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a serial port. +

+
typedef basic_serial_port serial_port;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the serial port type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_basic_serial_port is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a serial port. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native serial port to the serial port. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_serial_port [constructor] +

+ 		+

+ 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.
+ —
Move-construct a basic_serial_port from a serial port of + another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the serial port. +

+
+

+ close +

+ 		+

+ Close the serial port. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ get_option +

+ 		+

+ Get an option from the serial port. +

+
+

+ is_open +

+ 		+

+ Determine whether the serial port is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native serial port representation. +

+
+

+ open +

+ 		+

+ Open the serial port using the specified device name. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_serial_port from another.
—
Move-assign + a basic_serial_port from a serial port of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the serial port. +

+
+

+ send_break +

+ 		+

+ Send a break sequence to the serial port. +

+
+

+ set_option +

+ 		+

+ Set an option on the serial port. +

+
+

+ write_some +

+ 		+

+ Write some data to the serial port. +

+
+

+ ~basic_serial_port [destructor] +

+ 		+

+ Destroys the serial port. +

+
+

+ The basic_serial_port + class provides a wrapper over serial port functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/serial_port.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base.html new file mode 100644 index 0000000..1f77bde --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base.html @@ -0,0 +1,174 @@ + + + +serial_port_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The serial_port_base + class is used as a base for the basic_serial_port class template + so that we have a common place to define the serial port options. +

+
class serial_port_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ baud_rate +

+ 		+

+ Serial port option to permit changing the baud rate. +

+
+

+ character_size +

+ 		+

+ Serial port option to permit changing the character size. +

+
+

+ flow_control +

+ 		+

+ Serial port option to permit changing the flow control. +

+
+

+ parity +

+ 		+

+ Serial port option to permit changing the parity. +

+
+

+ stop_bits +

+ 		+

+ Serial port option to permit changing the number of stop bits. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~serial_port_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Requirements +
+

+ Header: asio/serial_port_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base/_serial_port_base.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base/_serial_port_base.html new file mode 100644 index 0000000..791a1ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base/_serial_port_base.html @@ -0,0 +1,42 @@ + + + +serial_port_base::~serial_port_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~serial_port_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate.html new file mode 100644 index 0000000..ed2eb9f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate.html @@ -0,0 +1,117 @@ + + + +serial_port_base::baud_rate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Serial port option to permit changing the baud rate. +

+
class baud_rate
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ baud_rate [constructor] +

+ 		+
+

+ load +

+ 		+
+

+ store +

+ 		+
+

+ value +

+ 		+
+

+ Implements changing the baud rate for a given serial port. +

+
+ + Requirements +
+

+ Header: asio/serial_port_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/baud_rate.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/baud_rate.html new file mode 100644 index 0000000..27a8d91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/baud_rate.html @@ -0,0 +1,41 @@ + + + +serial_port_base::baud_rate::baud_rate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
baud_rate(
+    unsigned int rate = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/load.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/load.html new file mode 100644 index 0000000..88b74f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/load.html @@ -0,0 +1,42 @@ + + + +serial_port_base::baud_rate::load + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void load(
+    const ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/store.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/store.html new file mode 100644 index 0000000..e7ea9fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/store.html @@ -0,0 +1,42 @@ + + + +serial_port_base::baud_rate::store + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void store(
+    ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/value.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/value.html new file mode 100644 index 0000000..e5a57e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__baud_rate/value.html @@ -0,0 +1,40 @@ + + + +serial_port_base::baud_rate::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
unsigned int value() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size.html new file mode 100644 index 0000000..f957860 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size.html @@ -0,0 +1,117 @@ + + + +serial_port_base::character_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Serial port option to permit changing the character size. +

+
class character_size
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ character_size [constructor] +

+ 		+
+

+ load +

+ 		+
+

+ store +

+ 		+
+

+ value +

+ 		+
+

+ Implements changing the character size for a given serial port. +

+
+ + Requirements +
+

+ Header: asio/serial_port_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/character_size.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/character_size.html new file mode 100644 index 0000000..2377f54 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/character_size.html @@ -0,0 +1,41 @@ + + + +serial_port_base::character_size::character_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
character_size(
+    unsigned int t = 8);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/load.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/load.html new file mode 100644 index 0000000..0901bc6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/load.html @@ -0,0 +1,42 @@ + + + +serial_port_base::character_size::load + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void load(
+    const ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/store.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/store.html new file mode 100644 index 0000000..8e0765a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/store.html @@ -0,0 +1,42 @@ + + + +serial_port_base::character_size::store + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void store(
+    ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/value.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/value.html new file mode 100644 index 0000000..d6b27a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__character_size/value.html @@ -0,0 +1,40 @@ + + + +serial_port_base::character_size::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
unsigned int value() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control.html new file mode 100644 index 0000000..b542a10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control.html @@ -0,0 +1,148 @@ + + + +serial_port_base::flow_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Serial port option to permit changing the flow control. +

+
class flow_control
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ flow_control [constructor] +

+ 		+
+

+ load +

+ 		+
+

+ store +

+ 		+
+

+ value +

+ 		+
+

+ Implements changing the flow control for a given serial port. +

+
+ + Requirements +
+

+ Header: asio/serial_port_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/flow_control.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/flow_control.html new file mode 100644 index 0000000..8cea0bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/flow_control.html @@ -0,0 +1,41 @@ + + + +serial_port_base::flow_control::flow_control + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
flow_control(
+    type t = none);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/load.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/load.html new file mode 100644 index 0000000..cc98b7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/load.html @@ -0,0 +1,42 @@ + + + +serial_port_base::flow_control::load + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void load(
+    const ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/store.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/store.html new file mode 100644 index 0000000..c76e9f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/store.html @@ -0,0 +1,42 @@ + + + +serial_port_base::flow_control::store + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void store(
+    ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/type.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/type.html new file mode 100644 index 0000000..03d9a0b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/type.html @@ -0,0 +1,60 @@ + + + +serial_port_base::flow_control::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ + enum + type +

+

+ + + +

+
+ + Values +
+
+

+
+
none
+
+
software
+
+
hardware
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/value.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/value.html new file mode 100644 index 0000000..d7f8a7c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__flow_control/value.html @@ -0,0 +1,40 @@ + + + +serial_port_base::flow_control::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
type value() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity.html new file mode 100644 index 0000000..167235a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity.html @@ -0,0 +1,148 @@ + + + +serial_port_base::parity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Serial port option to permit changing the parity. +

+
class parity
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ load +

+ 		+
+

+ parity [constructor] +

+ 		+
+

+ store +

+ 		+
+

+ value +

+ 		+
+

+ Implements changing the parity for a given serial port. +

+
+ + Requirements +
+

+ Header: asio/serial_port_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/load.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/load.html new file mode 100644 index 0000000..7f45d88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/load.html @@ -0,0 +1,42 @@ + + + +serial_port_base::parity::load + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void load(
+    const ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/parity.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/parity.html new file mode 100644 index 0000000..a4ecce3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/parity.html @@ -0,0 +1,41 @@ + + + +serial_port_base::parity::parity + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
parity(
+    type t = none);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/store.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/store.html new file mode 100644 index 0000000..f55f117 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/store.html @@ -0,0 +1,42 @@ + + + +serial_port_base::parity::store + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void store(
+    ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/type.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/type.html new file mode 100644 index 0000000..bbc0280 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/type.html @@ -0,0 +1,60 @@ + + + +serial_port_base::parity::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ + enum + type +

+

+ + + +

+
+ + Values +
+
+

+
+
none
+
+
odd
+
+
even
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/value.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/value.html new file mode 100644 index 0000000..6c2e772 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__parity/value.html @@ -0,0 +1,40 @@ + + + +serial_port_base::parity::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
type value() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits.html new file mode 100644 index 0000000..c1e3b24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits.html @@ -0,0 +1,148 @@ + + + +serial_port_base::stop_bits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Serial port option to permit changing the number of stop bits. +

+
class stop_bits
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ type +

+ 		+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ load +

+ 		+
+

+ stop_bits [constructor] +

+ 		+
+

+ store +

+ 		+
+

+ value +

+ 		+
+

+ Implements changing the number of stop bits for a given serial port. +

+
+ + Requirements +
+

+ Header: asio/serial_port_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/load.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/load.html new file mode 100644 index 0000000..c77655c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/load.html @@ -0,0 +1,42 @@ + + + +serial_port_base::stop_bits::load + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void load(
+    const ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/stop_bits.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/stop_bits.html new file mode 100644 index 0000000..2acfacb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/stop_bits.html @@ -0,0 +1,41 @@ + + + +serial_port_base::stop_bits::stop_bits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
stop_bits(
+    type t = one);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/store.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/store.html new file mode 100644 index 0000000..243b1b1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/store.html @@ -0,0 +1,42 @@ + + + +serial_port_base::stop_bits::store + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
void store(
+    ASIO_OPTION_STORAGE & storage,
+    asio::error_code & ec) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/type.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/type.html new file mode 100644 index 0000000..1fcaf1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/type.html @@ -0,0 +1,60 @@ + + + +serial_port_base::stop_bits::type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ + enum + type +

+

+ + + +

+
+ + Values +
+
+

+
+
one
+
+
onepointfive
+
+
two
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/value.html b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/value.html new file mode 100644 index 0000000..0655b68 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/serial_port_base__stop_bits/value.html @@ -0,0 +1,40 @@ + + + +serial_port_base::stop_bits::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
type value() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/service_already_exists.html b/Packages/asio-1.36.0/doc/asio/reference/service_already_exists.html new file mode 100644 index 0000000..7bf3be9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/service_already_exists.html @@ -0,0 +1,85 @@ + + + +service_already_exists + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Exception thrown when trying to add a duplicate service to an execution_context. +

+
class service_already_exists :
+  public std::logic_error
+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ service_already_exists [constructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/execution_context.hpp +

+

+ Convenience header: asio/execution.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/service_already_exists/service_already_exists.html b/Packages/asio-1.36.0/doc/asio/reference/service_already_exists/service_already_exists.html new file mode 100644 index 0000000..91fd1bf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/service_already_exists/service_already_exists.html @@ -0,0 +1,40 @@ + + + +service_already_exists::service_already_exists + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
service_already_exists();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/signal_set.html b/Packages/asio-1.36.0/doc/asio/reference/signal_set.html new file mode 100644 index 0000000..f51a46c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/signal_set.html @@ -0,0 +1,334 @@ + + + +signal_set + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a signal set. +

+
typedef basic_signal_set signal_set;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the signal set type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ Enumeration representing the different types of flags that may + specified when adding a signal to a set. +

+
+

+ flags_t +

+ 		+

+ Portability typedef. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ add +

+ 		+

+ Add a signal to a signal_set.
—
Add a signal to a signal_set + with the specified flags. +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous operation to wait for a signal to be delivered. +

+
+

+ basic_signal_set [constructor] +

+ 		+

+ 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. +

+
+

+ cancel +

+ 		+

+ Cancel all operations associated with the signal set. +

+
+

+ clear +

+ 		+

+ Remove all signals from a signal_set. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ remove +

+ 		+

+ Remove a signal from a signal_set. +

+
+

+ ~basic_signal_set [destructor] +

+ 		+

+ Destroys the signal set. +

+
+

+ The basic_signal_set + class provides the ability to perform an asynchronous wait for one or more + signals to occur. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Example +
+

+ Performing an asynchronous wait: +

+
void handler(
+    const asio::error_code& error,
+    int signal_number)
+{
+  if (!error)
+  {
+    // A signal occurred.
+  }
+}
+
+...
+
+// Construct a signal set registered for process termination.
+asio::signal_set signals(my_context, SIGINT, SIGTERM);
+
+// Start an asynchronous wait for one of the signals to occur.
+signals.async_wait(handler);
+
+
+ + Queueing + of signal notifications +
+

+ 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. +

+
+ + 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(). +

+
+ + 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. +

+
+ + Requirements +
+

+ Header: asio/signal_set.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/signal_set_base.html b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base.html new file mode 100644 index 0000000..7f241e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base.html @@ -0,0 +1,139 @@ + + + +signal_set_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The signal_set_base + class is used as a base for the basic_signal_set class templates + so that we have a common place to define the flags enum. +

+
class signal_set_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ flags +

+ 		+

+ Enumeration representing the different types of flags that may + specified when adding a signal to a set. +

+
+

+ flags_t +

+ 		+

+ Portability typedef. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~signal_set_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Requirements +
+

+ Header: asio/signal_set_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/_signal_set_base.html b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/_signal_set_base.html new file mode 100644 index 0000000..f0652fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/_signal_set_base.html @@ -0,0 +1,42 @@ + + + +signal_set_base::~signal_set_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~signal_set_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/flags.html b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/flags.html new file mode 100644 index 0000000..72766db --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/flags.html @@ -0,0 +1,85 @@ + + + +signal_set_base::flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Enumeration representing + the different types of flags that may specified when adding a signal to + a set. +

+
enum flags
+
+

+ + + + + +

+
+ + Values +
+
+

+
+
none
+

+ Bitmask representing no flags. +

+
restart
+

+ Affects the behaviour of interruptible functions such that, if the + function would have failed with error::interrupted when interrupted + by the specified signal, the function shall instead be restarted + and not fail with error::interrupted. +

+
no_child_stop
+

+ Do not generate SIGCHLD when child processes stop or stopped child + processes continue. +

+
no_child_wait
+

+ Do not transform child processes into zombies when they terminate. +

+
dont_care
+

+ Special value to indicate that the signal registration does not care + which flags are set, and so will not conflict with any prior registrations + of the same signal. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/flags_t.html b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/flags_t.html new file mode 100644 index 0000000..5c52817 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/signal_set_base/flags_t.html @@ -0,0 +1,52 @@ + + + +signal_set_base::flags_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Portability + typedef. +

+
typedef flags flags_t;
+
+
+ + Requirements +
+

+ Header: asio/signal_set_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base.html new file mode 100644 index 0000000..c3c140a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base.html @@ -0,0 +1,394 @@ + + + +socket_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The socket_base + class is used as a base for the basic_stream_socket and basic_datagram_socket class templates + so that we have a common place to define the shutdown_type and enum. +

+
class socket_base
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ broadcast +

+ 		+

+ Socket option to permit sending of broadcast messages. +

+
+

+ bytes_readable +

+ 		+

+ IO control command to get the amount of data that can be read without + blocking. +

+
+

+ debug +

+ 		+

+ Socket option to enable socket-level debugging. +

+
+

+ do_not_route +

+ 		+

+ Socket option to prevent routing, use local interfaces only. +

+
+

+ enable_connection_aborted +

+ 		+

+ Socket option to report aborted connections on accept. +

+
+

+ keep_alive +

+ 		+

+ Socket option to send keep-alives. +

+
+

+ linger +

+ 		+

+ Socket option to specify whether the socket lingers on close if + unsent data is present. +

+
+

+ message_flags +

+ 		+

+ Bitmask type for flags that can be passed to send and receive operations. +

+
+

+ out_of_band_inline +

+ 		+

+ Socket option for putting received out-of-band data inline. +

+
+

+ receive_buffer_size +

+ 		+

+ Socket option for the receive buffer size of a socket. +

+
+

+ receive_low_watermark +

+ 		+

+ Socket option for the receive low watermark. +

+
+

+ reuse_address +

+ 		+

+ Socket option to allow the socket to be bound to an address that + is already in use. +

+
+

+ send_buffer_size +

+ 		+

+ Socket option for the send buffer size of a socket. +

+
+

+ send_low_watermark +

+ 		+

+ Socket option for the send low watermark. +

+
+

+ shutdown_type +

+ 		+

+ Different ways a socket may be shutdown. +

+
+

+ wait_type +

+ 		+

+ Wait types. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~socket_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ max_listen_connections [static] +

+ 		+

+ The maximum length of the queue of pending incoming connections. +

+
+

+ message_do_not_route [static] +

+ 		+

+ Specify that the data should not be subject to routing. +

+
+

+ message_end_of_record [static] +

+ 		+

+ Specifies that the data marks the end of a record. +

+
+

+ message_out_of_band [static] +

+ 		+

+ Process out-of-band data. +

+
+

+ message_peek [static] +

+ 		+

+ Peek at incoming data without removing it from the input queue. +

+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/_socket_base.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/_socket_base.html new file mode 100644 index 0000000..04472ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/_socket_base.html @@ -0,0 +1,42 @@ + + + +socket_base::~socket_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~socket_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/broadcast.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/broadcast.html new file mode 100644 index 0000000..a042a9f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/broadcast.html @@ -0,0 +1,76 @@ + + + +socket_base::broadcast + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket option to + permit sending of broadcast messages. +

+
typedef implementation_defined broadcast;
+
+

+ Implements the SOL_SOCKET/SO_BROADCAST socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::broadcast option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/bytes_readable.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/bytes_readable.html new file mode 100644 index 0000000..be8e8fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/bytes_readable.html @@ -0,0 +1,65 @@ + + + +socket_base::bytes_readable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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. +

+
+ + Example +
+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::bytes_readable command(true);
+socket.io_control(command);
+std::size_t bytes_readable = command.get();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/debug.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/debug.html new file mode 100644 index 0000000..55cfdc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/debug.html @@ -0,0 +1,76 @@ + + + +socket_base::debug + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket option to enable + socket-level debugging. +

+
typedef implementation_defined debug;
+
+

+ Implements the SOL_SOCKET/SO_DEBUG socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::debug option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/do_not_route.html new file mode 100644 index 0000000..496bddb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/do_not_route.html @@ -0,0 +1,76 @@ + + + +socket_base::do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket option + to prevent routing, use local interfaces only. +

+
typedef implementation_defined do_not_route;
+
+

+ Implements the SOL_SOCKET/SO_DONTROUTE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::udp::socket socket(my_context);
+...
+asio::socket_base::do_not_route option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/enable_connection_aborted.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/enable_connection_aborted.html new file mode 100644 index 0000000..5292ef7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/enable_connection_aborted.html @@ -0,0 +1,78 @@ + + + +socket_base::enable_connection_aborted + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket + option to report aborted connections on accept. +

+
typedef implementation_defined enable_connection_aborted;
+
+

+ Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with asio::error::connection_aborted. + By default the option is false. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::enable_connection_aborted option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/keep_alive.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/keep_alive.html new file mode 100644 index 0000000..66df050 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/keep_alive.html @@ -0,0 +1,76 @@ + + + +socket_base::keep_alive + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket option + to send keep-alives. +

+
typedef implementation_defined keep_alive;
+
+

+ Implements the SOL_SOCKET/SO_KEEPALIVE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::keep_alive option;
+socket.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/linger.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/linger.html new file mode 100644 index 0000000..9055b80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/linger.html @@ -0,0 +1,77 @@ + + + +socket_base::linger + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket option to specify + whether the socket lingers on close if unsent data is present. +

+
typedef implementation_defined linger;
+
+

+ Implements the SOL_SOCKET/SO_LINGER socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option(true, 30);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::linger option;
+socket.get_option(option);
+bool is_set = option.enabled();
+unsigned short timeout = option.timeout();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/max_listen_connections.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/max_listen_connections.html new file mode 100644 index 0000000..70c7cf5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/max_listen_connections.html @@ -0,0 +1,42 @@ + + + +socket_base::max_listen_connections + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + maximum length of the queue of pending incoming connections. +

+
static const int max_listen_connections = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_do_not_route.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_do_not_route.html new file mode 100644 index 0000000..539adf2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_do_not_route.html @@ -0,0 +1,42 @@ + + + +socket_base::message_do_not_route + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + that the data should not be subject to routing. +

+
static const int message_do_not_route = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_end_of_record.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_end_of_record.html new file mode 100644 index 0000000..902dd64 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_end_of_record.html @@ -0,0 +1,42 @@ + + + +socket_base::message_end_of_record + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specifies + that the data marks the end of a record. +

+
static const int message_end_of_record = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_flags.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_flags.html new file mode 100644 index 0000000..33be3c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_flags.html @@ -0,0 +1,52 @@ + + + +socket_base::message_flags + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bitmask + type for flags that can be passed to send and receive operations. +

+
typedef int message_flags;
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_out_of_band.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_out_of_band.html new file mode 100644 index 0000000..d5a3b3f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_out_of_band.html @@ -0,0 +1,42 @@ + + + +socket_base::message_out_of_band + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Process + out-of-band data. +

+
static const int message_out_of_band = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_peek.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_peek.html new file mode 100644 index 0000000..a175d75 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/message_peek.html @@ -0,0 +1,42 @@ + + + +socket_base::message_peek + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Peek at incoming + data without removing it from the input queue. +

+
static const int message_peek = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/out_of_band_inline.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/out_of_band_inline.html new file mode 100644 index 0000000..7aec5fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/out_of_band_inline.html @@ -0,0 +1,76 @@ + + + +socket_base::out_of_band_inline + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket + option for putting received out-of-band data inline. +

+
typedef implementation_defined out_of_band_inline;
+
+

+ Implements the SOL_SOCKET/SO_OOBINLINE socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option(true);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::out_of_band_inline option;
+socket.get_option(option);
+bool value = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/receive_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/receive_buffer_size.html new file mode 100644 index 0000000..202cb5e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/receive_buffer_size.html @@ -0,0 +1,76 @@ + + + +socket_base::receive_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket + option for the receive buffer size of a socket. +

+
typedef implementation_defined receive_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_RCVBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/receive_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/receive_low_watermark.html new file mode 100644 index 0000000..5d2779b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/receive_low_watermark.html @@ -0,0 +1,76 @@ + + + +socket_base::receive_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket + option for the receive low watermark. +

+
typedef implementation_defined receive_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_RCVLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::receive_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/reuse_address.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/reuse_address.html new file mode 100644 index 0000000..e9b6da3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/reuse_address.html @@ -0,0 +1,77 @@ + + + +socket_base::reuse_address + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +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. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option(true);
+acceptor.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::acceptor acceptor(my_context);
+...
+asio::socket_base::reuse_address option;
+acceptor.get_option(option);
+bool is_set = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/send_buffer_size.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/send_buffer_size.html new file mode 100644 index 0000000..9ddf49e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/send_buffer_size.html @@ -0,0 +1,76 @@ + + + +socket_base::send_buffer_size + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket + option for the send buffer size of a socket. +

+
typedef implementation_defined send_buffer_size;
+
+

+ Implements the SOL_SOCKET/SO_SNDBUF socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option(8192);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_buffer_size option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/send_low_watermark.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/send_low_watermark.html new file mode 100644 index 0000000..6f2792c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/send_low_watermark.html @@ -0,0 +1,76 @@ + + + +socket_base::send_low_watermark + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Socket + option for the send low watermark. +

+
typedef implementation_defined send_low_watermark;
+
+

+ Implements the SOL_SOCKET/SO_SNDLOWAT socket option. +

+
+ + Examples +
+

+ Setting the option: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option(1024);
+socket.set_option(option);
+
+

+ Getting the current option value: +

+
asio::ip::tcp::socket socket(my_context);
+...
+asio::socket_base::send_low_watermark option;
+socket.get_option(option);
+int size = option.value();
+
+
+ + Requirements +
+

+ Header: asio/socket_base.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/shutdown_type.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/shutdown_type.html new file mode 100644 index 0000000..aa378c1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/shutdown_type.html @@ -0,0 +1,68 @@ + + + +socket_base::shutdown_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Different + ways a socket may be shutdown. +

+
enum shutdown_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
shutdown_receive
+

+ Shutdown the receive side of the socket. +

+
shutdown_send
+

+ Shutdown the send side of the socket. +

+
shutdown_both
+

+ Shutdown both send and receive on the socket. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/socket_base/wait_type.html b/Packages/asio-1.36.0/doc/asio/reference/socket_base/wait_type.html new file mode 100644 index 0000000..6f49822 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/socket_base/wait_type.html @@ -0,0 +1,70 @@ + + + +socket_base::wait_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait types. +

+
enum wait_type
+
+

+ + + +

+
+ + Values +
+
+

+
+
wait_read
+

+ Wait for a socket to become ready to read. +

+
wait_write
+

+ Wait for a socket to become ready to write. +

+
wait_error
+

+ Wait for a socket to have error conditions pending. +

+
+
+

+ For use with basic_socket::wait() and basic_socket::async_wait(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/spawn.html b/Packages/asio-1.36.0/doc/asio/reference/spawn.html new file mode 100644 index 0000000..4beb541 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/spawn.html @@ -0,0 +1,175 @@ + + + +spawn + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+spawn +

+

+ +

+

+ Start a new stackful coroutine. +

+

+ Start a new stackful coroutine that executes on a given executor. +

+
template<
+    typename Executor,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const Executor & ex,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ Start a new stackful coroutine that executes on a given execution context. +

+
template<
+    typename ExecutionContext,
+    typename F,
+    typename CompletionToken = default_completion_token_t<            typename ExecutionContext::executor_type>>
+auto spawn(
+    ExecutionContext & ctx,
+    F && function,
+    CompletionToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Start a new stackful coroutine, inheriting the executor of another. +

+
template<
+    typename Executor,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const basic_yield_context< Executor > & ctx,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ Start a new stackful coroutine that executes on a given executor. +

+
template<
+    typename Executor,
+    typename StackAllocator,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const Executor & ex,
+    allocator_arg_t ,
+    StackAllocator && stack_allocator,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ Start a new stackful coroutine that executes on a given execution context. +

+
template<
+    typename ExecutionContext,
+    typename StackAllocator,
+    typename F,
+    typename CompletionToken = default_completion_token_t<            typename ExecutionContext::executor_type>>
+auto spawn(
+    ExecutionContext & ctx,
+    allocator_arg_t ,
+    StackAllocator && stack_allocator,
+    F && function,
+    CompletionToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Start a new stackful coroutine, inheriting the executor of another. +

+
template<
+    typename Executor,
+    typename StackAllocator,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const basic_yield_context< Executor > & ctx,
+    allocator_arg_t ,
+    StackAllocator && stack_allocator,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+  » more...
+
+

+ The spawn + function is a high-level wrapper over the Boost.Coroutine library. This function + enables programs to implement asynchronous logic in a synchronous manner, + as illustrated by the following example: +

+
asio::spawn(my_strand, do_echo, asio::detached);
+
+// ...
+
+void do_echo(asio::yield_context yield)
+{
+  try
+  {
+    char data[128];
+    for (;;)
+    {
+      std::size_t length =
+        my_socket.async_read_some(
+          asio::buffer(data), yield);
+
+      asio::async_write(my_socket,
+          asio::buffer(data, length), yield);
+    }
+  }
+  catch (std::exception& e)
+  {
+    // ...
+  }
+}
+
+
+ + Requirements +
+

+ Header: asio/impl/spawn.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/spawn/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload1.html new file mode 100644 index 0000000..63ae3cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload1.html @@ -0,0 +1,109 @@ + + + +spawn (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start a new stackful coroutine that executes on a given executor. +

+
template<
+    typename Executor,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const Executor & ex,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+

+ This function is used to launch a new stackful coroutine. +

+
+ + Parameters +
+
+

+
+
ex
+

+ Identifies the executor that will run the stackful coroutine. +

+
function
+
+

+ The coroutine function. The function must be callable the signature: +

+
void function(basic_yield_context<Executor> yield);
+
+
+
token
+

+ The completion + token that will handle the notification that the coroutine + has completed. If the return type R + of function is void, the function signature of the + completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the return type + of the function object. +

+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call the basic_yield_context member function + reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/spawn/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload2.html new file mode 100644 index 0000000..783773c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload2.html @@ -0,0 +1,109 @@ + + + +spawn (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start a new stackful coroutine that executes on a given execution context. +

+
template<
+    typename ExecutionContext,
+    typename F,
+    typename CompletionToken = default_completion_token_t<            typename ExecutionContext::executor_type>>
+auto spawn(
+    ExecutionContext & ctx,
+    F && function,
+    CompletionToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to launch a new stackful coroutine. +

+
+ + Parameters +
+
+

+
+
ctx
+

+ Identifies the execution context that will run the stackful coroutine. +

+
function
+
+

+ The coroutine function. The function must be callable the signature: +

+
void function(basic_yield_context<Executor> yield);
+
+
+
token
+

+ The completion + token that will handle the notification that the coroutine + has completed. If the return type R + of function is void, the function signature of the + completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the return type + of the function object. +

+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call the basic_yield_context member function + reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/spawn/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload3.html new file mode 100644 index 0000000..dacdbc7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload3.html @@ -0,0 +1,113 @@ + + + +spawn (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start a new stackful coroutine, inheriting the executor of another. +

+
template<
+    typename Executor,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const basic_yield_context< Executor > & ctx,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+

+ This function is used to launch a new stackful coroutine. +

+
+ + Parameters +
+
+

+
+
ctx
+

+ Identifies the current coroutine as a parent of the new coroutine. + This specifies that the new coroutine should inherit the executor + of the parent. For example, if the parent coroutine is executing + in a particular strand, then the new coroutine will execute in the + same strand. +

+
function
+
+

+ The coroutine function. The function must be callable the signature: +

+
void function(basic_yield_context<Executor> yield);
+
+
+
token
+

+ The completion + token that will handle the notification that the coroutine + has completed. If the return type R + of function is void, the function signature of the + completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the return type + of the function object. +

+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call the basic_yield_context member function + reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/spawn/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload4.html new file mode 100644 index 0000000..4ea855d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload4.html @@ -0,0 +1,119 @@ + + + +spawn (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start a new stackful coroutine that executes on a given executor. +

+
template<
+    typename Executor,
+    typename StackAllocator,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const Executor & ex,
+    allocator_arg_t ,
+    StackAllocator && stack_allocator,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+

+ This function is used to launch a new stackful coroutine using the specified + stack allocator. +

+
+ + Parameters +
+
+

+
+
ex
+

+ Identifies the executor that will run the stackful coroutine. +

+
stack_allocator
+

+ Denotes the allocator to be used to allocate the underlying coroutine's + stack. The type must satisfy the stack-allocator concept defined + by the Boost.Context library. +

+
function
+
+

+ The coroutine function. The function must be callable the signature: +

+
void function(basic_yield_context<Executor> yield);
+
+
+
token
+

+ The completion + token that will handle the notification that the coroutine + has completed. If the return type R + of function is void, the function signature of the + completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the return type + of the function object. +

+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call the basic_yield_context member function + reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/spawn/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload5.html new file mode 100644 index 0000000..961c955 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload5.html @@ -0,0 +1,118 @@ + + + +spawn (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start a new stackful coroutine that executes on a given execution context. +

+
template<
+    typename ExecutionContext,
+    typename StackAllocator,
+    typename F,
+    typename CompletionToken = default_completion_token_t<            typename ExecutionContext::executor_type>>
+auto spawn(
+    ExecutionContext & ctx,
+    allocator_arg_t ,
+    StackAllocator && stack_allocator,
+    F && function,
+    CompletionToken && token = default_completion_token_t< typename ExecutionContext::executor_type >(),
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This function is used to launch a new stackful coroutine. +

+
+ + Parameters +
+
+

+
+
ctx
+

+ Identifies the execution context that will run the stackful coroutine. +

+
stack_allocator
+

+ Denotes the allocator to be used to allocate the underlying coroutine's + stack. The type must satisfy the stack-allocator concept defined + by the Boost.Context library. +

+
function
+
+

+ The coroutine function. The function must be callable the signature: +

+
void function(basic_yield_context<Executor> yield);
+
+
+
token
+

+ The completion + token that will handle the notification that the coroutine + has completed. If the return type R + of function is void, the function signature of the + completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the return type + of the function object. +

+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call the basic_yield_context member function + reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/spawn/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload6.html new file mode 100644 index 0000000..ed9bfaf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/spawn/overload6.html @@ -0,0 +1,123 @@ + + + +spawn (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start a new stackful coroutine, inheriting the executor of another. +

+
template<
+    typename Executor,
+    typename StackAllocator,
+    typename F,
+    typename CompletionToken = default_completion_token_t<Executor>>
+auto spawn(
+    const basic_yield_context< Executor > & ctx,
+    allocator_arg_t ,
+    StackAllocator && stack_allocator,
+    F && function,
+    CompletionToken && token = default_completion_token_t< Executor >(),
+    constraint_t< is_executor< Executor >::value||execution::is_executor< Executor >::value >  = 0);
+
+

+ This function is used to launch a new stackful coroutine using the specified + stack allocator. +

+
+ + Parameters +
+
+

+
+
ctx
+

+ Identifies the current coroutine as a parent of the new coroutine. + This specifies that the new coroutine should inherit the executor + of the parent. For example, if the parent coroutine is executing + in a particular strand, then the new coroutine will execute in the + same strand. +

+
stack_allocator
+

+ Denotes the allocator to be used to allocate the underlying coroutine's + stack. The type must satisfy the stack-allocator concept defined + by the Boost.Context library. +

+
function
+
+

+ The coroutine function. The function must be callable the signature: +

+
void function(basic_yield_context<Executor> yield);
+
+
+
token
+

+ The completion + token that will handle the notification that the coroutine + has completed. If the return type R + of function is void, the function signature of the + completion handler must be: +

+
+
+
void handler(std::exception_ptr);
+
+

+ Otherwise, the function signature of the completion handler must be: +

+
void handler(std::exception_ptr, R);
+
+
+ + Completion + Signature +
+
void(std::exception_ptr, R)
+
+

+ where R is the return type + of the function object. +

+
+ + Per-Operation + Cancellation +
+

+ The new thread of execution is created with a cancellation state that supports + cancellation_type::terminal values only. To change the cancellation + state, call the basic_yield_context member function + reset_cancellation_state. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context.html new file mode 100644 index 0000000..f546dc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context.html @@ -0,0 +1,587 @@ + + + +ssl::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
class context :
+  public ssl::context_base,
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ file_format +

+ 		+

+ File format types. +

+
+

+ method +

+ 		+

+ Different methods supported by a context. +

+
+

+ native_handle_type +

+ 		+

+ The native handle type of the SSL context. +

+
+

+ options +

+ 		+

+ Bitmask type for SSL options. +

+
+

+ password_purpose +

+ 		+

+ Purpose of PEM password. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ add_certificate_authority +

+ 		+

+ Add certification authority for performing verification. +

+
+

+ add_verify_path +

+ 		+

+ Add a directory containing certificate authority files to be used + for performing verification. +

+
+

+ clear_options +

+ 		+

+ Clear options on the context. +

+
+

+ context + [constructor] +

+ 		+

+ Constructor.
—
Construct to take ownership of a native + handle.
—
Move-construct a context from another. +

+
+

+ load_verify_file +

+ 		+

+ Load a certification authority file for performing verification. +

+
+

+ native_handle +

+ 		+

+ Get the underlying implementation in the native type. +

+
+

+ operator= +

+ 		+

+ Move-assign a context from another. +

+
+

+ set_default_verify_paths +

+ 		+

+ Configures the context to use the default directories for finding + certification authority certificates. +

+
+

+ set_options +

+ 		+

+ Set options on the context. +

+
+

+ set_password_callback +

+ 		+

+ Set the password callback. +

+
+

+ set_verify_callback +

+ 		+

+ Set the callback used to verify peer certificates. +

+
+

+ set_verify_depth +

+ 		+

+ Set the peer verification depth. +

+
+

+ set_verify_mode +

+ 		+

+ Set the peer verification mode. +

+
+

+ use_certificate +

+ 		+

+ Use a certificate from a memory buffer. +

+
+

+ use_certificate_chain +

+ 		+

+ Use a certificate chain from a memory buffer. +

+
+

+ use_certificate_chain_file +

+ 		+

+ Use a certificate chain from a file. +

+
+

+ use_certificate_file +

+ 		+

+ Use a certificate from a file. +

+
+

+ use_private_key +

+ 		+

+ Use a private key from a memory buffer. +

+
+

+ use_private_key_file +

+ 		+

+ Use a private key from a file. +

+
+

+ use_rsa_private_key +

+ 		+

+ Use an RSA private key from a memory buffer. +

+
+

+ use_rsa_private_key_file +

+ 		+

+ Use an RSA private key from a file. +

+
+

+ use_tmp_dh +

+ 		+

+ Use the specified memory buffer to obtain the temporary Diffie-Hellman + parameters. +

+
+

+ use_tmp_dh_file +

+ 		+

+ Use the specified file to obtain the temporary Diffie-Hellman parameters. +

+
+

+ ~context [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_workarounds [static] +

+ 		+

+ Implement various bug workarounds. +

+
+

+ no_compression [static] +

+ 		+

+ Disable compression. Compression is disabled by default. +

+
+

+ no_sslv2 [static] +

+ 		+

+ Disable SSL v2. +

+
+

+ no_sslv3 [static] +

+ 		+

+ Disable SSL v3. +

+
+

+ no_tlsv1 [static] +

+ 		+

+ Disable TLS v1. +

+
+

+ no_tlsv1_1 [static] +

+ 		+

+ Disable TLS v1.1. +

+
+

+ no_tlsv1_2 [static] +

+ 		+

+ Disable TLS v1.2. +

+
+

+ no_tlsv1_3 [static] +

+ 		+

+ Disable TLS v1.3. +

+
+

+ single_dh_use [static] +

+ 		+

+ Always create a new key when using tmp_dh parameters. +

+
+
+ + Requirements +
+

+ Header: asio/ssl/context.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/_context.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/_context.html new file mode 100644 index 0000000..6cc6e1c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/_context.html @@ -0,0 +1,41 @@ + + + +ssl::context::~context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority.html new file mode 100644 index 0000000..641124a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority.html @@ -0,0 +1,49 @@ + + + +ssl::context::add_certificate_authority + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Add + certification authority for performing verification. +

+
void add_certificate_authority(
+    const const_buffer & ca);
+  » more...
+
+void add_certificate_authority(
+    const const_buffer & ca,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority/overload1.html new file mode 100644 index 0000000..75673d0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority/overload1.html @@ -0,0 +1,81 @@ + + + +ssl::context::add_certificate_authority (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add certification authority for performing verification. +

+
void add_certificate_authority(
+    const const_buffer & ca);
+
+

+ This function is used to add one trusted certification authority from + a memory buffer. +

+
+ + Parameters +
+
+

+
+
ca
+

+ The buffer containing the certification authority certificate. + The certificate must use the PEM format. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_get_cert_store + and X509_STORE_add_cert. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority/overload2.html new file mode 100644 index 0000000..fe31010 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_certificate_authority/overload2.html @@ -0,0 +1,73 @@ + + + +ssl::context::add_certificate_authority (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add certification authority for performing verification. +

+
void add_certificate_authority(
+    const const_buffer & ca,
+    asio::error_code & ec);
+
+

+ This function is used to add one trusted certification authority from + a memory buffer. +

+
+ + Parameters +
+
+

+
+
ca
+

+ The buffer containing the certification authority certificate. + The certificate must use the PEM format. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_get_cert_store + and X509_STORE_add_cert. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path.html new file mode 100644 index 0000000..4eac032 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path.html @@ -0,0 +1,50 @@ + + + +ssl::context::add_verify_path + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Add + a directory containing certificate authority files to be used for performing + verification. +

+
void add_verify_path(
+    const std::string & path);
+  » more...
+
+void add_verify_path(
+    const std::string & path,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path/overload1.html new file mode 100644 index 0000000..c2bc8ee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path/overload1.html @@ -0,0 +1,82 @@ + + + +ssl::context::add_verify_path (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add a directory containing certificate authority files to be used for + performing verification. +

+
void add_verify_path(
+    const std::string & path);
+
+

+ 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". +

+
+ + Parameters +
+
+

+
+
path
+

+ The name of a directory containing the certificates. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_load_verify_locations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path/overload2.html new file mode 100644 index 0000000..e9af91d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/add_verify_path/overload2.html @@ -0,0 +1,74 @@ + + + +ssl::context::add_verify_path (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Add a directory containing certificate authority files to be used for + performing verification. +

+
void add_verify_path(
+    const std::string & path,
+    asio::error_code & ec);
+
+

+ 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". +

+
+ + Parameters +
+
+

+
+
path
+

+ The name of a directory containing the certificates. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_load_verify_locations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options.html new file mode 100644 index 0000000..cb1c38c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options.html @@ -0,0 +1,49 @@ + + + +ssl::context::clear_options + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Clear + options on the context. +

+
void clear_options(
+    options o);
+  » more...
+
+void clear_options(
+    options o,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options/overload1.html new file mode 100644 index 0000000..17d6bb7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::context::clear_options (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Clear options on the context. +

+
void clear_options(
+    options o);
+
+

+ This function may be used to configure the SSL options used by the context. +

+
+ + Parameters +
+
+

+
+
o
+

+ A bitmask of options. The available option values are defined in + the ssl::context_base class. The + specified options, if currently enabled on the context, are cleared. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_clear_options. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options/overload2.html new file mode 100644 index 0000000..a362ff4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/clear_options/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::context::clear_options (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Clear options on the context. +

+
void clear_options(
+    options o,
+    asio::error_code & ec);
+
+

+ This function may be used to configure the SSL options used by the context. +

+
+ + Parameters +
+
+

+
+
o
+

+ A bitmask of options. The available option values are defined in + the ssl::context_base class. The + specified options, if currently enabled on the context, are cleared. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_clear_options. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context.html new file mode 100644 index 0000000..fc643c2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context.html @@ -0,0 +1,57 @@ + + + +ssl::context::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
explicit context(
+    method m);
+  » more...
+
+

+ Construct to take ownership of a native handle. +

+
explicit context(
+    native_handle_type native_handle);
+  » more...
+
+

+ Move-construct a context from another. +

+
context(
+    context && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload1.html new file mode 100644 index 0000000..728e406 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload1.html @@ -0,0 +1,42 @@ + + + +ssl::context::context (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor. +

+
context(
+    method m);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload2.html new file mode 100644 index 0000000..8d75b1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload2.html @@ -0,0 +1,42 @@ + + + +ssl::context::context (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct to take ownership of a native handle. +

+
context(
+    native_handle_type native_handle);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload3.html new file mode 100644 index 0000000..ba9894c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/context/overload3.html @@ -0,0 +1,69 @@ + + + +ssl::context::context (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a context from another. +

+
context(
+    context && other);
+
+

+ This constructor moves an SSL context from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other context object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the following operations only are valid for the moved-from + object: * Destruction. +

+
  • + As a target for move-assignment. +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/default_workarounds.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/default_workarounds.html new file mode 100644 index 0000000..f9440ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/default_workarounds.html @@ -0,0 +1,42 @@ + + + +ssl::context::default_workarounds + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Implement + various bug workarounds. +

+
static const uint64_t default_workarounds = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/file_format.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/file_format.html new file mode 100644 index 0000000..fda86f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/file_format.html @@ -0,0 +1,63 @@ + + + +ssl::context::file_format + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +File format + types. +

+
enum file_format
+
+

+ + +

+
+ + Values +
+
+

+
+
asn1
+

+ ASN.1 file. +

+
pem
+

+ PEM file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file.html new file mode 100644 index 0000000..e2809ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file.html @@ -0,0 +1,49 @@ + + + +ssl::context::load_verify_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Load + a certification authority file for performing verification. +

+
void load_verify_file(
+    const std::string & filename);
+  » more...
+
+void load_verify_file(
+    const std::string & filename,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file/overload1.html new file mode 100644 index 0000000..a8f20ba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::context::load_verify_file (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Load a certification authority file for performing verification. +

+
void load_verify_file(
+    const std::string & filename);
+
+

+ This function is used to load one or more trusted certification authorities + from a file. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of a file containing certification authority certificates + in PEM format. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_load_verify_locations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file/overload2.html new file mode 100644 index 0000000..ba05b71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/load_verify_file/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::context::load_verify_file (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Load a certification authority file for performing verification. +

+
void load_verify_file(
+    const std::string & filename,
+    asio::error_code & ec);
+
+

+ This function is used to load the certificates for one or more trusted + certification authorities from a file. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of a file containing certification authority certificates + in PEM format. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_load_verify_locations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/method.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/method.html new file mode 100644 index 0000000..39b07b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/method.html @@ -0,0 +1,173 @@ + + + +ssl::context::method + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Different methods supported + by a context. +

+
enum method
+
+

+ + + + + + + + + + + + + + + + + + + + + + + + +

+
+ + Values +
+
+

+
+
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. +

+
sslv3_server
+

+ SSL version 3 server. +

+
tlsv1
+

+ Generic TLS version 1. +

+
tlsv1_client
+

+ TLS version 1 client. +

+
tlsv1_server
+

+ TLS version 1 server. +

+
sslv23
+

+ Generic SSL/TLS. +

+
sslv23_client
+

+ SSL/TLS client. +

+
sslv23_server
+

+ SSL/TLS server. +

+
tlsv11
+

+ Generic TLS version 1.1. +

+
tlsv11_client
+

+ TLS version 1.1 client. +

+
tlsv11_server
+

+ TLS version 1.1 server. +

+
tlsv12
+

+ Generic TLS version 1.2. +

+
tlsv12_client
+

+ TLS version 1.2 client. +

+
tlsv12_server
+

+ TLS version 1.2 server. +

+
tlsv13
+

+ Generic TLS version 1.3. +

+
tlsv13_client
+

+ TLS version 1.3 client. +

+
tlsv13_server
+

+ TLS version 1.3 server. +

+
tls
+

+ Generic TLS. +

+
tls_client
+

+ TLS client. +

+
tls_server
+

+ TLS server. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/native_handle.html new file mode 100644 index 0000000..6fcf026 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/native_handle.html @@ -0,0 +1,47 @@ + + + +ssl::context::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + underlying implementation in the native type. +

+
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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/native_handle_type.html new file mode 100644 index 0000000..f10abfc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/native_handle_type.html @@ -0,0 +1,52 @@ + + + +ssl::context::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native handle type of the SSL context. +

+
typedef SSL_CTX * native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/ssl/context.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_compression.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_compression.html new file mode 100644 index 0000000..f99fa19 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_compression.html @@ -0,0 +1,42 @@ + + + +ssl::context::no_compression + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + compression. Compression is disabled by default. +

+
static const uint64_t no_compression = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_sslv2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_sslv2.html new file mode 100644 index 0000000..5bec5ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_sslv2.html @@ -0,0 +1,41 @@ + + + +ssl::context::no_sslv2 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable SSL v2. +

+
static const uint64_t no_sslv2 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_sslv3.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_sslv3.html new file mode 100644 index 0000000..84bbe5e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_sslv3.html @@ -0,0 +1,41 @@ + + + +ssl::context::no_sslv3 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable SSL v3. +

+
static const uint64_t no_sslv3 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1.html new file mode 100644 index 0000000..7bab38b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1.html @@ -0,0 +1,41 @@ + + + +ssl::context::no_tlsv1 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable TLS v1. +

+
static const uint64_t no_tlsv1 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_1.html new file mode 100644 index 0000000..d1b8366 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_1.html @@ -0,0 +1,42 @@ + + + +ssl::context::no_tlsv1_1 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable TLS + v1.1. +

+
static const uint64_t no_tlsv1_1 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_2.html new file mode 100644 index 0000000..b454581 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_2.html @@ -0,0 +1,42 @@ + + + +ssl::context::no_tlsv1_2 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable TLS + v1.2. +

+
static const uint64_t no_tlsv1_2 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_3.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_3.html new file mode 100644 index 0000000..16f29c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/no_tlsv1_3.html @@ -0,0 +1,42 @@ + + + +ssl::context::no_tlsv1_3 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable TLS + v1.3. +

+
static const uint64_t no_tlsv1_3 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/operator_eq_.html new file mode 100644 index 0000000..0f042a8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/operator_eq_.html @@ -0,0 +1,70 @@ + + + +ssl::context::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a context from another. +

+
context & operator=(
+    context && other);
+
+

+ This assignment operator moves an SSL context from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other context object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the following operations only are valid for the moved-from + object: * Destruction. +

+
  • + As a target for move-assignment. +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/options.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/options.html new file mode 100644 index 0000000..b00b567 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/options.html @@ -0,0 +1,52 @@ + + + +ssl::context::options + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bitmask type for + SSL options. +

+
typedef uint64_t options;
+
+
+ + Requirements +
+

+ Header: asio/ssl/context.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/password_purpose.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/password_purpose.html new file mode 100644 index 0000000..0fcb88e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/password_purpose.html @@ -0,0 +1,63 @@ + + + +ssl::context::password_purpose + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Purpose + of PEM password. +

+
enum password_purpose
+
+

+ + +

+
+ + Values +
+
+

+
+
for_reading
+

+ The password is needed for reading/decryption. +

+
for_writing
+

+ The password is needed for writing/encryption. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths.html new file mode 100644 index 0000000..5bc61a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths.html @@ -0,0 +1,48 @@ + + + +ssl::context::set_default_verify_paths + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Configures + the context to use the default directories for finding certification authority + certificates. +

+
void set_default_verify_paths();
+  » more...
+
+void set_default_verify_paths(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths/overload1.html new file mode 100644 index 0000000..b00e0da --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths/overload1.html @@ -0,0 +1,66 @@ + + + +ssl::context::set_default_verify_paths (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Configures the context to use the default directories for finding certification + authority certificates. +

+
void set_default_verify_paths();
+
+

+ This function specifies that the context should use the default, system-dependent + directories for locating certification authority certificates. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_default_verify_paths. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths/overload2.html new file mode 100644 index 0000000..05af8d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_default_verify_paths/overload2.html @@ -0,0 +1,67 @@ + + + +ssl::context::set_default_verify_paths (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Configures the context to use the default directories for finding certification + authority certificates. +

+
void set_default_verify_paths(
+    asio::error_code & ec);
+
+

+ This function specifies that the context should use the default, system-dependent + directories for locating certification authority certificates. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_default_verify_paths. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options.html new file mode 100644 index 0000000..60e8222 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options.html @@ -0,0 +1,49 @@ + + + +ssl::context::set_options + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set options + on the context. +

+
void set_options(
+    options o);
+  » more...
+
+void set_options(
+    options o,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options/overload1.html new file mode 100644 index 0000000..0a81ff9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::context::set_options (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set options on the context. +

+
void set_options(
+    options o);
+
+

+ This function may be used to configure the SSL options used by the context. +

+
+ + Parameters +
+
+

+
+
o
+

+ A bitmask of options. The available option values are defined in + the ssl::context_base class. The + options are bitwise-ored with any existing value for the options. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_options. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options/overload2.html new file mode 100644 index 0000000..860d710 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_options/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::context::set_options (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set options on the context. +

+
void set_options(
+    options o,
+    asio::error_code & ec);
+
+

+ This function may be used to configure the SSL options used by the context. +

+
+ + Parameters +
+
+

+
+
o
+

+ A bitmask of options. The available option values are defined in + the 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. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_options. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback.html new file mode 100644 index 0000000..6b59b9f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback.html @@ -0,0 +1,53 @@ + + + +ssl::context::set_password_callback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the password callback. +

+
template<
+    typename PasswordCallback>
+void set_password_callback(
+    PasswordCallback callback);
+  » more...
+
+template<
+    typename PasswordCallback>
+void set_password_callback(
+    PasswordCallback callback,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback/overload1.html new file mode 100644 index 0000000..e777ff5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback/overload1.html @@ -0,0 +1,92 @@ + + + +ssl::context::set_password_callback (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the password callback. +

+
template<
+    typename PasswordCallback>
+void set_password_callback(
+    PasswordCallback callback);
+
+

+ This function is used to specify a callback function to obtain password + information about an encrypted key in PEM format. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_default_passwd_cb. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback/overload2.html new file mode 100644 index 0000000..d52d18d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_password_callback/overload2.html @@ -0,0 +1,84 @@ + + + +ssl::context::set_password_callback (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the password callback. +

+
template<
+    typename PasswordCallback>
+void set_password_callback(
+    PasswordCallback callback,
+    asio::error_code & ec);
+
+

+ This function is used to specify a callback function to obtain password + information about an encrypted key in PEM format. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_default_passwd_cb. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback.html new file mode 100644 index 0000000..f9c50e5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback.html @@ -0,0 +1,53 @@ + + + +ssl::context::set_verify_callback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the callback used to verify peer certificates. +

+
template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback);
+  » more...
+
+template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback/overload1.html new file mode 100644 index 0000000..1634d91 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback/overload1.html @@ -0,0 +1,93 @@ + + + +ssl::context::set_verify_callback (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the callback used to verify peer certificates. +

+
template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback);
+
+

+ This function is used to specify a callback function that will be called + by the implementation when it needs to verify a peer certificate. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback/overload2.html new file mode 100644 index 0000000..88ca5c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_callback/overload2.html @@ -0,0 +1,85 @@ + + + +ssl::context::set_verify_callback (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the callback used to verify peer certificates. +

+
template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth.html new file mode 100644 index 0000000..64b36a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth.html @@ -0,0 +1,49 @@ + + + +ssl::context::set_verify_depth + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the peer verification depth. +

+
void set_verify_depth(
+    int depth);
+  » more...
+
+void set_verify_depth(
+    int depth,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth/overload1.html new file mode 100644 index 0000000..d4e3277 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::context::set_verify_depth (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification depth. +

+
void set_verify_depth(
+    int depth);
+
+

+ This function may be used to configure the maximum verification depth + allowed by the context. +

+
+ + Parameters +
+
+

+
+
depth
+

+ Maximum depth for the certificate chain verification that shall + be allowed. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_verify_depth. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth/overload2.html new file mode 100644 index 0000000..9c75b16 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_depth/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::context::set_verify_depth (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification depth. +

+
void set_verify_depth(
+    int depth,
+    asio::error_code & ec);
+
+

+ This function may be used to configure the maximum verification depth + allowed by the context. +

+
+ + Parameters +
+
+

+
+
depth
+

+ Maximum depth for the certificate chain verification that shall + be allowed. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_verify_depth. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode.html new file mode 100644 index 0000000..46176de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode.html @@ -0,0 +1,49 @@ + + + +ssl::context::set_verify_mode + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the peer verification mode. +

+
void set_verify_mode(
+    verify_mode v);
+  » more...
+
+void set_verify_mode(
+    verify_mode v,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode/overload1.html new file mode 100644 index 0000000..3e5f753 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::context::set_verify_mode (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification mode. +

+
void set_verify_mode(
+    verify_mode v);
+
+

+ This function may be used to configure the peer verification mode used + by the context. +

+
+ + Parameters +
+
+

+
+
v
+

+ A bitmask of peer verification modes. See ssl::verify_mode for available + values. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode/overload2.html new file mode 100644 index 0000000..db07eb5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/set_verify_mode/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::context::set_verify_mode (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification mode. +

+
void set_verify_mode(
+    verify_mode v,
+    asio::error_code & ec);
+
+

+ This function may be used to configure the peer verification mode used + by the context. +

+
+ + Parameters +
+
+

+
+
v
+

+ A bitmask of peer verification modes. See ssl::verify_mode for available + values. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/single_dh_use.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/single_dh_use.html new file mode 100644 index 0000000..f1d3ac0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/single_dh_use.html @@ -0,0 +1,42 @@ + + + +ssl::context::single_dh_use + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Always + create a new key when using tmp_dh parameters. +

+
static const uint64_t single_dh_use = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate.html new file mode 100644 index 0000000..c96e83c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate.html @@ -0,0 +1,51 @@ + + + +ssl::context::use_certificate + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + a certificate from a memory buffer. +

+
void use_certificate(
+    const const_buffer & certificate,
+    file_format format);
+  » more...
+
+void use_certificate(
+    const const_buffer & certificate,
+    file_format format,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate/overload1.html new file mode 100644 index 0000000..b873839 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate/overload1.html @@ -0,0 +1,84 @@ + + + +ssl::context::use_certificate (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a certificate from a memory buffer. +

+
void use_certificate(
+    const const_buffer & certificate,
+    file_format format);
+
+

+ This function is used to load a certificate into the context from a buffer. +

+
+ + Parameters +
+
+

+
+
certificate
+

+ The buffer containing the certificate. +

+
format
+

+ The certificate format (ASN.1 or PEM). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate + or SSL_CTX_use_certificate_ASN1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate/overload2.html new file mode 100644 index 0000000..055031f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate/overload2.html @@ -0,0 +1,76 @@ + + + +ssl::context::use_certificate (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a certificate from a memory buffer. +

+
void use_certificate(
+    const const_buffer & certificate,
+    file_format format,
+    asio::error_code & ec);
+
+

+ This function is used to load a certificate into the context from a buffer. +

+
+ + Parameters +
+
+

+
+
certificate
+

+ The buffer containing the certificate. +

+
format
+

+ The certificate format (ASN.1 or PEM). +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate + or SSL_CTX_use_certificate_ASN1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain.html new file mode 100644 index 0000000..06d5cb0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain.html @@ -0,0 +1,49 @@ + + + +ssl::context::use_certificate_chain + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + a certificate chain from a memory buffer. +

+
void use_certificate_chain(
+    const const_buffer & chain);
+  » more...
+
+void use_certificate_chain(
+    const const_buffer & chain,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain/overload1.html new file mode 100644 index 0000000..1d17e90 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain/overload1.html @@ -0,0 +1,81 @@ + + + +ssl::context::use_certificate_chain (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a certificate chain from a memory buffer. +

+
void use_certificate_chain(
+    const const_buffer & chain);
+
+

+ This function is used to load a certificate chain into the context from + a buffer. +

+
+ + Parameters +
+
+

+
+
chain
+

+ The buffer containing the certificate chain. The certificate chain + must use the PEM format. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate + and SSL_CTX_add_extra_chain_cert. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain/overload2.html new file mode 100644 index 0000000..92705af --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain/overload2.html @@ -0,0 +1,73 @@ + + + +ssl::context::use_certificate_chain (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a certificate chain from a memory buffer. +

+
void use_certificate_chain(
+    const const_buffer & chain,
+    asio::error_code & ec);
+
+

+ This function is used to load a certificate chain into the context from + a buffer. +

+
+ + Parameters +
+
+

+
+
chain
+

+ The buffer containing the certificate chain. The certificate chain + must use the PEM format. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate + and SSL_CTX_add_extra_chain_cert. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file.html new file mode 100644 index 0000000..c7281a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file.html @@ -0,0 +1,49 @@ + + + +ssl::context::use_certificate_chain_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + a certificate chain from a file. +

+
void use_certificate_chain_file(
+    const std::string & filename);
+  » more...
+
+void use_certificate_chain_file(
+    const std::string & filename,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file/overload1.html new file mode 100644 index 0000000..6b62989 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::context::use_certificate_chain_file (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a certificate chain from a file. +

+
void use_certificate_chain_file(
+    const std::string & filename);
+
+

+ This function is used to load a certificate chain into the context from + a file. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of the file containing the certificate. The file must + use the PEM format. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate_chain_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file/overload2.html new file mode 100644 index 0000000..dd8d227 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_chain_file/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::context::use_certificate_chain_file (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a certificate chain from a file. +

+
void use_certificate_chain_file(
+    const std::string & filename,
+    asio::error_code & ec);
+
+

+ This function is used to load a certificate chain into the context from + a file. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate_chain_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file.html new file mode 100644 index 0000000..cefc9b2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file.html @@ -0,0 +1,51 @@ + + + +ssl::context::use_certificate_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + a certificate from a file. +

+
void use_certificate_file(
+    const std::string & filename,
+    file_format format);
+  » more...
+
+void use_certificate_file(
+    const std::string & filename,
+    file_format format,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file/overload1.html new file mode 100644 index 0000000..c6353d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file/overload1.html @@ -0,0 +1,83 @@ + + + +ssl::context::use_certificate_file (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of the file containing the certificate. +

+
format
+

+ The file format (ASN.1 or PEM). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file/overload2.html new file mode 100644 index 0000000..12e355d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_certificate_file/overload2.html @@ -0,0 +1,75 @@ + + + +ssl::context::use_certificate_file (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a certificate from a file. +

+
void use_certificate_file(
+    const std::string & filename,
+    file_format format,
+    asio::error_code & ec);
+
+

+ This function is used to load a certificate into the context from a file. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_certificate_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key.html new file mode 100644 index 0000000..2d3873c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key.html @@ -0,0 +1,51 @@ + + + +ssl::context::use_private_key + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + a private key from a memory buffer. +

+
void use_private_key(
+    const const_buffer & private_key,
+    file_format format);
+  » more...
+
+void use_private_key(
+    const const_buffer & private_key,
+    file_format format,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key/overload1.html new file mode 100644 index 0000000..fa5ac84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key/overload1.html @@ -0,0 +1,84 @@ + + + +ssl::context::use_private_key (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a private key from a memory buffer. +

+
void use_private_key(
+    const const_buffer & private_key,
+    file_format format);
+
+

+ This function is used to load a private key into the context from a buffer. +

+
+ + Parameters +
+
+

+
+
private_key
+

+ The buffer containing the private key. +

+
format
+

+ The private key format (ASN.1 or PEM). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_PrivateKey + or SSL_CTX_use_PrivateKey_ASN1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key/overload2.html new file mode 100644 index 0000000..808468a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key/overload2.html @@ -0,0 +1,76 @@ + + + +ssl::context::use_private_key (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a private key from a memory buffer. +

+
void use_private_key(
+    const const_buffer & private_key,
+    file_format format,
+    asio::error_code & ec);
+
+

+ This function is used to load a private key into the context from a buffer. +

+
+ + Parameters +
+
+

+
+
private_key
+

+ The buffer containing the private key. +

+
format
+

+ The private key format (ASN.1 or PEM). +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_PrivateKey + or SSL_CTX_use_PrivateKey_ASN1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file.html new file mode 100644 index 0000000..e775a9d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file.html @@ -0,0 +1,51 @@ + + + +ssl::context::use_private_key_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + a private key from a file. +

+
void use_private_key_file(
+    const std::string & filename,
+    file_format format);
+  » more...
+
+void use_private_key_file(
+    const std::string & filename,
+    file_format format,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file/overload1.html new file mode 100644 index 0000000..22d6b48 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file/overload1.html @@ -0,0 +1,83 @@ + + + +ssl::context::use_private_key_file (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a private key from a file. +

+
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. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of the file containing the private key. +

+
format
+

+ The file format (ASN.1 or PEM). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_PrivateKey_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file/overload2.html new file mode 100644 index 0000000..e9a9d2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_private_key_file/overload2.html @@ -0,0 +1,75 @@ + + + +ssl::context::use_private_key_file (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use a private key from a file. +

+
void use_private_key_file(
+    const std::string & filename,
+    file_format format,
+    asio::error_code & ec);
+
+

+ This function is used to load a private key into the context from a file. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_PrivateKey_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key.html new file mode 100644 index 0000000..4ce2927 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key.html @@ -0,0 +1,51 @@ + + + +ssl::context::use_rsa_private_key + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + an RSA private key from a memory buffer. +

+
void use_rsa_private_key(
+    const const_buffer & private_key,
+    file_format format);
+  » more...
+
+void use_rsa_private_key(
+    const const_buffer & private_key,
+    file_format format,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key/overload1.html new file mode 100644 index 0000000..c349679 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key/overload1.html @@ -0,0 +1,85 @@ + + + +ssl::context::use_rsa_private_key (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use an RSA private key from a memory buffer. +

+
void use_rsa_private_key(
+    const const_buffer & private_key,
+    file_format format);
+
+

+ This function is used to load an RSA private key into the context from + a buffer. +

+
+ + Parameters +
+
+

+
+
private_key
+

+ The buffer containing the RSA private key. +

+
format
+

+ The private key format (ASN.1 or PEM). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_RSAPrivateKey + or SSL_CTX_use_RSAPrivateKey_ASN1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key/overload2.html new file mode 100644 index 0000000..de0ca98 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key/overload2.html @@ -0,0 +1,77 @@ + + + +ssl::context::use_rsa_private_key (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use an RSA private key from a memory buffer. +

+
void use_rsa_private_key(
+    const const_buffer & private_key,
+    file_format format,
+    asio::error_code & ec);
+
+

+ This function is used to load an RSA private key into the context from + a buffer. +

+
+ + Parameters +
+
+

+
+
private_key
+

+ The buffer containing the RSA private key. +

+
format
+

+ The private key format (ASN.1 or PEM). +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_RSAPrivateKey + or SSL_CTX_use_RSAPrivateKey_ASN1. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file.html new file mode 100644 index 0000000..aa3993c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file.html @@ -0,0 +1,51 @@ + + + +ssl::context::use_rsa_private_key_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + an RSA private key from a file. +

+
void use_rsa_private_key_file(
+    const std::string & filename,
+    file_format format);
+  » more...
+
+void use_rsa_private_key_file(
+    const std::string & filename,
+    file_format format,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file/overload1.html new file mode 100644 index 0000000..089f23c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file/overload1.html @@ -0,0 +1,84 @@ + + + +ssl::context::use_rsa_private_key_file (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use an RSA private key from a file. +

+
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. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of the file containing the RSA private key. +

+
format
+

+ The file format (ASN.1 or PEM). +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_RSAPrivateKey_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file/overload2.html new file mode 100644 index 0000000..bb10f95 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_rsa_private_key_file/overload2.html @@ -0,0 +1,76 @@ + + + +ssl::context::use_rsa_private_key_file (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use an RSA private key from a file. +

+
void use_rsa_private_key_file(
+    const std::string & filename,
+    file_format format,
+    asio::error_code & ec);
+
+

+ This function is used to load an RSA private key into the context from + a file. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of the file containing the RSA private key. +

+
format
+

+ The file format (ASN.1 or PEM). +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_use_RSAPrivateKey_file. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh.html new file mode 100644 index 0000000..a627053 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh.html @@ -0,0 +1,49 @@ + + + +ssl::context::use_tmp_dh + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use the specified + memory buffer to obtain the temporary Diffie-Hellman parameters. +

+
void use_tmp_dh(
+    const const_buffer & dh);
+  » more...
+
+void use_tmp_dh(
+    const const_buffer & dh,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh/overload1.html new file mode 100644 index 0000000..be6abbd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh/overload1.html @@ -0,0 +1,81 @@ + + + +ssl::context::use_tmp_dh (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use the specified memory buffer to obtain the temporary Diffie-Hellman + parameters. +

+
void use_tmp_dh(
+    const const_buffer & dh);
+
+

+ This function is used to load Diffie-Hellman parameters into the context + from a buffer. +

+
+ + Parameters +
+
+

+
+
dh
+

+ The memory buffer containing the Diffie-Hellman parameters. The + buffer must use the PEM format. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_tmp_dh. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh/overload2.html new file mode 100644 index 0000000..3b831f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh/overload2.html @@ -0,0 +1,73 @@ + + + +ssl::context::use_tmp_dh (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use the specified memory buffer to obtain the temporary Diffie-Hellman + parameters. +

+
void use_tmp_dh(
+    const const_buffer & dh,
+    asio::error_code & ec);
+
+

+ This function is used to load Diffie-Hellman parameters into the context + from a buffer. +

+
+ + Parameters +
+
+

+
+
dh
+

+ The memory buffer containing the Diffie-Hellman parameters. The + buffer must use the PEM format. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_tmp_dh. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file.html new file mode 100644 index 0000000..6b838de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file.html @@ -0,0 +1,49 @@ + + + +ssl::context::use_tmp_dh_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Use + the specified file to obtain the temporary Diffie-Hellman parameters. +

+
void use_tmp_dh_file(
+    const std::string & filename);
+  » more...
+
+void use_tmp_dh_file(
+    const std::string & filename,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file/overload1.html new file mode 100644 index 0000000..07c8ce8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::context::use_tmp_dh_file (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use the specified file to obtain the temporary Diffie-Hellman parameters. +

+
void use_tmp_dh_file(
+    const std::string & filename);
+
+

+ This function is used to load Diffie-Hellman parameters into the context + from a file. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of the file containing the Diffie-Hellman parameters. + The file must use the PEM format. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_tmp_dh. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file/overload2.html new file mode 100644 index 0000000..ae3ec65 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context/use_tmp_dh_file/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::context::use_tmp_dh_file (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Use the specified file to obtain the temporary Diffie-Hellman parameters. +

+
void use_tmp_dh_file(
+    const std::string & filename,
+    asio::error_code & ec);
+
+

+ This function is used to load Diffie-Hellman parameters into the context + from a file. +

+
+ + Parameters +
+
+

+
+
filename
+

+ The name of the file containing the Diffie-Hellman parameters. + The file must use the PEM format. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_CTX_set_tmp_dh. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base.html new file mode 100644 index 0000000..6bfccaf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base.html @@ -0,0 +1,295 @@ + + + +ssl::context_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The 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
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ file_format +

+ 		+

+ File format types. +

+
+

+ method +

+ 		+

+ Different methods supported by a context. +

+
+

+ options +

+ 		+

+ Bitmask type for SSL options. +

+
+

+ password_purpose +

+ 		+

+ Purpose of PEM password. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~context_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_workarounds [static] +

+ 		+

+ Implement various bug workarounds. +

+
+

+ no_compression [static] +

+ 		+

+ Disable compression. Compression is disabled by default. +

+
+

+ no_sslv2 [static] +

+ 		+

+ Disable SSL v2. +

+
+

+ no_sslv3 [static] +

+ 		+

+ Disable SSL v3. +

+
+

+ no_tlsv1 [static] +

+ 		+

+ Disable TLS v1. +

+
+

+ no_tlsv1_1 [static] +

+ 		+

+ Disable TLS v1.1. +

+
+

+ no_tlsv1_2 [static] +

+ 		+

+ Disable TLS v1.2. +

+
+

+ no_tlsv1_3 [static] +

+ 		+

+ Disable TLS v1.3. +

+
+

+ single_dh_use [static] +

+ 		+

+ Always create a new key when using tmp_dh parameters. +

+
+
+ + Requirements +
+

+ Header: asio/ssl/context_base.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/_context_base.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/_context_base.html new file mode 100644 index 0000000..e16b649 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/_context_base.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::~context_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~context_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/default_workarounds.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/default_workarounds.html new file mode 100644 index 0000000..54feed6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/default_workarounds.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::default_workarounds + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Implement + various bug workarounds. +

+
static const uint64_t default_workarounds = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/file_format.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/file_format.html new file mode 100644 index 0000000..0c6444e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/file_format.html @@ -0,0 +1,63 @@ + + + +ssl::context_base::file_format + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +File + format types. +

+
enum file_format
+
+

+ + +

+
+ + Values +
+
+

+
+
asn1
+

+ ASN.1 file. +

+
pem
+

+ PEM file. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/method.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/method.html new file mode 100644 index 0000000..aaefc04 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/method.html @@ -0,0 +1,173 @@ + + + +ssl::context_base::method + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Different + methods supported by a context. +

+
enum method
+
+

+ + + + + + + + + + + + + + + + + + + + + + + + +

+
+ + Values +
+
+

+
+
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. +

+
sslv3_server
+

+ SSL version 3 server. +

+
tlsv1
+

+ Generic TLS version 1. +

+
tlsv1_client
+

+ TLS version 1 client. +

+
tlsv1_server
+

+ TLS version 1 server. +

+
sslv23
+

+ Generic SSL/TLS. +

+
sslv23_client
+

+ SSL/TLS client. +

+
sslv23_server
+

+ SSL/TLS server. +

+
tlsv11
+

+ Generic TLS version 1.1. +

+
tlsv11_client
+

+ TLS version 1.1 client. +

+
tlsv11_server
+

+ TLS version 1.1 server. +

+
tlsv12
+

+ Generic TLS version 1.2. +

+
tlsv12_client
+

+ TLS version 1.2 client. +

+
tlsv12_server
+

+ TLS version 1.2 server. +

+
tlsv13
+

+ Generic TLS version 1.3. +

+
tlsv13_client
+

+ TLS version 1.3 client. +

+
tlsv13_server
+

+ TLS version 1.3 server. +

+
tls
+

+ Generic TLS. +

+
tls_client
+

+ TLS client. +

+
tls_server
+

+ TLS server. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_compression.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_compression.html new file mode 100644 index 0000000..5f8b6ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_compression.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::no_compression + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + compression. Compression is disabled by default. +

+
static const uint64_t no_compression = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_sslv2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_sslv2.html new file mode 100644 index 0000000..ed7d251 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_sslv2.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::no_sslv2 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + SSL v2. +

+
static const uint64_t no_sslv2 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_sslv3.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_sslv3.html new file mode 100644 index 0000000..66880ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_sslv3.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::no_sslv3 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + SSL v3. +

+
static const uint64_t no_sslv3 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1.html new file mode 100644 index 0000000..6fa1767 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::no_tlsv1 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + TLS v1. +

+
static const uint64_t no_tlsv1 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_1.html new file mode 100644 index 0000000..5ecd80f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_1.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::no_tlsv1_1 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + TLS v1.1. +

+
static const uint64_t no_tlsv1_1 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_2.html new file mode 100644 index 0000000..e8279ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_2.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::no_tlsv1_2 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + TLS v1.2. +

+
static const uint64_t no_tlsv1_2 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_3.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_3.html new file mode 100644 index 0000000..ccc61e7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/no_tlsv1_3.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::no_tlsv1_3 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Disable + TLS v1.3. +

+
static const uint64_t no_tlsv1_3 = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/options.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/options.html new file mode 100644 index 0000000..abf554a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/options.html @@ -0,0 +1,52 @@ + + + +ssl::context_base::options + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Bitmask + type for SSL options. +

+
typedef uint64_t options;
+
+
+ + Requirements +
+

+ Header: asio/ssl/context_base.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/password_purpose.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/password_purpose.html new file mode 100644 index 0000000..e548a47 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/password_purpose.html @@ -0,0 +1,63 @@ + + + +ssl::context_base::password_purpose + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Purpose + of PEM password. +

+
enum password_purpose
+
+

+ + +

+
+ + Values +
+
+

+
+
for_reading
+

+ The password is needed for reading/decryption. +

+
for_writing
+

+ The password is needed for writing/encryption. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/single_dh_use.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/single_dh_use.html new file mode 100644 index 0000000..2d055ae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__context_base/single_dh_use.html @@ -0,0 +1,42 @@ + + + +ssl::context_base::single_dh_use + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Always + create a new key when using tmp_dh parameters. +

+
static const uint64_t single_dh_use = implementation_defined;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__error__get_stream_category.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__get_stream_category.html new file mode 100644 index 0000000..84fa553 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__get_stream_category.html @@ -0,0 +1,50 @@ + + + +ssl::error::get_stream_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
const asio::error_category & get_stream_category();
+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__error__make_error_code.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__make_error_code.html new file mode 100644 index 0000000..9fae483 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__make_error_code.html @@ -0,0 +1,51 @@ + + + +ssl::error::make_error_code + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
asio::error_code make_error_code(
+    stream_errors e);
+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_category.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_category.html new file mode 100644 index 0000000..7a588f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_category.html @@ -0,0 +1,50 @@ + + + +ssl::error::stream_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const asio::error_category & stream_category = asio::ssl::error::get_stream_category();
+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors.html new file mode 100644 index 0000000..a82ed29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors.html @@ -0,0 +1,79 @@ + + + +ssl::error::stream_errors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
enum stream_errors
+
+

+ + + +

+
+ + Values +
+
+

+
+
stream_truncated
+

+ The underlying stream closed before the ssl stream gracefully shut + down. +

+
unspecified_system_error
+

+ The underlying SSL library returned a system error without providing + further information. +

+
unexpected_result
+

+ The underlying SSL library generated an unexpected result from a function + call. +

+
+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors__gt_.html new file mode 100644 index 0000000..b80f09e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors__gt_.html @@ -0,0 +1,84 @@ + + + +ssl::error::stream_errors > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
template<>
+struct is_error_code_enum< asio::ssl::error::stream_errors >
+
+
+ + Data + Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ value [static] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/ssl/error.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors__gt_/value.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors__gt_/value.html new file mode 100644 index 0000000..ba1273d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__error__stream_errors__gt_/value.html @@ -0,0 +1,41 @@ + + + +ssl::error::stream_errors >::value + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
static const bool value = true;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification.html new file mode 100644 index 0000000..377e986 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification.html @@ -0,0 +1,168 @@ + + + +ssl::host_name_verification + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Verifies a certificate against a host_name according to the rules described + in RFC 6125. +

+
class host_name_verification
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ result_type +

+ 		+

+ The type of the function object's result. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ host_name_verification [constructor] +

+ 		+

+ Constructor. +

+
+

+ operator() +

+ 		+

+ Perform certificate verification. +

+
+
+ + Example +
+

+ The following example shows how to synchronously open a secure connection + to a given host name: +

+
using asio::ip::tcp;
+namespace ssl = 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.
+asio::io_context io_context;
+ssl_socket sock(io_context, ctx);
+tcp::resolver resolver(io_context);
+tcp::resolver::query query("host.name", "https");
+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::host_name_verification("host.name"));
+sock.handshake(ssl_socket::client);
+
+// ... read and write as normal ...
+
+
+ + Requirements +
+

+ Header: asio/ssl/host_name_verification.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/host_name_verification.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/host_name_verification.html new file mode 100644 index 0000000..3e17be7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/host_name_verification.html @@ -0,0 +1,42 @@ + + + +ssl::host_name_verification::host_name_verification + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
host_name_verification(
+    const std::string & host);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/operator_lp__rp_.html new file mode 100644 index 0000000..00cb938 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/operator_lp__rp_.html @@ -0,0 +1,44 @@ + + + +ssl::host_name_verification::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + certificate verification. +

+
bool operator()(
+    bool preverified,
+    verify_context & ctx) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/result_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/result_type.html new file mode 100644 index 0000000..0de4968 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__host_name_verification/result_type.html @@ -0,0 +1,52 @@ + + + +ssl::host_name_verification::result_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the function object's result. +

+
typedef bool result_type;
+
+
+ + Requirements +
+

+ Header: asio/ssl/host_name_verification.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream.html new file mode 100644 index 0000000..333123f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream.html @@ -0,0 +1,426 @@ + + + +ssl::stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides stream-oriented functionality using SSL. +

+
template<
+    typename Stream>
+class stream :
+  public ssl::stream_base,
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ impl_struct +

+ 		+

+ Structure for use with deprecated impl_type. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ handshake_type +

+ 		+

+ Different handshake types. +

+
+

+ lowest_layer_type +

+ 		+

+ The type of the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native handle type of the SSL stream. +

+
+

+ next_layer_type +

+ 		+

+ The type of the next layer. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_handshake +

+ 		+

+ Start an asynchronous SSL handshake. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_shutdown +

+ 		+

+ Asynchronously shut down SSL on the stream. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ handshake +

+ 		+

+ Perform SSL handshaking. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the underlying implementation in the native type. +

+
+

+ next_layer +

+ 		+

+ Get a reference to the next layer. +

+
+

+ operator= +

+ 		+

+ Move-assign a stream from another. +

+
+

+ read_some +

+ 		+

+ Read some data from the stream. +

+
+

+ set_verify_callback +

+ 		+

+ Set the callback used to verify peer certificates. +

+
+

+ set_verify_depth +

+ 		+

+ Set the peer verification depth. +

+
+

+ set_verify_mode +

+ 		+

+ Set the peer verification mode. +

+
+

+ shutdown +

+ 		+

+ Shut down SSL on the stream. +

+
+

+ stream + [constructor] +

+ 		+

+ Construct a stream.
—
Construct a stream from an existing + native implementation.
—
Move-construct a stream from + another. +

+
+

+ write_some +

+ 		+

+ Write some data to the stream. +

+
+

+ ~stream + [destructor] +

+ 		+

+ Destructor. +

+
+

+ The stream class template provides asynchronous and blocking stream-oriented + functionality using SSL. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. The application + must also ensure that all asynchronous operations are performed within the + same implicit or explicit strand. +

+
+ + Example +
+

+ To use the SSL stream template with an ip::tcp::socket, you would write: +

+
asio::io_context my_context;
+asio::ssl::context ctx(asio::ssl::context::sslv23);
+asio::ssl::stream<asio::ip::tcp::socket> sock(my_context, ctx);
+
+
+ + Requirements +
+

+ Header: asio/ssl/stream.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/_stream.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/_stream.html new file mode 100644 index 0000000..84dbc71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/_stream.html @@ -0,0 +1,50 @@ + + + +ssl::stream::~stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~stream();
+
+
+ + Remarks +
+

+ A stream object must not + be destroyed while there are pending asynchronous operations associated + with it. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake.html new file mode 100644 index 0000000..ec623cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake.html @@ -0,0 +1,57 @@ + + + +ssl::stream::async_handshake + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous SSL handshake. +

+
template<
+    typename HandshakeToken = default_completion_token_t<executor_type>>
+DEDUCED async_handshake(
+    handshake_type type,
+    HandshakeToken && token = default_completion_token_t< executor_type >());
+  » more...
+
+template<
+    typename ConstBufferSequence,
+    typename BufferedHandshakeToken = default_completion_token_t<executor_type>>
+DEDUCED async_handshake(
+    handshake_type type,
+    const ConstBufferSequence & buffers,
+    BufferedHandshakeToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake/overload1.html new file mode 100644 index 0000000..27b588d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake/overload1.html @@ -0,0 +1,116 @@ + + + +ssl::stream::async_handshake (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous SSL handshake. +

+
template<
+    typename HandshakeToken = default_completion_token_t<executor_type>>
+DEDUCED async_handshake(
+    handshake_type type,
+    HandshakeToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously perform an SSL handshake on the + stream. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
type
+

+ The type of handshaking to be performed, i.e. as a client or as + a server. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the handshake completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following + cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the Stream + type's async_read_some + and async_write_some + operations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake/overload2.html new file mode 100644 index 0000000..bc2b354 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_handshake/overload2.html @@ -0,0 +1,127 @@ + + + +ssl::stream::async_handshake (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Start an asynchronous SSL handshake. +

+
template<
+    typename ConstBufferSequence,
+    typename BufferedHandshakeToken = default_completion_token_t<executor_type>>
+DEDUCED async_handshake(
+    handshake_type type,
+    const ConstBufferSequence & buffers,
+    BufferedHandshakeToken && token = default_completion_token_t< executor_type >(),
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0);
+
+

+ This function is used to asynchronously perform an SSL handshake on the + stream. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
type
+

+ The type of handshaking to be performed, i.e. as a client or as + a server. +

+
buffers
+

+ The buffered data to be reused for the handshake. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, + which will be called when the handshake completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error, // Result of operation.
+  std::size_t bytes_transferred // Amount of buffers used in handshake.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within + this function. On immediate completion, invocation of the handler + will be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following + cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the Stream + type's async_read_some + and async_write_some + operations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_read_some.html new file mode 100644 index 0000000..61e5ece --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_read_some.html @@ -0,0 +1,131 @@ + + + +ssl::stream::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read one or more bytes of data + from the stream. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_read_some operation may not read all of the requested number + of bytes. Consider using the async_read function if you need + to ensure that the requested amount of data is read before the asynchronous + operation completes. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the Stream + type's async_read_some + and async_write_some operations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_shutdown.html new file mode 100644 index 0000000..cef97ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_shutdown.html @@ -0,0 +1,109 @@ + + + +ssl::stream::async_shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Asynchronously + shut down SSL on the stream. +

+
template<
+    typename ShutdownToken = default_completion_token_t<executor_type>>
+DEDUCED async_shutdown(
+    ShutdownToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously shut down SSL on the stream. It + is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the shutdown completes. Potential completion + tokens include use_future, use_awaitable, yield_context, or a function + object with the correct completion signature. The function signature + of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the Stream + type's async_read_some + and async_write_some operations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_write_some.html new file mode 100644 index 0000000..c7c5f2d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/async_write_some.html @@ -0,0 +1,130 @@ + + + +ssl::stream::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write one or more bytes of data + to the stream. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The async_write_some operation may not transmit all of the data to the + peer. Consider using the async_write function if you need + to ensure that all data is written before the asynchronous operation completes. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
+

+ if they are also supported by the Stream + type's async_read_some + and async_write_some operations. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/executor_type.html new file mode 100644 index 0000000..3e2d084 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/executor_type.html @@ -0,0 +1,52 @@ + + + +ssl::stream::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + of the executor associated with the object. +

+
typedef lowest_layer_type::executor_type executor_type;
+
+
+ + Requirements +
+

+ Header: asio/ssl/stream.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/get_executor.html new file mode 100644 index 0000000..478b001 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/get_executor.html @@ -0,0 +1,53 @@ + + + +ssl::stream::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the executor + associated with the object. +

+
executor_type get_executor();
+
+

+ This function may be used to obtain the executor object that the stream + uses to dispatch handlers for asynchronous operations. +

+
+ + Return Value +
+

+ A copy of the executor that stream will use to dispatch handlers. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake.html new file mode 100644 index 0000000..79c4d25 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake.html @@ -0,0 +1,63 @@ + + + +ssl::stream::handshake + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform SSL handshaking. +

+
void handshake(
+    handshake_type type);
+  » more...
+
+void handshake(
+    handshake_type type,
+    asio::error_code & ec);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+void handshake(
+    handshake_type type,
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+void handshake(
+    handshake_type type,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload1.html new file mode 100644 index 0000000..a2dfc77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload1.html @@ -0,0 +1,73 @@ + + + +ssl::stream::handshake (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
type
+

+ The type of handshaking to be performed, i.e. as a client or as + a server. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload2.html new file mode 100644 index 0000000..857671c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload2.html @@ -0,0 +1,65 @@ + + + +ssl::stream::handshake (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform SSL handshaking. +

+
void handshake(
+    handshake_type type,
+    asio::error_code & ec);
+
+

+ This function is used to perform SSL handshaking on the stream. The function + call will block until handshaking is complete or an error occurs. +

+
+ + Parameters +
+
+

+
+
type
+

+ The type of handshaking to be performed, i.e. as a client or as + a server. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload3.html new file mode 100644 index 0000000..f2f4912 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload3.html @@ -0,0 +1,80 @@ + + + +ssl::stream::handshake (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform SSL handshaking. +

+
template<
+    typename ConstBufferSequence>
+void handshake(
+    handshake_type type,
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to perform SSL handshaking on the stream. The function + call will block until handshaking is complete or an error occurs. +

+
+ + Parameters +
+
+

+
+
type
+

+ The type of handshaking to be performed, i.e. as a client or as + a server. +

+
buffers
+

+ The buffered data to be reused for the handshake. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload4.html new file mode 100644 index 0000000..dc3c736 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake/overload4.html @@ -0,0 +1,72 @@ + + + +ssl::stream::handshake (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform SSL handshaking. +

+
template<
+    typename ConstBufferSequence>
+void handshake(
+    handshake_type type,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to perform SSL handshaking on the stream. The function + call will block until handshaking is complete or an error occurs. +

+
+ + Parameters +
+
+

+
+
type
+

+ The type of handshaking to be performed, i.e. as a client or as + a server. +

+
buffers
+

+ The buffered data to be reused for the handshake. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake_type.html new file mode 100644 index 0000000..c339feb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/handshake_type.html @@ -0,0 +1,63 @@ + + + +ssl::stream::handshake_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Different + handshake types. +

+
enum handshake_type
+
+

+ + +

+
+ + Values +
+
+

+
+
client
+

+ Perform handshaking as a client. +

+
server
+

+ Perform handshaking as a server. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer.html new file mode 100644 index 0000000..9d7ea73 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer.html @@ -0,0 +1,46 @@ + + + +ssl::stream::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a reference + to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer/overload1.html new file mode 100644 index 0000000..8f23752 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer/overload1.html @@ -0,0 +1,54 @@ + + + +ssl::stream::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 stream + layers. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of stream layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer/overload2.html new file mode 100644 index 0000000..1553e3c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer/overload2.html @@ -0,0 +1,54 @@ + + + +ssl::stream::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of stream layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer_type.html new file mode 100644 index 0000000..444e65f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/lowest_layer_type.html @@ -0,0 +1,52 @@ + + + +ssl::stream::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the lowest layer. +

+
typedef next_layer_type::lowest_layer_type lowest_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/ssl/stream.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/native_handle.html new file mode 100644 index 0000000..847bfa4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/native_handle.html @@ -0,0 +1,69 @@ + + + +ssl::stream::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the + underlying implementation in the native type. +

+
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. +

+
+ + 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: +

+
asio::ssl::stream<asio::ip::tcp::socket> sock(io_ctx, ctx);
+
+// ... establish connection and perform handshake ...
+
+if (X509* cert = SSL_get_peer_certificate(sock.native_handle()))
+{
+  if (SSL_get_verify_result(sock.native_handle()) == X509_V_OK)
+  {
+    // ...
+  }
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/native_handle_type.html new file mode 100644 index 0000000..b7a509c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/native_handle_type.html @@ -0,0 +1,52 @@ + + + +ssl::stream::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native handle type of the SSL stream. +

+
typedef SSL * native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/ssl/stream.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer.html new file mode 100644 index 0000000..adfdcc8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer.html @@ -0,0 +1,46 @@ + + + +ssl::stream::next_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get a reference + to the next layer. +

+
const next_layer_type & next_layer() const;
+  » more...
+
+next_layer_type & next_layer();
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer/overload1.html new file mode 100644 index 0000000..a28a25c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer/overload1.html @@ -0,0 +1,54 @@ + + + +ssl::stream::next_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a reference to the next layer. +

+
const next_layer_type & next_layer() const;
+
+

+ This function returns a reference to the next layer in a stack of stream + layers. +

+
+ + Return + Value +
+

+ A reference to the next layer in the stack of stream layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer/overload2.html new file mode 100644 index 0000000..cb7a7d5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer/overload2.html @@ -0,0 +1,54 @@ + + + +ssl::stream::next_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a reference to the next layer. +

+
next_layer_type & next_layer();
+
+

+ This function returns a reference to the next layer in a stack of stream + layers. +

+
+ + Return + Value +
+

+ A reference to the next layer in the stack of stream layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer_type.html new file mode 100644 index 0000000..61d796a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/next_layer_type.html @@ -0,0 +1,52 @@ + + + +ssl::stream::next_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the next layer. +

+
typedef remove_reference_t< Stream > next_layer_type;
+
+
+ + Requirements +
+

+ Header: asio/ssl/stream.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/operator_eq_.html new file mode 100644 index 0000000..4955e99 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/operator_eq_.html @@ -0,0 +1,60 @@ + + + +ssl::stream::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a stream from another. +

+
stream & operator=(
+    stream && other);
+
+
+ + Parameters +
+
+

+
+
other
+

+ The other stream object from which the move will occur. Must have + no outstanding asynchronous operations associated with it. Following + the move, other has + a valid but unspecified state where the only safe operation is destruction, + or use as the target of a move assignment. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some.html new file mode 100644 index 0000000..4aedb99 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some.html @@ -0,0 +1,53 @@ + + + +ssl::stream::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read some data + from the stream. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some/overload1.html new file mode 100644 index 0000000..54a7a82 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some/overload1.html @@ -0,0 +1,93 @@ + + + +ssl::stream::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. +

+
template<
+    typename 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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ The buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some/overload2.html new file mode 100644 index 0000000..844885f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/read_some/overload2.html @@ -0,0 +1,85 @@ + + + +ssl::stream::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the stream. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ The buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback.html new file mode 100644 index 0000000..a8e5789 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback.html @@ -0,0 +1,53 @@ + + + +ssl::stream::set_verify_callback + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the callback used to verify peer certificates. +

+
template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback);
+  » more...
+
+template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback/overload1.html new file mode 100644 index 0000000..29a72aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback/overload1.html @@ -0,0 +1,93 @@ + + + +ssl::stream::set_verify_callback (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the callback used to verify peer certificates. +

+
template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback);
+
+

+ This function is used to specify a callback function that will be called + by the implementation when it needs to verify a peer certificate. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback/overload2.html new file mode 100644 index 0000000..154c7fa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_callback/overload2.html @@ -0,0 +1,85 @@ + + + +ssl::stream::set_verify_callback (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the callback used to verify peer certificates. +

+
template<
+    typename VerifyCallback>
+void set_verify_callback(
+    VerifyCallback callback,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
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. +

+
+
+
+ + Remarks +
+

+ Calls SSL_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth.html new file mode 100644 index 0000000..d565ccf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth.html @@ -0,0 +1,49 @@ + + + +ssl::stream::set_verify_depth + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the peer verification depth. +

+
void set_verify_depth(
+    int depth);
+  » more...
+
+void set_verify_depth(
+    int depth,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth/overload1.html new file mode 100644 index 0000000..70056f5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth/overload1.html @@ -0,0 +1,80 @@ + + + +ssl::stream::set_verify_depth (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification depth. +

+
void set_verify_depth(
+    int depth);
+
+

+ This function may be used to configure the maximum verification depth + allowed by the stream. +

+
+ + Parameters +
+
+

+
+
depth
+

+ Maximum depth for the certificate chain verification that shall + be allowed. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_set_verify_depth. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth/overload2.html new file mode 100644 index 0000000..58747dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_depth/overload2.html @@ -0,0 +1,72 @@ + + + +ssl::stream::set_verify_depth (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification depth. +

+
void set_verify_depth(
+    int depth,
+    asio::error_code & ec);
+
+

+ This function may be used to configure the maximum verification depth + allowed by the stream. +

+
+ + Parameters +
+
+

+
+
depth
+

+ Maximum depth for the certificate chain verification that shall + be allowed. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_set_verify_depth. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode.html new file mode 100644 index 0000000..d53ce1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode.html @@ -0,0 +1,49 @@ + + + +ssl::stream::set_verify_mode + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Set + the peer verification mode. +

+
void set_verify_mode(
+    verify_mode v);
+  » more...
+
+void set_verify_mode(
+    verify_mode v,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode/overload1.html new file mode 100644 index 0000000..a881c41 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode/overload1.html @@ -0,0 +1,81 @@ + + + +ssl::stream::set_verify_mode (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification mode. +

+
void set_verify_mode(
+    verify_mode v);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
v
+

+ A bitmask of peer verification modes. See ssl::verify_mode for available + values. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls SSL_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode/overload2.html new file mode 100644 index 0000000..a00bca1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/set_verify_mode/overload2.html @@ -0,0 +1,73 @@ + + + +ssl::stream::set_verify_mode (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Set the peer verification mode. +

+
void set_verify_mode(
+    verify_mode v,
+    asio::error_code & ec);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
v
+

+ A bitmask of peer verification modes. See ssl::verify_mode for available + values. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls SSL_set_verify. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown.html new file mode 100644 index 0000000..e6c16f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown.html @@ -0,0 +1,47 @@ + + + +ssl::stream::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Shut down SSL on + the stream. +

+
void shutdown();
+  » more...
+
+void shutdown(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown/overload1.html new file mode 100644 index 0000000..8e0561f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown/overload1.html @@ -0,0 +1,58 @@ + + + +ssl::stream::shutdown (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Shut down SSL on the stream. +

+
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. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown/overload2.html new file mode 100644 index 0000000..ae8c621 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/shutdown/overload2.html @@ -0,0 +1,59 @@ + + + +ssl::stream::shutdown (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Shut down SSL on the stream. +

+
void shutdown(
+    asio::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. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream.html new file mode 100644 index 0000000..18abdb8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream.html @@ -0,0 +1,63 @@ + + + +ssl::stream::stream + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct a stream. +

+
template<
+    typename Arg>
+stream(
+    Arg && arg,
+    context & ctx);
+  » more...
+
+

+ Construct a stream from an existing native implementation. +

+
template<
+    typename Arg>
+stream(
+    Arg && arg,
+    native_handle_type handle);
+  » more...
+
+

+ Move-construct a stream from another. +

+
stream(
+    stream && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload1.html new file mode 100644 index 0000000..541f4b3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload1.html @@ -0,0 +1,66 @@ + + + +ssl::stream::stream (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream. +

+
template<
+    typename Arg>
+stream(
+    Arg && arg,
+    context & ctx);
+
+

+ This constructor creates a stream and initialises the underlying stream + object. +

+
+ + Parameters +
+
+

+
+
arg
+

+ The argument to be passed to initialise the underlying stream. +

+
ctx
+

+ The SSL context to be used for the stream. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload2.html new file mode 100644 index 0000000..ed24ca5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload2.html @@ -0,0 +1,67 @@ + + + +ssl::stream::stream (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream from an existing native implementation. +

+
template<
+    typename Arg>
+stream(
+    Arg && arg,
+    native_handle_type handle);
+
+

+ This constructor creates a stream and initialises the underlying stream + object. On success, ownership of the native implementation is transferred + to the stream, and it will be cleaned up when the stream is destroyed. +

+
+ + Parameters +
+
+

+
+
arg
+

+ The argument to be passed to initialise the underlying stream. +

+
handle
+

+ An existing native SSL implementation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload3.html new file mode 100644 index 0000000..0562215 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/stream/overload3.html @@ -0,0 +1,59 @@ + + + +ssl::stream::stream (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a stream from another. +

+
stream(
+    stream && other);
+
+
+ + Parameters +
+
+

+
+
other
+

+ The other stream object from which the move will occur. Must have + no outstanding asynchronous operations associated with it. Following + the move, other + has a valid but unspecified state where the only safe operation + is destruction, or use as the target of a move assignment. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some.html new file mode 100644 index 0000000..9caa756 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some.html @@ -0,0 +1,53 @@ + + + +ssl::stream::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write some data + to the stream. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some/overload1.html new file mode 100644 index 0000000..25ca841 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some/overload1.html @@ -0,0 +1,92 @@ + + + +ssl::stream::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the stream. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+

+ 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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ The data to be written. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some/overload2.html new file mode 100644 index 0000000..0b88bba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream/write_some/overload2.html @@ -0,0 +1,84 @@ + + + +ssl::stream::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the stream. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::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. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ The data to be written to the stream. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream__impl_struct.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream__impl_struct.html new file mode 100644 index 0000000..b995b43 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream__impl_struct.html @@ -0,0 +1,84 @@ + + + +ssl::stream::impl_struct + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Structure for use with deprecated impl_type. +

+
struct impl_struct
+
+
+ + Data Members +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ssl +

+ 		+
+
+ + Requirements +
+

+ Header: asio/ssl/stream.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream__impl_struct/ssl.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream__impl_struct/ssl.html new file mode 100644 index 0000000..1a939d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream__impl_struct/ssl.html @@ -0,0 +1,40 @@ + + + +ssl::stream::impl_struct::ssl + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
SSL * ssl;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base.html new file mode 100644 index 0000000..ed6c71b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base.html @@ -0,0 +1,124 @@ + + + +ssl::stream_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The ssl::stream_base + class is used as a base for the ssl::stream + class template so that we have a common place to define various enums. +

+
class stream_base
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ handshake_type +

+ 		+

+ Different handshake types. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~stream_base [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+
+ + Requirements +
+

+ Header: asio/ssl/stream_base.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base/_stream_base.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base/_stream_base.html new file mode 100644 index 0000000..ff0a7ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base/_stream_base.html @@ -0,0 +1,42 @@ + + + +ssl::stream_base::~stream_base + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~stream_base();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base/handshake_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base/handshake_type.html new file mode 100644 index 0000000..a394668 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__stream_base/handshake_type.html @@ -0,0 +1,63 @@ + + + +ssl::stream_base::handshake_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Different + handshake types. +

+
enum handshake_type
+
+

+ + +

+
+ + Values +
+
+

+
+
client
+

+ Perform handshaking as a client. +

+
server
+

+ Perform handshaking as a server. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_client_once.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_client_once.html new file mode 100644 index 0000000..8b75c97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_client_once.html @@ -0,0 +1,54 @@ + + + +ssl::verify_client_once + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Do not request client certificate on renegotiation. Ignored unless ssl::verify_peer + is set. +

+
const int verify_client_once = implementation_defined;
+
+
+ + Requirements +
+

+ Header: asio/ssl/verify_mode.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context.html new file mode 100644 index 0000000..1879197 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context.html @@ -0,0 +1,146 @@ + + + +ssl::verify_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A simple wrapper around the X509_STORE_CTX type, used during verification + of a peer certificate. +

+
class verify_context :
+  noncopyable
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ native_handle_type +

+ 		+

+ The native handle type of the verification context. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ native_handle +

+ 		+

+ Get the underlying implementation in the native type. +

+
+

+ verify_context [constructor] +

+ 		+

+ Constructor. +

+
+
+ + Remarks +
+

+ The ssl::verify_context + does not own the underlying X509_STORE_CTX object. +

+
+ + Requirements +
+

+ Header: asio/ssl/verify_context.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/native_handle.html new file mode 100644 index 0000000..391c5f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/native_handle.html @@ -0,0 +1,47 @@ + + + +ssl::verify_context::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the underlying implementation in the native type. +

+
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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/native_handle_type.html new file mode 100644 index 0000000..c518743 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/native_handle_type.html @@ -0,0 +1,52 @@ + + + +ssl::verify_context::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native handle type of the verification context. +

+
typedef X509_STORE_CTX * native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/ssl/verify_context.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/verify_context.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/verify_context.html new file mode 100644 index 0000000..ea50a8d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_context/verify_context.html @@ -0,0 +1,42 @@ + + + +ssl::verify_context::verify_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructor. +

+
verify_context(
+    native_handle_type handle);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_fail_if_no_peer_cert.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_fail_if_no_peer_cert.html new file mode 100644 index 0000000..2916abf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_fail_if_no_peer_cert.html @@ -0,0 +1,54 @@ + + + +ssl::verify_fail_if_no_peer_cert + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Fail verification if the peer has no certificate. Ignored unless ssl::verify_peer + is set. +

+
const int verify_fail_if_no_peer_cert = implementation_defined;
+
+
+ + Requirements +
+

+ Header: asio/ssl/verify_mode.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_mode.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_mode.html new file mode 100644 index 0000000..a44ecd3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_mode.html @@ -0,0 +1,70 @@ + + + +ssl::verify_mode + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Bitmask type for peer verification. +

+
typedef int verify_mode;
+
+

+ Possible values are: +

+
+
+ + Requirements +
+

+ Header: asio/ssl/verify_mode.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_none.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_none.html new file mode 100644 index 0000000..947d54d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_none.html @@ -0,0 +1,53 @@ + + + +ssl::verify_none + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ No verification. +

+
const int verify_none = implementation_defined;
+
+
+ + Requirements +
+

+ Header: asio/ssl/verify_mode.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_peer.html b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_peer.html new file mode 100644 index 0000000..cdf9120 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/ssl__verify_peer.html @@ -0,0 +1,53 @@ + + + +ssl::verify_peer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Verify the peer. +

+
const int verify_peer = implementation_defined;
+
+
+ + Requirements +
+

+ Header: asio/ssl/verify_mode.hpp +

+

+ Convenience header: asio/ssl.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/static_thread_pool.html b/Packages/asio-1.36.0/doc/asio/reference/static_thread_pool.html new file mode 100644 index 0000000..619f540 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/static_thread_pool.html @@ -0,0 +1,350 @@ + + + +static_thread_pool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef thread_pool static_thread_pool;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_executor_type +

+ 		+

+ Executor implementation type used to submit functions to a thread + pool. +

+
+

+ executor_type +

+ 		+

+ Executor used to submit functions to a thread pool. +

+
+

+ fork_event +

+ 		+

+ Fork-related event notifications. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ attach +

+ 		+

+ Attaches the current thread to the pool. +

+
+

+ executor +

+ 		+

+ Obtains the executor associated with the pool. +

+
+

+ get_executor +

+ 		+

+ Obtains the executor associated with the pool. +

+
+

+ join +

+ 		+

+ Joins the threads. +

+
+

+ notify_fork +

+ 		+

+ Notify the execution_context of a fork-related event. +

+
+

+ stop +

+ 		+

+ Stops the threads. +

+
+

+ thread_pool [constructor] +

+ 		+

+ Constructs a pool with an automatically determined number of threads. +
—
Constructs a pool with a specified number of threads. +

+
+

+ wait +

+ 		+

+ Waits for threads to complete. +

+
+

+ ~thread_pool [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ destroy +

+ 		+

+ Destroys all services in the context. +

+
+

+ shutdown +

+ 		+

+ Shuts down all services in the context. +

+
+

+ The thread pool class is an execution context where functions are permitted + to run on one of a fixed number of threads. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe, with the + specific exceptions of the join() wait() and notify_fork() functions. The join() and wait() functions must not be called at the same + time as other calls to join() or wait() on the same pool. The notify_fork() function should not be called while any + thread_pool + function, or any function on an I/O object that is associated with the thread_pool, + is being called in another thread. (In effect, this means that notify_fork() + is safe only on a thread pool that has no internal or attached threads at + the time.) +

+
+ + Submitting + tasks to the pool +
+

+ To submit functions to the thread pool, use the dispatch, post or defer free functions. +

+

+ For example: +

+
void my_task()
+{
+  ...
+}
+
+...
+
+// Launch the pool with four threads.
+asio::thread_pool pool(4);
+
+// Submit a function to the pool.
+asio::post(pool, my_task);
+
+// Submit a lambda object to the pool.
+asio::post(pool,
+    []()
+    {
+      ...
+    });
+
+// Wait for all tasks in the pool to complete.
+pool.join();
+
+
+ + Requirements +
+

+ Header: asio/static_thread_pool.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/steady_timer.html b/Packages/asio-1.36.0/doc/asio/reference/steady_timer.html new file mode 100644 index 0000000..ae3a888 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/steady_timer.html @@ -0,0 +1,429 @@ + + + +steady_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for a timer based on the steady clock. +

+
typedef basic_waitable_timer< chrono::steady_clock > steady_timer;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type of the clock. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_point +

+ 		+

+ The time point type of the clock. +

+
+

+ traits_type +

+ 		+

+ The wait traits type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_waitable_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a particular + expiry time relative to now.
—
Move-construct a basic_waitable_timer + from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_after +

+ 		+

+ Set the timer's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the timer's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the timer's expiry time as an absolute time. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_waitable_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_waitable_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ 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 one of the steady_timer, system_timer or high_resolution_timer typedefs. +

+
+ + Remarks +
+

+ This waitable timer functionality is for use with the C++11 standard library's + <chrono> facility, or with the Boost.Chrono library. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait (C++11): +

+
// Construct a timer without setting an expiry time.
+asio::steady_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_after(std::chrono::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait (C++11): +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::steady_timer timer(my_context,
+    std::chrono::steady_clock::now() + std::chrono::seconds(60));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + 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: +

+
void on_some_event()
+{
+  if (my_timer.expires_after(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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The asio::basic_waitable_timer::expires_after() + 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+

+ 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 basic_waitable_timer template directly: +

+
typedef basic_waitable_timer<boost::chrono::steady_clock> timer;
+
+
+ + Requirements +
+

+ Header: asio/steady_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand.html b/Packages/asio-1.36.0/doc/asio/reference/strand.html new file mode 100644 index 0000000..d8312ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand.html @@ -0,0 +1,349 @@ + + + +strand + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+strand +

+

+ +

+

+ Provides serialised function invocation for any executor type. +

+
template<
+    typename Executor>
+class strand
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ inner_executor_type +

+ 		+

+ The type of the underlying executor. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the strand to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the strand to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Request the strand to invoke the given function object. +

+
+

+ get_inner_executor +

+ 		+

+ Obtain the underlying executor. +

+
+

+ on_work_finished +

+ 		+

+ Inform the strand that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the strand that it has some outstanding work to do. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Converting assignment operator. +
—
Move assignment operator.
—
Converting + move assignment operator. +

+
+

+ post +

+ 		+

+ Request the strand to invoke the given function object. +

+
+

+ prefer +

+ 		+

+ Forward a preference to the underlying executor. +

+
+

+ query +

+ 		+

+ Forward a query to the underlying executor. +

+
+

+ require +

+ 		+

+ Forward a requirement to the underlying executor. +

+
+

+ running_in_this_thread +

+ 		+

+ Determine whether the strand is running in the current thread. +

+
+

+ strand + [constructor] +

+ 		+

+ Default constructor.
—
Construct a strand for the specified + executor.
—
Copy constructor.
—
Converting + constructor.
—
Move constructor.
—
Converting + move constructor. +

+
+

+ ~strand + [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two strands for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two strands for equality. +

+
+
+ + Requirements +
+

+ Header: asio/strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/_strand.html b/Packages/asio-1.36.0/doc/asio/reference/strand/_strand.html new file mode 100644 index 0000000..92ff1d9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/_strand.html @@ -0,0 +1,41 @@ + + + +strand::~strand + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~strand();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/context.html b/Packages/asio-1.36.0/doc/asio/reference/strand/context.html new file mode 100644 index 0000000..46225f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/context.html @@ -0,0 +1,42 @@ + + + +strand::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain the underlying execution + context. +

+
execution_context & context() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/defer.html b/Packages/asio-1.36.0/doc/asio/reference/strand/defer.html new file mode 100644 index 0000000..31fbb6b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/defer.html @@ -0,0 +1,76 @@ + + + +strand::defer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the strand to invoke the + given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void defer(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object will never be executed inside this function. + Instead, it will be scheduled by the underlying executor's defer function. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/strand/dispatch.html new file mode 100644 index 0000000..d6f490f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/dispatch.html @@ -0,0 +1,78 @@ + + + +strand::dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the strand to invoke + the given function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void dispatch(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the strand to execute the given function object + on its underlying executor. The function object will be executed inside + this function if the strand is not otherwise busy and if the underlying + executor's dispatch() + function is also able to execute the function before returning. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/execute.html b/Packages/asio-1.36.0/doc/asio/reference/strand/execute.html new file mode 100644 index 0000000..db6b9a5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/execute.html @@ -0,0 +1,69 @@ + + + +strand::execute + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the strand to invoke + the given function object. +

+
template<
+    typename Function>
+constraint_t< traits::execute_member< const Executor &, Function >::is_valid, void > execute(
+    Function && f) const;
+
+

+ This function is used to ask the strand to execute the given function object + on its underlying executor. The function object will be executed according + to the properties of the underlying executor. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/get_inner_executor.html b/Packages/asio-1.36.0/doc/asio/reference/strand/get_inner_executor.html new file mode 100644 index 0000000..f4b16e4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/get_inner_executor.html @@ -0,0 +1,42 @@ + + + +strand::get_inner_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the underlying executor. +

+
inner_executor_type get_inner_executor() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/inner_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/strand/inner_executor_type.html new file mode 100644 index 0000000..0d35b06 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/inner_executor_type.html @@ -0,0 +1,52 @@ + + + +strand::inner_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The type + of the underlying executor. +

+
typedef Executor inner_executor_type;
+
+
+ + Requirements +
+

+ Header: asio/strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/on_work_finished.html b/Packages/asio-1.36.0/doc/asio/reference/strand/on_work_finished.html new file mode 100644 index 0000000..dd8e5f0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/on_work_finished.html @@ -0,0 +1,45 @@ + + + +strand::on_work_finished + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform the + strand that some work is no longer outstanding. +

+
void on_work_finished() const;
+
+

+ The strand delegates this call to its underlying executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/on_work_started.html b/Packages/asio-1.36.0/doc/asio/reference/strand/on_work_started.html new file mode 100644 index 0000000..76322ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/on_work_started.html @@ -0,0 +1,45 @@ + + + +strand::on_work_started + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform the strand + that it has some outstanding work to do. +

+
void on_work_started() const;
+
+

+ The strand delegates this call to its underlying executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_.html new file mode 100644 index 0000000..bc5d026 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_.html @@ -0,0 +1,68 @@ + + + +strand::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment operator. +

+
strand & operator=(
+    const strand & other);
+  » more...
+
+

+ Converting assignment operator. +

+
template<
+    class OtherExecutor>
+strand & operator=(
+    const strand< OtherExecutor > & other);
+  » more...
+
+

+ Move assignment operator. +

+
strand & operator=(
+    strand && other);
+  » more...
+
+

+ Converting move assignment operator. +

+
template<
+    class OtherExecutor>
+strand & operator=(
+    strand< OtherExecutor > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload1.html new file mode 100644 index 0000000..e49b464 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +strand::operator= (1 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
strand & operator=(
+    const strand & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload2.html new file mode 100644 index 0000000..6620622 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload2.html @@ -0,0 +1,48 @@ + + + +strand::operator= (2 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Converting assignment operator. +

+
template<
+    class OtherExecutor>
+strand & operator=(
+    const strand< OtherExecutor > & other);
+
+

+ This assignment operator is only valid if the OtherExecutor + type is convertible to Executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload3.html new file mode 100644 index 0000000..447d59c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload3.html @@ -0,0 +1,42 @@ + + + +strand::operator= (3 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
strand & operator=(
+    strand && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload4.html new file mode 100644 index 0000000..6d62692 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq_/overload4.html @@ -0,0 +1,48 @@ + + + +strand::operator= (4 of 4 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Converting move assignment operator. +

+
template<
+    class OtherExecutor>
+strand & operator=(
+    strand< OtherExecutor > && other);
+
+

+ This assignment operator is only valid if the OtherExecutor + type is convertible to Executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq__eq_.html new file mode 100644 index 0000000..f9d90ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_eq__eq_.html @@ -0,0 +1,58 @@ + + + +strand::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two strands + for equality. +

+
bool operator==(
+    const strand & a,
+    const strand & b);
+
+

+ Two strands are equal if they refer to the same ordered, non-concurrent + state. +

+
+ + Requirements +
+

+ Header: asio/strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_not__eq_.html new file mode 100644 index 0000000..f47c801 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/operator_not__eq_.html @@ -0,0 +1,58 @@ + + + +strand::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare two strands + for inequality. +

+
bool operator!=(
+    const strand & a,
+    const strand & b);
+
+

+ Two strands are equal if they refer to the same ordered, non-concurrent + state. +

+
+ + Requirements +
+

+ Header: asio/strand.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/post.html b/Packages/asio-1.36.0/doc/asio/reference/strand/post.html new file mode 100644 index 0000000..7242e20 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/post.html @@ -0,0 +1,76 @@ + + + +strand::post + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request the strand to invoke the given + function object. +

+
template<
+    typename Function,
+    typename Allocator>
+void post(
+    Function && f,
+    const Allocator & a) const;
+
+

+ This function is used to ask the executor to execute the given function + object. The function object will never be executed inside this function. + Instead, it will be scheduled by the underlying executor's defer function. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/prefer.html b/Packages/asio-1.36.0/doc/asio/reference/strand/prefer.html new file mode 100644 index 0000000..631644a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/prefer.html @@ -0,0 +1,56 @@ + + + +strand::prefer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forward a preference to the underlying + executor. +

+
template<
+    typename Property>
+constraint_t< can_prefer< const Executor &, Property >::value &&!is_convertible< Property, execution::blocking_t::always_t >::value, strand< decay_t< prefer_result_t< const Executor &, Property > > > > prefer(
+    const Property & p) const;
+
+

+ Do not call this function directly. It is intended for use with the prefer + customisation point. +

+

+ For example: +

+
asio::strand<my_executor_type> ex1 = ...;
+auto ex2 = asio::prefer(ex1,
+    asio::execution::blocking.never);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/query.html b/Packages/asio-1.36.0/doc/asio/reference/strand/query.html new file mode 100644 index 0000000..284caa1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/query.html @@ -0,0 +1,57 @@ + + + +strand::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forward a query to the underlying + executor. +

+
template<
+    typename Property>
+constraint_t< can_query< const Executor &, Property >::value, conditional_t< is_convertible< Property, execution::blocking_t >::value, execution::blocking_t, query_result_t< const Executor &, Property > > > query(
+    const Property & p) const;
+
+

+ Do not call this function directly. It is intended for use with the query + customisation point. +

+

+ For example: +

+
asio::strand<my_executor_type> ex = ...;
+if (asio::query(ex, asio::execution::blocking)
+      == asio::execution::blocking.never)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/require.html b/Packages/asio-1.36.0/doc/asio/reference/strand/require.html new file mode 100644 index 0000000..0e6ddb8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/require.html @@ -0,0 +1,56 @@ + + + +strand::require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Forward a requirement to the + underlying executor. +

+
template<
+    typename Property>
+constraint_t< can_require< const Executor &, Property >::value &&!is_convertible< Property, execution::blocking_t::always_t >::value, strand< decay_t< require_result_t< const Executor &, Property > > > > require(
+    const Property & p) const;
+
+

+ Do not call this function directly. It is intended for use with the require + customisation point. +

+

+ For example: +

+
asio::strand<my_executor_type> ex1 = ...;
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.never);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/running_in_this_thread.html b/Packages/asio-1.36.0/doc/asio/reference/strand/running_in_this_thread.html new file mode 100644 index 0000000..8d27406 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/running_in_this_thread.html @@ -0,0 +1,54 @@ + + + +strand::running_in_this_thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the strand is running in the current thread. +

+
bool running_in_this_thread() const;
+
+
+ + Return + Value +
+

+ true if the current thread + is executing a function that was submitted to the strand using post(), + dispatch() + or defer(). + Otherwise returns false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/strand.html b/Packages/asio-1.36.0/doc/asio/reference/strand/strand.html new file mode 100644 index 0000000..026f11e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/strand.html @@ -0,0 +1,84 @@ + + + +strand::strand + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default constructor. +

+
strand();
+  » more...
+
+

+ Construct a strand for the specified executor. +

+
template<
+    typename Executor1>
+explicit strand(
+    const Executor1 & e,
+    constraint_t< conditional_t< !is_same< Executor1, strand >::value, is_convertible< Executor1, Executor >, false_type >::value >  = 0);
+  » more...
+
+

+ Copy constructor. +

+
strand(
+    const strand & other);
+  » more...
+
+

+ Converting constructor. +

+
template<
+    class OtherExecutor>
+strand(
+    const strand< OtherExecutor > & other);
+  » more...
+
+

+ Move constructor. +

+
strand(
+    strand && other);
+  » more...
+
+

+ Converting move constructor. +

+
template<
+    class OtherExecutor>
+strand(
+    strand< OtherExecutor > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload1.html new file mode 100644 index 0000000..1050b7d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload1.html @@ -0,0 +1,45 @@ + + + +strand::strand (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
strand();
+
+

+ This constructor is only valid if the underlying executor type is default + constructible. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload2.html new file mode 100644 index 0000000..d7aaa71 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload2.html @@ -0,0 +1,45 @@ + + + +strand::strand (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a strand for the specified executor. +

+
template<
+    typename Executor1>
+strand(
+    const Executor1 & e,
+    constraint_t< conditional_t< !is_same< Executor1, strand >::value, is_convertible< Executor1, Executor >, false_type >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload3.html new file mode 100644 index 0000000..c353267 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload3.html @@ -0,0 +1,42 @@ + + + +strand::strand (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
strand(
+    const strand & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload4.html new file mode 100644 index 0000000..2fcd3c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload4.html @@ -0,0 +1,48 @@ + + + +strand::strand (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Converting constructor. +

+
template<
+    class OtherExecutor>
+strand(
+    const strand< OtherExecutor > & other);
+
+

+ This constructor is only valid if the OtherExecutor + type is convertible to Executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload5.html new file mode 100644 index 0000000..f6e91a4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload5.html @@ -0,0 +1,42 @@ + + + +strand::strand (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
strand(
+    strand && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload6.html new file mode 100644 index 0000000..150d463 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/strand/strand/overload6.html @@ -0,0 +1,48 @@ + + + +strand::strand (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Converting move constructor. +

+
template<
+    class OtherExecutor>
+strand(
+    strand< OtherExecutor > && other);
+
+

+ This constructor is only valid if the OtherExecutor + type is convertible to Executor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/stream_file.html b/Packages/asio-1.36.0/doc/asio/reference/stream_file.html new file mode 100644 index 0000000..0c0f73e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/stream_file.html @@ -0,0 +1,544 @@ + + + +stream_file + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a stream-oriented file. +

+
typedef basic_stream_file stream_file;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the file type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ flags +

+ 		+

+ A bitmask type (C++ Std [lib.bitmask.types]). +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a file. +

+
+

+ seek_basis +

+ 		+

+ Basis for seeking in a file. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native file to the file. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_file [constructor] +

+ 		+

+ Construct a basic_stream_file without opening it.
—
+ Construct and open a basic_stream_file.
—
Construct + a basic_stream_file on an existing native file.
—
Move-construct + a basic_stream_file from another.
—
Move-construct + a basic_stream_file from a file of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the file. +

+
+

+ close +

+ 		+

+ Close the file. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the file is open. +

+
+

+ native_handle +

+ 		+

+ Get the native file representation. +

+
+

+ open +

+ 		+

+ Open the file using the specified path. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_stream_file from another.
—
Move-assign + a basic_stream_file from a file of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the file. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native file. +

+
+

+ resize +

+ 		+

+ Alter the size of the file. +

+
+

+ seek +

+ 		+

+ Seek to a position in the file. +

+
+

+ size +

+ 		+

+ Get the size of the file. +

+
+

+ sync_all +

+ 		+

+ Synchronise the file to disk. +

+
+

+ sync_data +

+ 		+

+ Synchronise the file data to disk. +

+
+

+ write_some +

+ 		+

+ Write some data to the file. +

+
+

+ ~basic_stream_file [destructor] +

+ 		+

+ Destroys the file. +

+
+
+ + Data + Members +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ append [static] +

+ 		+

+ Open the file in append mode. +

+
+

+ create [static] +

+ 		+

+ Create the file if it does not exist. +

+
+

+ exclusive [static] +

+ 		+

+ Ensure a new file is created. Must be combined with create. +

+
+

+ read_only [static] +

+ 		+

+ Open the file for reading. +

+
+

+ read_write [static] +

+ 		+

+ Open the file for reading and writing. +

+
+

+ sync_all_on_write [static] +

+ 		+

+ Open the file so that write operations automatically synchronise + the file data and metadata to disk. +

+
+

+ truncate [static] +

+ 		+

+ Open the file with any existing contents truncated. +

+
+

+ write_only [static] +

+ 		+

+ Open the file for writing. +

+
+

+ The basic_stream_file + class template provides asynchronous and blocking stream-oriented file functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/stream_file.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/streambuf.html b/Packages/asio-1.36.0/doc/asio/reference/streambuf.html new file mode 100644 index 0000000..50fb12d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/streambuf.html @@ -0,0 +1,364 @@ + + + +streambuf + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of basic_streambuf. +

+
typedef basic_streambuf streambuf;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ const_buffers_type +

+ 		+

+ The type used to represent the input sequence as a list of buffers. +

+
+

+ mutable_buffers_type +

+ 		+

+ The type used to represent the output sequence as a list of buffers. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_streambuf [constructor] +

+ 		+

+ Construct a basic_streambuf object. +

+
+

+ capacity +

+ 		+

+ Get the current capacity of the basic_streambuf. +

+
+

+ commit +

+ 		+

+ Move characters from the output sequence to the input sequence. +

+
+

+ consume +

+ 		+

+ Remove characters from the input sequence. +

+
+

+ data +

+ 		+

+ Get a list of buffers that represents the input sequence. +

+
+

+ max_size +

+ 		+

+ Get the maximum size of the basic_streambuf. +

+
+

+ prepare +

+ 		+

+ Get a list of buffers that represents the output sequence, with + the given size. +

+
+

+ size +

+ 		+

+ Get the size of the input sequence. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ overflow +

+ 		+

+ Override std::streambuf behaviour. +

+
+

+ reserve +

+ 		+
+

+ 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: +

+
    +
  • + 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 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. +

+
+ + Examples +
+

+ Writing directly from an streambuf to a socket: +

+
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: +

+
asio::streambuf b;
+
+// reserve 512 bytes in output sequence
+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;
+
+
+ + Requirements +
+

+ Header: asio/streambuf.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/synchronous_socket_operations.html b/Packages/asio-1.36.0/doc/asio/reference/synchronous_socket_operations.html new file mode 100644 index 0000000..f37b63f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/synchronous_socket_operations.html @@ -0,0 +1,77 @@ + + + +Requirements on synchronous socket operations + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In this section, synchronous socket operations are those + member functions specified as two overloads, with and without an argument + of type error_code&: +

+
R f(A1 a1, A2 a2, ..., AN aN);
+R f(A1 a1, A2 a2, ..., AN aN, error_code& ec);
+
+

+ For an object s, the conditions + under which its synchronous socket operations may block the calling thread + (C++Std [defns.block]) are determined as follows. +

+

+ If: +

+

+ — s.non_blocking() + == true, +

+

+ — the synchronous socket operation is specified in terms of a POSIX + function other than poll(), +

+

+ — that POSIX function lists EWOULDBLOCK + or EAGAIN in its failure + conditions, and +

+

+ — the effects of the operation cannot be established immediately +

+

+ then the synchronous socket operation shall not block the calling thread. + [Note: And the effects of the operation are not established. + —end note] +

+

+ Otherwise, the synchronous socket operation shall block the calling thread + until the effects are established. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_category.html b/Packages/asio-1.36.0/doc/asio/reference/system_category.html new file mode 100644 index 0000000..05f9959 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_category.html @@ -0,0 +1,53 @@ + + + +system_category + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Returns the error category used for the system errors produced by asio. +

+
const error_category & system_category();
+
+
+ + Requirements +
+

+ Header: asio/impl/error_code.ipp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context.html b/Packages/asio-1.36.0/doc/asio/reference/system_context.html new file mode 100644 index 0000000..7770bb8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context.html @@ -0,0 +1,248 @@ + + + +system_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The executor context for the system executor. +

+
class system_context :
+  public execution_context
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_type +

+ 		+

+ The executor type associated with the context. +

+
+

+ fork_event +

+ 		+

+ Fork-related event notifications. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get_executor +

+ 		+

+ Obtain an executor for the context. +

+
+

+ join +

+ 		+

+ Join all threads in the system thread pool. +

+
+

+ notify_fork +

+ 		+

+ Notify the execution_context of a fork-related event. +

+
+

+ stop +

+ 		+

+ Signal all threads in the system thread pool to stop. +

+
+

+ stopped +

+ 		+

+ Determine whether the system thread pool has been stopped. +

+
+

+ ~system_context [destructor] +

+ 		+

+ Destructor shuts down all threads in the system thread pool. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ destroy +

+ 		+

+ Destroys all services in the context. +

+
+

+ shutdown +

+ 		+

+ Shuts down all services in the context. +

+
+
+ + Requirements +
+

+ Header: asio/system_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/_system_context.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/_system_context.html new file mode 100644 index 0000000..154a021 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/_system_context.html @@ -0,0 +1,42 @@ + + + +system_context::~system_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor + shuts down all threads in the system thread pool. +

+
~system_context();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/destroy.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/destroy.html new file mode 100644 index 0000000..ce403ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/destroy.html @@ -0,0 +1,54 @@ + + + +system_context::destroy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Destroys all + services in the context. +

+
void destroy();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order * of the beginning of service object lifetime, performs + delete static_cast<execution_context::service*>(svc). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/executor_type.html new file mode 100644 index 0000000..e4b1e87 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/executor_type.html @@ -0,0 +1,276 @@ + + + +system_context::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + executor type associated with the context. +

+
typedef basic_system_executor< execution::blocking_t::possibly_t, execution::relationship_t::fork_t, std::allocator< void > > executor_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_system_executor [constructor] +

+ 		+

+ Default constructor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Execution function. +

+
+

+ on_work_finished +

+ 		+

+ Inform the executor that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the executor that it has some outstanding work to do. +

+
+

+ post +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ query +

+ 		+

+ Query the current value of the allocator property.
—
+ Query the occupancy (recommended number of work items) for the + system context. +

+
+

+ query [static] +

+ 		+

+ Query the current value of the mapping property.
—
+ Query the current value of the context property.
—
+ Query the current value of the blocking property.
—
+ Query the current value of the relationship property. +

+
+

+ require +

+ 		+

+ Obtain an executor with the blocking.possibly property.
+ —
Obtain an executor with the blocking.always property. +
—
Obtain an executor with the blocking.never property. +
—
Obtain an executor with the relationship.continuation + property.
—
Obtain an executor with the relationship.fork + property.
—
Obtain an executor with the specified + allocator property.
—
Obtain an executor with the + default allocator property. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+

+ The system executor represents an execution context where functions are + permitted to run on arbitrary threads. When the blocking.never property + is established, the system executor will schedule the function to run on + an unspecified system thread pool. When either blocking.possibly or blocking.always + is established, the executor invokes the function immediately. +

+
+ + Requirements +
+

+ Header: asio/system_context.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/fork_event.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/fork_event.html new file mode 100644 index 0000000..4679c0c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/fork_event.html @@ -0,0 +1,71 @@ + + + +system_context::fork_event + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Fork-related + event notifications. +

+
enum fork_event
+
+

+ + + +

+
+ + Values +
+
+

+
+
fork_prepare
+

+ Notify the context that the process is about to fork. +

+
fork_parent
+

+ Notify the context that the process has forked and is the parent. +

+
fork_child
+

+ Notify the context that the process has forked and is the child. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/get_executor.html new file mode 100644 index 0000000..dd64c19 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/get_executor.html @@ -0,0 +1,42 @@ + + + +system_context::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an executor for the context. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/join.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/join.html new file mode 100644 index 0000000..967d42f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/join.html @@ -0,0 +1,42 @@ + + + +system_context::join + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Join all threads in + the system thread pool. +

+
void join();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/notify_fork.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/notify_fork.html new file mode 100644 index 0000000..8ab9055 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/notify_fork.html @@ -0,0 +1,119 @@ + + + +system_context::notify_fork + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Notify + the execution_context + of a fork-related event. +

+
void notify_fork(
+    fork_event event);
+
+

+ This function is used to inform the execution_context that the process + is about to fork, or has just forked. This allows the execution_context, 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 execution_context function, or + any function associated with the execution_context's derived class, + 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 execution_context + or its derived class. +

+
+ + Parameters +
+
+

+
+
event
+

+ A fork-related event. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the notification fails the execution_context object + should no longer be used and should be destroyed. +

+
+
+
+ + Example +
+

+ The following code illustrates how to incorporate the notify_fork() function: +

+
my_execution_context.notify_fork(execution_context::fork_prepare);
+if (fork() == 0)
+{
+  // This is the child process.
+  my_execution_context.notify_fork(execution_context::fork_child);
+}
+else
+{
+  // This is the parent process.
+  my_execution_context.notify_fork(execution_context::fork_parent);
+}
+
+
+ + Remarks +
+

+ For each service object svc + in the execution_context + set, performs svc->notify_fork();. + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/shutdown.html new file mode 100644 index 0000000..fa453a7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/shutdown.html @@ -0,0 +1,54 @@ + + + +system_context::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Shuts down + all services in the context. +

+
void shutdown();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order of the beginning of service object lifetime, performs + svc->shutdown(). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/stop.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/stop.html new file mode 100644 index 0000000..f990dad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/stop.html @@ -0,0 +1,42 @@ + + + +system_context::stop + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Signal all threads + in the system thread pool to stop. +

+
void stop();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_context/stopped.html b/Packages/asio-1.36.0/doc/asio/reference/system_context/stopped.html new file mode 100644 index 0000000..309ea1c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_context/stopped.html @@ -0,0 +1,42 @@ + + + +system_context::stopped + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine whether + the system thread pool has been stopped. +

+
bool stopped() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_error.html b/Packages/asio-1.36.0/doc/asio/reference/system_error.html new file mode 100644 index 0000000..20ef1d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_error.html @@ -0,0 +1,50 @@ + + + +system_error + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
typedef std::system_error system_error;
+
+
+ + Requirements +
+

+ Header: asio/system_error.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_executor.html b/Packages/asio-1.36.0/doc/asio/reference/system_executor.html new file mode 100644 index 0000000..b877d48 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_executor.html @@ -0,0 +1,283 @@ + + + +system_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ An executor that uses arbitrary threads. +

+
typedef basic_system_executor< execution::blocking_t::possibly_t, execution::relationship_t::fork_t, std::allocator< void > > system_executor;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_system_executor [constructor] +

+ 		+

+ Default constructor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Execution function. +

+
+

+ on_work_finished +

+ 		+

+ Inform the executor that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the executor that it has some outstanding work to do. +

+
+

+ post +

+ 		+

+ Request the system executor to invoke the given function object. +

+
+

+ query +

+ 		+

+ Query the current value of the allocator property.
—
+ Query the occupancy (recommended number of work items) for the + system context. +

+
+

+ query [static] +

+ 		+

+ Query the current value of the mapping property.
—
+ Query the current value of the context property.
—
+ Query the current value of the blocking property.
—
+ Query the current value of the relationship property. +

+
+

+ require +

+ 		+

+ Obtain an executor with the blocking.possibly property.
+ —
Obtain an executor with the blocking.always property.
+ —
Obtain an executor with the blocking.never property.
+ —
Obtain an executor with the relationship.continuation property. +
—
Obtain an executor with the relationship.fork property. +
—
Obtain an executor with the specified allocator property. +
—
Obtain an executor with the default allocator property. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+

+ The system executor represents an execution context where functions are permitted + to run on arbitrary threads. When the blocking.never property is established, + the system executor will schedule the function to run on an unspecified system + thread pool. When either blocking.possibly or blocking.always is established, + the executor invokes the function immediately. +

+

+ The system executor represents an execution context where functions are permitted + to run on arbitrary threads. When the blocking.never property is established, + the system executor will schedule the function to run on an unspecified system + thread pool. When either blocking.possibly or blocking.always is established, + the executor invokes the function immediately. +

+
+ + Requirements +
+

+ Header: asio/system_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/system_timer.html b/Packages/asio-1.36.0/doc/asio/reference/system_timer.html new file mode 100644 index 0000000..497b3a1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/system_timer.html @@ -0,0 +1,429 @@ + + + +system_timer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for a timer based on the system clock. +

+
typedef basic_waitable_timer< chrono::system_clock > system_timer;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the timer type to another executor. +

+
+

+ clock_type +

+ 		+

+ The clock type. +

+
+

+ duration +

+ 		+

+ The duration type of the clock. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ time_point +

+ 		+

+ The time point type of the clock. +

+
+

+ traits_type +

+ 		+

+ The wait traits type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the timer. +

+
+

+ basic_waitable_timer [constructor] +

+ 		+

+ Constructor.
—
Constructor to set a particular expiry + time as an absolute time.
—
Constructor to set a particular + expiry time relative to now.
—
Move-construct a basic_waitable_timer + from another. +

+
+

+ cancel +

+ 		+

+ Cancel any asynchronous operations that are waiting on the timer. +

+
+

+ cancel_one +

+ 		+

+ Cancels one asynchronous operation that is waiting on the timer. +

+
+

+ expires_after +

+ 		+

+ Set the timer's expiry time relative to now. +

+
+

+ expires_at +

+ 		+

+ Set the timer's expiry time as an absolute time. +

+
+

+ expiry +

+ 		+

+ Get the timer's expiry time as an absolute time. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_waitable_timer from another. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the timer. +

+
+

+ ~basic_waitable_timer [destructor] +

+ 		+

+ Destroys the timer. +

+
+

+ 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 one of the steady_timer, system_timer or high_resolution_timer typedefs. +

+
+ + Remarks +
+

+ This waitable timer functionality is for use with the C++11 standard library's + <chrono> facility, or with the Boost.Chrono library. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Examples +
+

+ Performing a blocking wait (C++11): +

+
// Construct a timer without setting an expiry time.
+asio::steady_timer timer(my_context);
+
+// Set an expiry time relative to now.
+timer.expires_after(std::chrono::seconds(5));
+
+// Wait for the timer to expire.
+timer.wait();
+
+

+ Performing an asynchronous wait (C++11): +

+
void handler(const asio::error_code& error)
+{
+  if (!error)
+  {
+    // Timer expired.
+  }
+}
+
+...
+
+// Construct a timer with an absolute expiry time.
+asio::steady_timer timer(my_context,
+    std::chrono::steady_clock::now() + std::chrono::seconds(60));
+
+// Start an asynchronous wait.
+timer.async_wait(handler);
+
+
+ + 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: +

+
void on_some_event()
+{
+  if (my_timer.expires_after(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 asio::error_code& e)
+{
+  if (e != asio::error::operation_aborted)
+  {
+    // Timer was not cancelled, take necessary action.
+  }
+}
+
+
    +
  • + The asio::basic_waitable_timer::expires_after() + 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 error_code passed to it contains + the value asio::error::operation_aborted. +
    • +
+

+ 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 basic_waitable_timer template directly: +

+
typedef basic_waitable_timer<boost::chrono::system_clock> timer;
+
+
+ + Requirements +
+

+ Header: asio/system_timer.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state.html new file mode 100644 index 0000000..b5dc00a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state.html @@ -0,0 +1,68 @@ + + + +this_coro::cancellation_state + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Awaitable object that returns the cancellation state of the current coroutine. +

+
constexpr cancellation_state_t cancellation_state;
+
+
+ + Example +
+
asio::awaitable<void> my_coroutine()
+{
+  asio::cancellation_state cs
+    = co_await asio::this_coro::cancellation_state;
+
+  // ...
+
+  if (cs.cancelled() != asio::cancellation_type::none)
+    // ...
+}
+
+
+ + Requirements +
+

+ Header: asio/this_coro.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state_t.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state_t.html new file mode 100644 index 0000000..6207dda --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state_t.html @@ -0,0 +1,85 @@ + + + +this_coro::cancellation_state_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Awaitable type that returns the cancellation state of the current coroutine. +

+
struct cancellation_state_t
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancellation_state_t [constructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/this_coro.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state_t/cancellation_state_t.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state_t/cancellation_state_t.html new file mode 100644 index 0000000..3bbc0d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__cancellation_state_t/cancellation_state_t.html @@ -0,0 +1,40 @@ + + + +this_coro::cancellation_state_t::cancellation_state_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr cancellation_state_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor.html new file mode 100644 index 0000000..baadd46 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor.html @@ -0,0 +1,53 @@ + + + +this_coro::executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Awaitable object that returns the executor of the current coroutine. +

+
constexpr executor_t executor;
+
+
+ + Requirements +
+

+ Header: asio/this_coro.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor_t.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor_t.html new file mode 100644 index 0000000..59e81bb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor_t.html @@ -0,0 +1,84 @@ + + + +this_coro::executor_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Awaitable type that returns the executor of the current coroutine. +

+
struct executor_t
+
+
+ + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_t [constructor] +

+ 		+
+
+ + Requirements +
+

+ Header: asio/this_coro.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor_t/executor_t.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor_t/executor_t.html new file mode 100644 index 0000000..1ddd662 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__executor_t/executor_t.html @@ -0,0 +1,40 @@ + + + +this_coro::executor_t::executor_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+
constexpr executor_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state.html new file mode 100644 index 0000000..817ef9e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state.html @@ -0,0 +1,69 @@ + + + +this_coro::reset_cancellation_state + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Returns an awaitable object that may be used to reset the cancellation state + of the current coroutine. +

+
constexpr unspecified reset_cancellation_state();
+  » more...
+
+template<
+    typename Filter>
+constexpr unspecified reset_cancellation_state(
+    Filter && filter);
+  » more...
+
+template<
+    typename InFilter,
+    typename OutFilter>
+constexpr unspecified reset_cancellation_state(
+    InFilter && in_filter,
+    OutFilter && out_filter);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/this_coro.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload1.html new file mode 100644 index 0000000..7b2273c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload1.html @@ -0,0 +1,69 @@ + + + +this_coro::reset_cancellation_state (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Returns an awaitable object that may be used to reset the cancellation + state of the current coroutine. +

+
constexpr unspecified reset_cancellation_state();
+
+

+ Let P be the cancellation + slot associated with the current coroutine's co_spawn completion handler. Assigns + a new cancellation_state + object S, constructed as + S(P), into + the current coroutine's cancellation state object. +

+
+ + Example +
+
asio::awaitable<void> my_coroutine()
+{
+  co_await asio::this_coro::reset_cancellation_state();
+
+  // ...
+}
+
+
+ + Remarks +
+

+ The cancellation state is shared by all coroutines in the same "thread + of execution" that was created using co_spawn. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload2.html new file mode 100644 index 0000000..30c1fc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload2.html @@ -0,0 +1,73 @@ + + + +this_coro::reset_cancellation_state (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Returns an awaitable object that may be used to reset the cancellation + state of the current coroutine. +

+
template<
+    typename Filter>
+constexpr unspecified reset_cancellation_state(
+    Filter && filter);
+
+

+ Let P be the cancellation + slot associated with the current coroutine's co_spawn completion handler. Assigns + a new cancellation_state + object S, constructed as + S(P, std::forward<Filter>(filter)), into the current coroutine's cancellation + state object. +

+
+ + Example +
+
asio::awaitable<void> my_coroutine()
+{
+  co_await asio::this_coro::reset_cancellation_state(
+      asio::enable_partial_cancellation());
+
+  // ...
+}
+
+
+ + Remarks +
+

+ The cancellation state is shared by all coroutines in the same "thread + of execution" that was created using co_spawn. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload3.html new file mode 100644 index 0000000..26d60be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__reset_cancellation_state/overload3.html @@ -0,0 +1,76 @@ + + + +this_coro::reset_cancellation_state (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Returns an awaitable object that may be used to reset the cancellation + state of the current coroutine. +

+
template<
+    typename InFilter,
+    typename OutFilter>
+constexpr unspecified reset_cancellation_state(
+    InFilter && in_filter,
+    OutFilter && out_filter);
+
+

+ Let P be the cancellation + slot associated with the current coroutine's co_spawn completion handler. Assigns + a new cancellation_state + object S, constructed as + S(P, std::forward<InFilter>(in_filter), std::forward<OutFilter>(out_filter)), into the current coroutine's cancellation + state object. +

+
+ + Example +
+
asio::awaitable<void> my_coroutine()
+{
+  co_await asio::this_coro::reset_cancellation_state(
+      asio::enable_partial_cancellation(),
+      asio::disable_cancellation());
+
+  // ...
+}
+
+
+ + Remarks +
+

+ The cancellation state is shared by all coroutines in the same "thread + of execution" that was created using co_spawn. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled.html new file mode 100644 index 0000000..0eed83a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled.html @@ -0,0 +1,63 @@ + + + +this_coro::throw_if_cancelled + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Returns an awaitable object that may be used to determine whether the coroutine + throws if trying to suspend when it has been cancelled. +

+
constexpr unspecified throw_if_cancelled();
+  » more...
+
+

+ Returns an awaitable object that may be used to specify whether the coroutine + throws if trying to suspend when it has been cancelled. +

+
constexpr unspecified throw_if_cancelled(
+    bool value);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/this_coro.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled/overload1.html new file mode 100644 index 0000000..ecbe573 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled/overload1.html @@ -0,0 +1,54 @@ + + + +this_coro::throw_if_cancelled (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Returns an awaitable object that may be used to determine whether the coroutine + throws if trying to suspend when it has been cancelled. +

+
constexpr unspecified throw_if_cancelled();
+
+
+ + Example +
+
asio::awaitable<void> my_coroutine()
+{
+  if (co_await asio::this_coro::throw_if_cancelled)
+    // ...
+
+  // ...
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled/overload2.html new file mode 100644 index 0000000..6260b76 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/this_coro__throw_if_cancelled/overload2.html @@ -0,0 +1,54 @@ + + + +this_coro::throw_if_cancelled (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Returns an awaitable object that may be used to specify whether the coroutine + throws if trying to suspend when it has been cancelled. +

+
constexpr unspecified throw_if_cancelled(
+    bool value);
+
+
+ + Example +
+
asio::awaitable<void> my_coroutine()
+{
+  co_await asio::this_coro::throw_if_cancelled(false);
+
+  // ...
+}
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread.html b/Packages/asio-1.36.0/doc/asio/reference/thread.html new file mode 100644 index 0000000..cb49147 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread.html @@ -0,0 +1,149 @@ + + + +thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+thread +

+

+ +

+

+ A simple abstraction for starting threads. +

+
class thread :
+  noncopyable
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ join +

+ 		+

+ Wait for the thread to exit. +

+
+

+ thread + [constructor] +

+ 		+

+ Start a new thread that executes the supplied function. +

+
+

+ ~thread + [destructor] +

+ 		+

+ Destructor. +

+
+

+ The thread + class implements the smallest possible subset of the functionality of boost::thread. + It is intended to be used only for starting a thread and waiting for it to + exit. If more extensive threading capabilities are required, you are strongly + advised to use something else. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Example +
+

+ A typical use of thread + would be to launch a thread to run an io_context's event processing loop: +

+
asio::io_context io_context;
+// ...
+asio::thread t(boost::bind(&asio::io_context::run, &io_context));
+// ...
+t.join();
+
+
+ + Requirements +
+

+ Header: asio/thread.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread/_thread.html b/Packages/asio-1.36.0/doc/asio/reference/thread/_thread.html new file mode 100644 index 0000000..dd86a63 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread/_thread.html @@ -0,0 +1,41 @@ + + + +thread::~thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~thread();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread/join.html b/Packages/asio-1.36.0/doc/asio/reference/thread/join.html new file mode 100644 index 0000000..49cec49 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread/join.html @@ -0,0 +1,49 @@ + + + +thread::join + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wait for the thread to exit. +

+
void join();
+
+

+ This function will block until the thread has exited. +

+

+ If this function is not called before the thread object is destroyed, the + thread itself will continue to run until completion. You will, however, + no longer have the ability to wait for it to exit. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread/thread.html b/Packages/asio-1.36.0/doc/asio/reference/thread/thread.html new file mode 100644 index 0000000..18c1696 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread/thread.html @@ -0,0 +1,67 @@ + + + +thread::thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start a new thread that executes + the supplied function. +

+
template<
+    typename Function>
+thread(
+    Function f);
+
+

+ This constructor creates a new thread that will execute the given function + or function object. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function or function object to be run in the thread. The function + signature must be: +

+
void f();
+
+
+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool.html new file mode 100644 index 0000000..384020d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool.html @@ -0,0 +1,354 @@ + + + +thread_pool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A simple fixed-size thread pool. +

+
class thread_pool :
+  public execution_context
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_executor_type +

+ 		+

+ Executor implementation type used to submit functions to a thread + pool. +

+
+

+ executor_type +

+ 		+

+ Executor used to submit functions to a thread pool. +

+
+

+ fork_event +

+ 		+

+ Fork-related event notifications. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ attach +

+ 		+

+ Attaches the current thread to the pool. +

+
+

+ executor +

+ 		+

+ Obtains the executor associated with the pool. +

+
+

+ get_executor +

+ 		+

+ Obtains the executor associated with the pool. +

+
+

+ join +

+ 		+

+ Joins the threads. +

+
+

+ notify_fork +

+ 		+

+ Notify the execution_context of a fork-related event. +

+
+

+ stop +

+ 		+

+ Stops the threads. +

+
+

+ thread_pool [constructor] +

+ 		+

+ Constructs a pool with an automatically determined number of threads. +
—
Constructs a pool with a specified number of threads. +

+
+

+ wait +

+ 		+

+ Waits for threads to complete. +

+
+

+ ~thread_pool [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ destroy +

+ 		+

+ Destroys all services in the context. +

+
+

+ shutdown +

+ 		+

+ Shuts down all services in the context. +

+
+

+ The thread pool class is an execution context where functions are permitted + to run on one of a fixed number of threads. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Safe, with the + specific exceptions of the join() wait() and notify_fork() functions. The join() and wait() functions must not be called at the same + time as other calls to join() or wait() on the same pool. The notify_fork() function should not be called while any + thread_pool + function, or any function on an I/O object that is associated with the thread_pool, + is being called in another thread. (In effect, this means that notify_fork() + is safe only on a thread pool that has no internal or attached threads at + the time.) +

+
+ + Submitting + tasks to the pool +
+

+ To submit functions to the thread pool, use the dispatch, post or defer free functions. +

+

+ For example: +

+
void my_task()
+{
+  ...
+}
+
+...
+
+// Launch the pool with four threads.
+asio::thread_pool pool(4);
+
+// Submit a function to the pool.
+asio::post(pool, my_task);
+
+// Submit a lambda object to the pool.
+asio::post(pool,
+    []()
+    {
+      ...
+    });
+
+// Wait for all tasks in the pool to complete.
+pool.join();
+
+
+ + Requirements +
+

+ Header: asio/thread_pool.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/_thread_pool.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/_thread_pool.html new file mode 100644 index 0000000..ba938a9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/_thread_pool.html @@ -0,0 +1,44 @@ + + + +thread_pool::~thread_pool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~thread_pool();
+
+

+ Automatically stops and joins the pool, if not explicitly done beforehand. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/attach.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/attach.html new file mode 100644 index 0000000..d9ca834 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/attach.html @@ -0,0 +1,47 @@ + + + +thread_pool::attach + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Attaches the current + thread to the pool. +

+
void attach();
+
+

+ This function attaches the current thread to the pool so that it may be + used for executing submitted function objects. Blocks the calling thread + until the pool is stopped or joined and has no outstanding work. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/destroy.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/destroy.html new file mode 100644 index 0000000..5def97f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/destroy.html @@ -0,0 +1,54 @@ + + + +thread_pool::destroy + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Destroys all services + in the context. +

+
void destroy();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order * of the beginning of service object lifetime, performs + delete static_cast<execution_context::service*>(svc). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/executor.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/executor.html new file mode 100644 index 0000000..f6e43ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/executor.html @@ -0,0 +1,42 @@ + + + +thread_pool::executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtains the executor + associated with the pool. +

+
executor_type executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/executor_type.html new file mode 100644 index 0000000..0be7538 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/executor_type.html @@ -0,0 +1,308 @@ + + + +thread_pool::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Executor + used to submit functions to a thread pool. +

+
typedef basic_executor_type< std::allocator< void >, 0 > executor_type;
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_executor_type [constructor] +

+ 		+

+ Copy constructor.
—
Move constructor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the thread pool to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the thread pool to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Execution function. +

+
+

+ on_work_finished +

+ 		+

+ Inform the thread pool that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the thread pool that it has some outstanding work to do. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+

+ post +

+ 		+

+ Request the thread pool to invoke the given function object. +

+
+

+ query +

+ 		+

+ Query the current value of the context property.
—
+ Query the current value of the blocking property.
—
+ Query the current value of the relationship property.
+ —
Query the current value of the allocator property.
+ —
Query the occupancy (recommended number of work items) + for the pool. +

+
+

+ query [static] +

+ 		+

+ Query the current value of the mapping property.
—
+ Query the current value of the outstanding_work property. +

+
+

+ require +

+ 		+

+ Obtain an executor with the blocking.possibly property.
+ —
Obtain an executor with the blocking.always property. +
—
Obtain an executor with the blocking.never property. +
—
Obtain an executor with the relationship.fork property. +
—
Obtain an executor with the relationship.continuation + property.
—
Obtain an executor with the outstanding_work.tracked + property.
—
Obtain an executor with the outstanding_work.untracked + property.
—
Obtain an executor with the specified + allocator property.
—
Obtain an executor with the + default allocator property. +

+
+

+ running_in_this_thread +

+ 		+

+ Determine whether the thread pool is running in the current thread. +

+
+

+ ~basic_executor_type [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+
+ + Requirements +
+

+ Header: asio/thread_pool.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/fork_event.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/fork_event.html new file mode 100644 index 0000000..71969e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/fork_event.html @@ -0,0 +1,71 @@ + + + +thread_pool::fork_event + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Fork-related + event notifications. +

+
enum fork_event
+
+

+ + + +

+
+ + Values +
+
+

+
+
fork_prepare
+

+ Notify the context that the process is about to fork. +

+
fork_parent
+

+ Notify the context that the process has forked and is the parent. +

+
fork_child
+

+ Notify the context that the process has forked and is the child. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/get_executor.html new file mode 100644 index 0000000..41933d3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/get_executor.html @@ -0,0 +1,42 @@ + + + +thread_pool::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtains the + executor associated with the pool. +

+
executor_type get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/join.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/join.html new file mode 100644 index 0000000..b750356 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/join.html @@ -0,0 +1,47 @@ + + + +thread_pool::join + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Joins the threads. +

+
void join();
+
+

+ This function blocks until the threads in the pool have completed. If + stop() + is not called prior to join(), the join() call will wait until the pool has no + more outstanding work. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/notify_fork.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/notify_fork.html new file mode 100644 index 0000000..949d1d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/notify_fork.html @@ -0,0 +1,119 @@ + + + +thread_pool::notify_fork + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Notify the + execution_context + of a fork-related event. +

+
void notify_fork(
+    fork_event event);
+
+

+ This function is used to inform the execution_context that the process + is about to fork, or has just forked. This allows the execution_context, 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 execution_context function, or + any function associated with the execution_context's derived class, + 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 execution_context + or its derived class. +

+
+ + Parameters +
+
+

+
+
event
+

+ A fork-related event. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. If the notification fails the execution_context object + should no longer be used and should be destroyed. +

+
+
+
+ + Example +
+

+ The following code illustrates how to incorporate the notify_fork() function: +

+
my_execution_context.notify_fork(execution_context::fork_prepare);
+if (fork() == 0)
+{
+  // This is the child process.
+  my_execution_context.notify_fork(execution_context::fork_child);
+}
+else
+{
+  // This is the parent process.
+  my_execution_context.notify_fork(execution_context::fork_parent);
+}
+
+
+ + Remarks +
+

+ For each service object svc + in the execution_context + set, performs svc->notify_fork();. + 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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/shutdown.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/shutdown.html new file mode 100644 index 0000000..b4a5f86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/shutdown.html @@ -0,0 +1,54 @@ + + + +thread_pool::shutdown + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from execution_context. +

+

+ +Shuts down all services + in the context. +

+
void shutdown();
+
+

+ This function is implemented as follows: +

+
  • + For each service object svc + in the execution_context set, in + reverse order of the beginning of service object lifetime, performs + svc->shutdown(). +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/stop.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/stop.html new file mode 100644 index 0000000..73a4de4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/stop.html @@ -0,0 +1,46 @@ + + + +thread_pool::stop + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Stops the threads. +

+
void stop();
+
+

+ This function stops the threads as soon as possible. As a result of calling + stop(), + pending function objects may be never be invoked. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool.html new file mode 100644 index 0000000..f9d0345 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool.html @@ -0,0 +1,79 @@ + + + +thread_pool::thread_pool + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Constructs + a pool with an automatically determined number of threads. +

+
thread_pool();
+  » more...
+
+template<
+    typename Allocator>
+thread_pool(
+    allocator_arg_t ,
+    const Allocator & a);
+  » more...
+
+

+ Constructs a pool with a specified number of threads. +

+
explicit thread_pool(
+    std::size_t num_threads);
+  » more...
+
+template<
+    typename Allocator>
+thread_pool(
+    allocator_arg_t ,
+    const Allocator & a,
+    std::size_t num_threads);
+  » more...
+
+thread_pool(
+    std::size_t num_threads,
+    const execution_context::service_maker & initial_services);
+  » more...
+
+template<
+    typename Allocator>
+thread_pool(
+    allocator_arg_t ,
+    const Allocator & a,
+    std::size_t num_threads,
+    const execution_context::service_maker & initial_services);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload1.html new file mode 100644 index 0000000..2aec95b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload1.html @@ -0,0 +1,41 @@ + + + +thread_pool::thread_pool (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructs a pool with an automatically determined number of threads. +

+
thread_pool();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload2.html new file mode 100644 index 0000000..6545af8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload2.html @@ -0,0 +1,60 @@ + + + +thread_pool::thread_pool (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructs a pool with an automatically determined number of threads. +

+
template<
+    typename Allocator>
+thread_pool(
+    allocator_arg_t ,
+    const Allocator & a);
+
+
+ + Parameters +
+
+

+
+
a
+

+ An allocator that will be used for allocating objects that are + associated with the execution context, such as services and internal + state for I/O objects. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload3.html new file mode 100644 index 0000000..58f6139 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload3.html @@ -0,0 +1,55 @@ + + + +thread_pool::thread_pool (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructs a pool with a specified number of threads. +

+
thread_pool(
+    std::size_t num_threads);
+
+
+ + Parameters +
+
+

+
+
num_threads
+

+ The number of threads required. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload4.html new file mode 100644 index 0000000..19d6566 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload4.html @@ -0,0 +1,65 @@ + + + +thread_pool::thread_pool (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructs a pool with a specified number of threads. +

+
template<
+    typename Allocator>
+thread_pool(
+    allocator_arg_t ,
+    const Allocator & a,
+    std::size_t num_threads);
+
+
+ + Parameters +
+
+

+
+
num_threads
+

+ The number of threads required. +

+
a
+

+ An allocator that will be used for allocating objects that are + associated with the execution context, such as services and internal + state for I/O objects. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload5.html new file mode 100644 index 0000000..da91481 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload5.html @@ -0,0 +1,65 @@ + + + +thread_pool::thread_pool (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructs a pool with a specified number of threads. +

+
thread_pool(
+    std::size_t num_threads,
+    const execution_context::service_maker & initial_services);
+
+

+ Construct with a service maker, to create an initial set of services + that will be installed into the execution context at construction time. +

+
+ + Parameters +
+
+

+
+
num_threads
+

+ The number of threads required. +

+
initial_services
+

+ Used to create the initial services. The make + function will be called once at the end of execution_context construction. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload6.html new file mode 100644 index 0000000..4046f4e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/thread_pool/overload6.html @@ -0,0 +1,75 @@ + + + +thread_pool::thread_pool (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructs a pool with a specified number of threads. +

+
template<
+    typename Allocator>
+thread_pool(
+    allocator_arg_t ,
+    const Allocator & a,
+    std::size_t num_threads,
+    const execution_context::service_maker & initial_services);
+
+

+ Construct with a service maker, to create an initial set of services + that will be installed into the execution context at construction time. +

+
+ + Parameters +
+
+

+
+
a
+

+ An allocator that will be used for allocating objects that are + associated with the execution context, such as services and internal + state for I/O objects. +

+
num_threads
+

+ The number of threads required. +

+
initial_services
+

+ Used to create the initial services. The make + function will be called once at the end of execution_context construction. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool/wait.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/wait.html new file mode 100644 index 0000000..ebec80b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool/wait.html @@ -0,0 +1,55 @@ + + + +thread_pool::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Waits for threads to complete. +

+
void wait();
+
+

+ This function blocks until the threads in the pool have completed. If + stop() + is not called prior to wait(), the wait() call will wait until the pool has no + more outstanding work. +

+
+ + Remarks +
+

+ wait() + is synonymous with join(). +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type.html new file mode 100644 index 0000000..39b263e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type.html @@ -0,0 +1,312 @@ + + + +thread_pool::basic_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Executor implementation type used to submit functions to a thread pool. +

+
template<
+    typename Allocator,
+    unsigned int Bits>
+class basic_executor_type
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_executor_type [constructor] +

+ 		+

+ Copy constructor.
—
Move constructor. +

+
+

+ context +

+ 		+

+ Obtain the underlying execution context. +

+
+

+ defer +

+ 		+

+ Request the thread pool to invoke the given function object. +

+
+

+ dispatch +

+ 		+

+ Request the thread pool to invoke the given function object. +

+
+

+ execute +

+ 		+

+ Execution function. +

+
+

+ on_work_finished +

+ 		+

+ Inform the thread pool that some work is no longer outstanding. +

+
+

+ on_work_started +

+ 		+

+ Inform the thread pool that it has some outstanding work to do. +

+
+

+ operator= +

+ 		+

+ Assignment operator.
—
Move assignment operator. +

+
+

+ post +

+ 		+

+ Request the thread pool to invoke the given function object. +

+
+

+ query +

+ 		+

+ Query the current value of the context property.
—
+ Query the current value of the blocking property.
—
+ Query the current value of the relationship property.
—
+ Query the current value of the allocator property.
—
+ Query the occupancy (recommended number of work items) for the + pool. +

+
+

+ query [static] +

+ 		+

+ Query the current value of the mapping property.
—
+ Query the current value of the outstanding_work property. +

+
+

+ require +

+ 		+

+ Obtain an executor with the blocking.possibly property.
+ —
Obtain an executor with the blocking.always property.
+ —
Obtain an executor with the blocking.never property.
+ —
Obtain an executor with the relationship.fork property. +
—
Obtain an executor with the relationship.continuation + property.
—
Obtain an executor with the outstanding_work.tracked + property.
—
Obtain an executor with the outstanding_work.untracked + property.
—
Obtain an executor with the specified allocator + property.
—
Obtain an executor with the default allocator + property. +

+
+

+ running_in_this_thread +

+ 		+

+ Determine whether the thread pool is running in the current thread. +

+
+

+ ~basic_executor_type [destructor] +

+ 		+

+ Destructor. +

+
+
+ + Friends +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ operator!= +

+ 		+

+ Compare two executors for inequality. +

+
+

+ operator== +

+ 		+

+ Compare two executors for equality. +

+
+
+ + Requirements +
+

+ Header: asio/thread_pool.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/_basic_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/_basic_executor_type.html new file mode 100644 index 0000000..847394a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/_basic_executor_type.html @@ -0,0 +1,41 @@ + + + +thread_pool::basic_executor_type::~basic_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor. +

+
~basic_executor_type();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type.html new file mode 100644 index 0000000..71a8e88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type.html @@ -0,0 +1,51 @@ + + + +thread_pool::basic_executor_type::basic_executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Copy + constructor. +

+
basic_executor_type(
+    const basic_executor_type & other);
+  » more...
+
+

+ Move constructor. +

+
basic_executor_type(
+    basic_executor_type && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type/overload1.html new file mode 100644 index 0000000..d726009 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type/overload1.html @@ -0,0 +1,42 @@ + + + +thread_pool::basic_executor_type::basic_executor_type (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Copy constructor. +

+
basic_executor_type(
+    const basic_executor_type & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type/overload2.html new file mode 100644 index 0000000..e43917e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/basic_executor_type/overload2.html @@ -0,0 +1,42 @@ + + + +thread_pool::basic_executor_type::basic_executor_type (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move constructor. +

+
basic_executor_type(
+    basic_executor_type && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/context.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/context.html new file mode 100644 index 0000000..88638d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/context.html @@ -0,0 +1,42 @@ + + + +thread_pool::basic_executor_type::context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + the underlying execution context. +

+
thread_pool & context() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/defer.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/defer.html new file mode 100644 index 0000000..ab88e84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/defer.html @@ -0,0 +1,80 @@ + + + +thread_pool::basic_executor_type::defer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the thread pool to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void defer(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the thread pool to execute the given function + object. The function object will never be executed inside defer(). + Instead, it will be scheduled to run on the thread pool. +

+

+ If the current thread belongs to the thread pool, defer() will delay scheduling the function object + until the current thread returns control to the pool. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/dispatch.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/dispatch.html new file mode 100644 index 0000000..ffd56d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/dispatch.html @@ -0,0 +1,76 @@ + + + +thread_pool::basic_executor_type::dispatch + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the thread pool to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void dispatch(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the thread pool to execute the given function + object. If the current thread belongs to the pool, dispatch() executes the function before returning. + Otherwise, the function will be scheduled to run on the thread pool. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/execute.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/execute.html new file mode 100644 index 0000000..5712280 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/execute.html @@ -0,0 +1,45 @@ + + + +thread_pool::basic_executor_type::execute + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Execution + function. +

+
template<
+    typename Function>
+void execute(
+    Function && f) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/on_work_finished.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/on_work_finished.html new file mode 100644 index 0000000..c4602b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/on_work_finished.html @@ -0,0 +1,47 @@ + + + +thread_pool::basic_executor_type::on_work_finished + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the thread pool that some work is no longer outstanding. +

+
void on_work_finished() const;
+
+

+ This function is used to inform the thread pool that some work has finished. + Once the count of unfinished work reaches zero, the thread pool's join() + function is permitted to exit. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/on_work_started.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/on_work_started.html new file mode 100644 index 0000000..c25e6d7 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/on_work_started.html @@ -0,0 +1,47 @@ + + + +thread_pool::basic_executor_type::on_work_started + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Inform + the thread pool that it has some outstanding work to do. +

+
void on_work_started() const;
+
+

+ This function is used to inform the thread pool that some work has begun. + This ensures that the thread pool's join() function will not return while the work + is underway. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_.html new file mode 100644 index 0000000..8e41f59 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_.html @@ -0,0 +1,51 @@ + + + +thread_pool::basic_executor_type::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assignment + operator. +

+
basic_executor_type & operator=(
+    const basic_executor_type & other);
+  » more...
+
+

+ Move assignment operator. +

+
basic_executor_type & operator=(
+    basic_executor_type && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_/overload1.html new file mode 100644 index 0000000..4e09100 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_/overload1.html @@ -0,0 +1,42 @@ + + + +thread_pool::basic_executor_type::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assignment operator. +

+
basic_executor_type & operator=(
+    const basic_executor_type & other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_/overload2.html new file mode 100644 index 0000000..d71d938 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq_/overload2.html @@ -0,0 +1,42 @@ + + + +thread_pool::basic_executor_type::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move assignment operator. +

+
basic_executor_type & operator=(
+    basic_executor_type && other);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq__eq_.html new file mode 100644 index 0000000..e510349 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_eq__eq_.html @@ -0,0 +1,57 @@ + + + +thread_pool::basic_executor_type::operator== + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two executors for equality. +

+
bool operator==(
+    const basic_executor_type & a,
+    const basic_executor_type & b);
+
+

+ Two executors are equal if they refer to the same underlying thread pool. +

+
+ + Requirements +
+

+ Header: asio/thread_pool.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_not__eq_.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_not__eq_.html new file mode 100644 index 0000000..4ec4fab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/operator_not__eq_.html @@ -0,0 +1,57 @@ + + + +thread_pool::basic_executor_type::operator!= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Compare + two executors for inequality. +

+
bool operator!=(
+    const basic_executor_type & a,
+    const basic_executor_type & b);
+
+

+ Two executors are equal if they refer to the same underlying thread pool. +

+
+ + Requirements +
+

+ Header: asio/thread_pool.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/post.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/post.html new file mode 100644 index 0000000..bb9cbc1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/post.html @@ -0,0 +1,76 @@ + + + +thread_pool::basic_executor_type::post + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Request + the thread pool to invoke the given function object. +

+
template<
+    typename Function,
+    typename OtherAllocator>
+void post(
+    Function && f,
+    const OtherAllocator & a) const;
+
+

+ This function is used to ask the thread pool to execute the given function + object. The function object will never be executed inside post(). + Instead, it will be scheduled to run on the thread pool. +

+
+ + Parameters +
+
+

+
+
f
+
+

+ The function object to be called. The executor will make a copy of + the handler object as required. The function signature of the function + object must be: +

+
void function();
+
+
+
a
+

+ An allocator that may be used by the executor to allocate the internal + storage needed for function invocation. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query.html new file mode 100644 index 0000000..e5947e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query.html @@ -0,0 +1,82 @@ + + + +thread_pool::basic_executor_type::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Query + the current value of the context + property. +

+
thread_pool & query(
+    execution::context_t ) const;
+  » more...
+
+

+ Query the current value of the blocking + property. +

+
constexpr execution::blocking_t query(
+    execution::blocking_t ) const;
+  » more...
+
+

+ Query the current value of the relationship + property. +

+
constexpr execution::relationship_t query(
+    execution::relationship_t ) const;
+  » more...
+
+

+ Query the current value of the allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr Allocator query(
+    execution::allocator_t< OtherAllocator > ) const;
+  » more...
+
+constexpr Allocator query(
+    execution::allocator_t< void > ) const;
+  » more...
+
+

+ Query the occupancy (recommended number of work items) for the pool. +

+
std::size_t query(
+    execution::occupancy_t ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload1.html new file mode 100644 index 0000000..5381aa5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload1.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::query (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the context + property. +

+
thread_pool & query(
+    execution::context_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+asio::thread_pool& pool = asio::query(
+    ex, asio::execution::context);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload2.html new file mode 100644 index 0000000..0258c1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload2.html @@ -0,0 +1,56 @@ + + + +thread_pool::basic_executor_type::query (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the blocking + property. +

+
constexpr execution::blocking_t query(
+    execution::blocking_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+if (asio::query(ex, asio::execution::blocking)
+      == asio::execution::blocking.always)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload3.html new file mode 100644 index 0000000..255db59 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload3.html @@ -0,0 +1,56 @@ + + + +thread_pool::basic_executor_type::query (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the relationship + property. +

+
constexpr execution::relationship_t query(
+    execution::relationship_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+if (asio::query(ex, asio::execution::relationship)
+      == asio::execution::relationship.continuation)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload4.html new file mode 100644 index 0000000..78e33c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload4.html @@ -0,0 +1,57 @@ + + + +thread_pool::basic_executor_type::query (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr Allocator query(
+    execution::allocator_t< OtherAllocator > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+auto alloc = asio::query(ex,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload5.html new file mode 100644 index 0000000..88953f9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload5.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::query (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the allocator + property. +

+
constexpr Allocator query(
+    execution::allocator_t< void > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+auto alloc = asio::query(ex,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload6.html new file mode 100644 index 0000000..c2fcecf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query/overload6.html @@ -0,0 +1,54 @@ + + + +thread_pool::basic_executor_type::query (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the occupancy (recommended number of work items) for the pool. +

+
std::size_t query(
+    execution::occupancy_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+std::size_t occupancy = asio::query(
+    ex, asio::execution::occupancy);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static.html new file mode 100644 index 0000000..ec26c25 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static.html @@ -0,0 +1,53 @@ + + + +thread_pool::basic_executor_type::query + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Query + the current value of the mapping + property. +

+
static constexpr execution::mapping_t query(
+    execution::mapping_t );
+  » more...
+
+

+ Query the current value of the outstanding_work + property. +

+
static constexpr execution::outstanding_work_t query(
+    execution::outstanding_work_t );
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static/overload1.html new file mode 100644 index 0000000..b5ba011 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static/overload1.html @@ -0,0 +1,56 @@ + + + +thread_pool::basic_executor_type::query (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the mapping + property. +

+
static constexpr execution::mapping_t query(
+    execution::mapping_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+if (asio::query(ex, asio::execution::mapping)
+      == asio::execution::mapping.thread)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static/overload2.html new file mode 100644 index 0000000..b1b64f2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/query__static/overload2.html @@ -0,0 +1,56 @@ + + + +thread_pool::basic_executor_type::query (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Query the current value of the outstanding_work + property. +

+
static constexpr execution::outstanding_work_t query(
+    execution::outstanding_work_t );
+
+

+ Do not call this function directly. It is intended for use with the + query + customisation point. +

+

+ For example: +

+
auto ex = my_thread_pool.executor();
+if (asio::query(ex, asio::execution::outstanding_work)
+      == asio::execution::outstanding_work.tracked)
+  ...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require.html new file mode 100644 index 0000000..a75f231 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require.html @@ -0,0 +1,111 @@ + + + +thread_pool::basic_executor_type::require + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + an executor with the blocking.possibly + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::blocking_t::possibly_t ) const;
+  » more...
+
+

+ Obtain an executor with the blocking.always + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::blocking_t::always_t ) const;
+  » more...
+
+

+ Obtain an executor with the blocking.never + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::blocking_t::never_t ) const;
+  » more...
+
+

+ Obtain an executor with the relationship.fork + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::fork_t ) const;
+  » more...
+
+

+ Obtain an executor with the relationship.continuation + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::continuation_t ) const;
+  » more...
+
+

+ Obtain an executor with the outstanding_work.tracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::tracked_t ) const;
+  » more...
+
+

+ Obtain an executor with the outstanding_work.untracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::untracked_t ) const;
+  » more...
+
+

+ Obtain an executor with the specified allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr basic_executor_type< OtherAllocator, Bits > require(
+    execution::allocator_t< OtherAllocator > a) const;
+  » more...
+
+

+ Obtain an executor with the default allocator + property. +

+
constexpr basic_executor_type< std::allocator< void >, Bits > require(
+    execution::allocator_t< void > ) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload1.html new file mode 100644 index 0000000..6c03718 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload1.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (1 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.possibly + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::blocking_t::possibly_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.possibly);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload2.html new file mode 100644 index 0000000..89f6da6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload2.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (2 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.always + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::blocking_t::always_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.always);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload3.html new file mode 100644 index 0000000..8b2b98e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload3.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (3 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the blocking.never + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::blocking_t::never_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::blocking.never);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload4.html new file mode 100644 index 0000000..a2615d0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload4.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (4 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the relationship.fork + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::fork_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::relationship.fork);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload5.html new file mode 100644 index 0000000..904c58a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload5.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (5 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the relationship.continuation + property. +

+
constexpr basic_executor_type require(
+    execution::relationship_t::continuation_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::relationship.continuation);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload6.html new file mode 100644 index 0000000..25ee427 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload6.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (6 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the outstanding_work.tracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::tracked_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::outstanding_work.tracked);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload7.html new file mode 100644 index 0000000..eff4990 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload7.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (7 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the outstanding_work.untracked + property. +

+
constexpr basic_executor_type< Allocator, unspecified > require(
+    execution::outstanding_work_t::untracked_t ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::outstanding_work.untracked);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload8.html new file mode 100644 index 0000000..b98ecd0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload8.html @@ -0,0 +1,57 @@ + + + +thread_pool::basic_executor_type::require (8 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the specified allocator + property. +

+
template<
+    typename OtherAllocator>
+constexpr basic_executor_type< OtherAllocator, Bits > require(
+    execution::allocator_t< OtherAllocator > a) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::allocator(my_allocator));
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload9.html new file mode 100644 index 0000000..4d5f767 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/require/overload9.html @@ -0,0 +1,55 @@ + + + +thread_pool::basic_executor_type::require (9 of 9 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Obtain an executor with the default allocator + property. +

+
constexpr basic_executor_type< std::allocator< void >, Bits > require(
+    execution::allocator_t< void > ) const;
+
+

+ Do not call this function directly. It is intended for use with the + require + customisation point. +

+

+ For example: +

+
auto ex1 = my_thread_pool.executor();
+auto ex2 = asio::require(ex1,
+    asio::execution::allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/running_in_this_thread.html b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/running_in_this_thread.html new file mode 100644 index 0000000..a7470bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/thread_pool__basic_executor_type/running_in_this_thread.html @@ -0,0 +1,51 @@ + + + +thread_pool::basic_executor_type::running_in_this_thread + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the thread pool is running in the current thread. +

+
bool running_in_this_thread() const;
+
+
+ + Return + Value +
+

+ true if the current thread + is running the thread pool. Otherwise returns false. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/throw_exception.html b/Packages/asio-1.36.0/doc/asio/reference/throw_exception.html new file mode 100644 index 0000000..34f7688 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/throw_exception.html @@ -0,0 +1,57 @@ + + + +throw_exception + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper function to throw an exception arising from a disposition. +

+
template<
+    typename Disposition>
+void throw_exception(
+    Disposition && d,
+    constraint_t< is_disposition< decay_t< Disposition > >::value >  = 0);
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits.html new file mode 100644 index 0000000..7694a2a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits.html @@ -0,0 +1,55 @@ + + + +time_traits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ (Deprecated) Time traits suitable for use with the deadline timer. +

+
template<
+    typename Time>
+struct time_traits
+
+
+ + Requirements +
+

+ Header: asio/time_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_.html new file mode 100644 index 0000000..a190301 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_.html @@ -0,0 +1,188 @@ + + + +time_traits< boost::posix_time::ptime > + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ (Deprecated) Time traits specialised for posix_time. +

+
template<>
+struct time_traits< boost::posix_time::ptime >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ duration_type +

+ 		+

+ The duration type. +

+
+

+ time_type +

+ 		+

+ The time type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ add [static] +

+ 		+

+ Add a duration to a time. +

+
+

+ less_than [static] +

+ 		+

+ Test whether one time is less than another. +

+
+

+ now [static] +

+ 		+

+ Get the current time. +

+
+

+ subtract [static] +

+ 		+

+ Subtract one time from another. +

+
+

+ to_posix_duration [static] +

+ 		+

+ Convert to POSIX duration type. +

+
+
+ + Requirements +
+

+ Header: asio/time_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/add.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/add.html new file mode 100644 index 0000000..bbc5cf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/add.html @@ -0,0 +1,44 @@ + + + +time_traits< boost::posix_time::ptime >::add + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Add a duration to a time. +

+
static time_type add(
+    const time_type & t,
+    const duration_type & d);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/duration_type.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/duration_type.html new file mode 100644 index 0000000..f298574 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/duration_type.html @@ -0,0 +1,52 @@ + + + +time_traits< boost::posix_time::ptime >::duration_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The duration type. +

+
typedef boost::posix_time::time_duration duration_type;
+
+
+ + Requirements +
+

+ Header: asio/time_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/less_than.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/less_than.html new file mode 100644 index 0000000..bf694b9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/less_than.html @@ -0,0 +1,44 @@ + + + +time_traits< boost::posix_time::ptime >::less_than + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Test whether one time is less than another. +

+
static bool less_than(
+    const time_type & t1,
+    const time_type & t2);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/now.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/now.html new file mode 100644 index 0000000..6a5baae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/now.html @@ -0,0 +1,42 @@ + + + +time_traits< boost::posix_time::ptime >::now + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get the current time. +

+
static time_type now();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/subtract.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/subtract.html new file mode 100644 index 0000000..d384a84 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/subtract.html @@ -0,0 +1,44 @@ + + + +time_traits< boost::posix_time::ptime >::subtract + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Subtract one time from another. +

+
static duration_type subtract(
+    const time_type & t1,
+    const time_type & t2);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/time_type.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/time_type.html new file mode 100644 index 0000000..e3cbc31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/time_type.html @@ -0,0 +1,52 @@ + + + +time_traits< boost::posix_time::ptime >::time_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The time type. +

+
typedef boost::posix_time::ptime time_type;
+
+
+ + Requirements +
+

+ Header: asio/time_traits.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/to_posix_duration.html b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/to_posix_duration.html new file mode 100644 index 0000000..65e6358 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/time_traits_lt__ptime__gt_/to_posix_duration.html @@ -0,0 +1,43 @@ + + + +time_traits< boost::posix_time::ptime >::to_posix_duration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Convert to POSIX duration type. +

+
static boost::posix_time::time_duration to_posix_duration(
+    const duration_type & d);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/to_exception_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/to_exception_ptr.html new file mode 100644 index 0000000..e7e10dd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/to_exception_ptr.html @@ -0,0 +1,57 @@ + + + +to_exception_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Helper function to convert a disposition to an exception_ptr. +

+
template<
+    typename Disposition>
+std::exception_ptr to_exception_ptr(
+    Disposition && d,
+    constraint_t< is_disposition< decay_t< Disposition > >::value >  = 0);
+
+
+ + Requirements +
+

+ Header: asio/disposition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/transfer_all.html b/Packages/asio-1.36.0/doc/asio/reference/transfer_all.html new file mode 100644 index 0000000..58553fb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/transfer_all.html @@ -0,0 +1,80 @@ + + + +transfer_all + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ 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();
+
+

+ This function is used to create an object, of unspecified type, that meets + CompletionCondition requirements. +

+
+ + Example +
+

+ Reading until a buffer is full: +

+
boost::array<char, 128> buf;
+asio::error_code ec;
+std::size_t n = asio::read(
+    sock, asio::buffer(buf),
+    asio::transfer_all(), ec);
+if (ec)
+{
+  // An error occurred.
+}
+else
+{
+  // n == 128
+}
+
+
+ + Requirements +
+

+ Header: asio/completion_condition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/transfer_at_least.html b/Packages/asio-1.36.0/doc/asio/reference/transfer_at_least.html new file mode 100644 index 0000000..a8f36e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/transfer_at_least.html @@ -0,0 +1,81 @@ + + + +transfer_at_least + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ 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. +

+
+ + Example +
+

+ Reading until a buffer is full or contains at least 64 bytes: +

+
boost::array<char, 128> buf;
+asio::error_code ec;
+std::size_t n = asio::read(
+    sock, asio::buffer(buf),
+    asio::transfer_at_least(64), ec);
+if (ec)
+{
+  // An error occurred.
+}
+else
+{
+  // n >= 64 && n <= 128
+}
+
+
+ + Requirements +
+

+ Header: asio/completion_condition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/transfer_exactly.html b/Packages/asio-1.36.0/doc/asio/reference/transfer_exactly.html new file mode 100644 index 0000000..3b043c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/transfer_exactly.html @@ -0,0 +1,81 @@ + + + +transfer_exactly + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ 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. +

+
+ + Example +
+

+ Reading until a buffer is full or contains exactly 64 bytes: +

+
boost::array<char, 128> buf;
+asio::error_code ec;
+std::size_t n = asio::read(
+    sock, asio::buffer(buf),
+    asio::transfer_exactly(64), ec);
+if (ec)
+{
+  // An error occurred.
+}
+else
+{
+  // n == 64
+}
+
+
+ + Requirements +
+

+ Header: asio/completion_condition.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable.html new file mode 100644 index 0000000..b085507 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable.html @@ -0,0 +1,57 @@ + + + +use_awaitable + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + object that represents the currently executing coroutine. +

+
constexpr use_awaitable_t use_awaitable;
+
+

+ See the documentation for use_awaitable_t for a usage example. +

+
+ + Requirements +
+

+ Header: asio/use_awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t.html new file mode 100644 index 0000000..f2f2202 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t.html @@ -0,0 +1,175 @@ + + + +use_awaitable_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + that represents the currently executing coroutine. +

+
template<
+    typename Executor = any_io_executor>
+struct use_awaitable_t
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use use_awaitable_t as its + default completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the use_awaitable_t completion token + as the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use use_awaitable_t as + its default completion token type. +

+
+

+ use_awaitable_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor used to specify + file name, line, and function name. +

+
+

+ The use_awaitable_t class, + with its value use_awaitable, + is used to represent the currently executing coroutine. This completion token + may be passed as a handler to an asynchronous operation. For example: +

+
awaitable<void> my_coroutine()
+{
+  std::size_t n = co_await my_socket.async_read_some(buffer, use_awaitable);
+  ...
+}
+
+

+ When used with co_await, the initiating function (async_read_some + in the above example) suspends the current coroutine. The coroutine is resumed + when the asynchronous operation completes, and the result of the operation + is returned. +

+
+ + Requirements +
+

+ Header: asio/use_awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/as_default_on.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/as_default_on.html new file mode 100644 index 0000000..2fcc1f1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/as_default_on.html @@ -0,0 +1,46 @@ + + + +use_awaitable_t::as_default_on + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Function + helper to adapt an I/O object to use use_awaitable_t + as its default completion token type. +

+
template<
+    typename T>
+static decay_t< T >::template rebind_executor< executor_with_default< typenamedecay_t< T >::executor_type > >::other as_default_on(
+    T && object);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/as_default_on_t.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/as_default_on_t.html new file mode 100644 index 0000000..3359834 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/as_default_on_t.html @@ -0,0 +1,122 @@ + + + +use_awaitable_t::as_default_on_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Type + alias to adapt an I/O object to use use_awaitable_t + as its default completion token type. +

+
typedef typename T::template rebind_executor< executor_with_default< typename T::executor_type > >::other as_default_on_t;
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify use_awaitable_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/use_awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t.html new file mode 100644 index 0000000..8a673a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t.html @@ -0,0 +1,52 @@ + + + +use_awaitable_t::use_awaitable_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Default + constructor. +

+
constexpr use_awaitable_t();
+  » more...
+
+

+ Constructor used to specify file name, line, and function name. +

+
constexpr use_awaitable_t(
+    const char * file_name,
+    int line,
+    const char * function_name);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t/overload1.html new file mode 100644 index 0000000..e2abbcc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t/overload1.html @@ -0,0 +1,41 @@ + + + +use_awaitable_t::use_awaitable_t (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Default constructor. +

+
constexpr use_awaitable_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t/overload2.html new file mode 100644 index 0000000..2de4235 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t/use_awaitable_t/overload2.html @@ -0,0 +1,44 @@ + + + +use_awaitable_t::use_awaitable_t (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Constructor used to specify file name, line, and function name. +

+
constexpr use_awaitable_t(
+    const char * file_name,
+    int line,
+    const char * function_name);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default.html new file mode 100644 index 0000000..d4bfc7b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default.html @@ -0,0 +1,126 @@ + + + +use_awaitable_t::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Adapts an executor to add the use_awaitable_t + completion token as the default. +

+
template<
+    typename InnerExecutor>
+struct executor_with_default :
+  public InnerExecutor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ default_completion_token_type +

+ 		+

+ Specify use_awaitable_t as the default completion token type. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ executor_with_default [constructor] +

+ 		+

+ Construct the adapted executor from the inner executor type. +

+
+
+ + Requirements +
+

+ Header: asio/use_awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default/default_completion_token_type.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default/default_completion_token_type.html new file mode 100644 index 0000000..b005dd0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default/default_completion_token_type.html @@ -0,0 +1,172 @@ + + + +use_awaitable_t::executor_with_default::default_completion_token_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify + use_awaitable_t as the + default completion token type. +

+
typedef use_awaitable_t default_completion_token_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on_t +

+ 		+

+ Type alias to adapt an I/O object to use use_awaitable_t as its + default completion token type. +

+
+

+ executor_with_default +

+ 		+

+ Adapts an executor to add the use_awaitable_t completion token + as the default. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ as_default_on [static] +

+ 		+

+ Function helper to adapt an I/O object to use use_awaitable_t + as its default completion token type. +

+
+

+ use_awaitable_t [constructor] +

+ 		+

+ Default constructor.
—
Constructor used to specify + file name, line, and function name. +

+
+

+ The use_awaitable_t class, + with its value use_awaitable, + is used to represent the currently executing coroutine. This completion + token may be passed as a handler to an asynchronous operation. For example: +

+
awaitable<void> my_coroutine()
+{
+  std::size_t n = co_await my_socket.async_read_some(buffer, use_awaitable);
+  ...
+}
+
+

+ When used with co_await, the initiating function (async_read_some + in the above example) suspends the current coroutine. The coroutine is + resumed when the asynchronous operation completes, and the result of the + operation is returned. +

+
+ + Requirements +
+

+ Header: asio/use_awaitable.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default/executor_with_default.html b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default/executor_with_default.html new file mode 100644 index 0000000..6dc65c5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_awaitable_t__executor_with_default/executor_with_default.html @@ -0,0 +1,46 @@ + + + +use_awaitable_t::executor_with_default::executor_with_default + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + the adapted executor from the inner executor type. +

+
template<
+    typename InnerExecutor1>
+executor_with_default(
+    const InnerExecutor1 & ex,
+    constraint_t< conditional_t< !is_same< InnerExecutor1, executor_with_default >::value, is_convertible< InnerExecutor1, InnerExecutor >, false_type >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future.html b/Packages/asio-1.36.0/doc/asio/reference/use_future.html new file mode 100644 index 0000000..26a6344 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future.html @@ -0,0 +1,57 @@ + + + +use_future + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + object that causes an asynchronous operation to return a future. +

+
constexpr use_future_t use_future;
+
+

+ See the documentation for use_future_t for a usage example. +

+
+ + Requirements +
+

+ Header: asio/use_future.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t.html new file mode 100644 index 0000000..c96e599 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t.html @@ -0,0 +1,181 @@ + + + +use_future_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + type that causes an asynchronous operation to return a future. +

+
template<
+    typename Allocator = std::allocator<void>>
+class use_future_t
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ allocator_type +

+ 		+

+ The allocator type. The allocator is used when constructing the + std::promise object for a given asynchronous operation. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ get_allocator +

+ 		+

+ Obtain allocator. +

+
+

+ operator() +

+ 		+

+ Wrap a function object in a packaged task.
—
+

+
+

+ rebind +

+ 		+

+ Specify an alternate allocator. +

+
+

+ use_future_t [constructor] +

+ 		+

+ Construct using default-constructed allocator.
—
Construct + using specified allocator. +

+
+

+ The use_future_t + class is a completion token type that is used to indicate that an asynchronous + operation should return a std::future object. A use_future_t object may be passed + as a completion token to an asynchronous operation, typically using the special + value asio::use_future. For example: +

+
std::future<std::size_t> my_future
+ = my_socket.async_read_some(my_buffer, asio::use_future);
+
+

+ The initiating function (async_read_some in the above example) returns a + future that will receive the result of the operation. If the operation completes + with an error_code indicating failure, it is converted into a system_error + and passed back to the caller via the future. +

+
+ + Requirements +
+

+ Header: asio/use_future.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/allocator_type.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/allocator_type.html new file mode 100644 index 0000000..d063f88 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/allocator_type.html @@ -0,0 +1,53 @@ + + + +use_future_t::allocator_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + allocator type. The allocator is used when constructing the std::promise object for a given asynchronous + operation. +

+
typedef Allocator allocator_type;
+
+
+ + Requirements +
+

+ Header: asio/use_future.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/get_allocator.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/get_allocator.html new file mode 100644 index 0000000..3d0b036 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/get_allocator.html @@ -0,0 +1,42 @@ + + + +use_future_t::get_allocator + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Obtain + allocator. +

+
allocator_type get_allocator() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_.html new file mode 100644 index 0000000..f2cf886 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_.html @@ -0,0 +1,54 @@ + + + +use_future_t::operator() + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Wrap + a function object in a packaged task. +

+
template<
+    typename Function>
+unspecified operator()(
+    Function && f) const;
+  » more...
+
+
+
+template<
+    typename Function>
+detail::packaged_token< decay_t< Function >, Allocator > operator()(
+    Function && f) const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_/overload1.html new file mode 100644 index 0000000..8cfcf77 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_/overload1.html @@ -0,0 +1,63 @@ + + + +use_future_t::operator() (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Wrap a function object in a packaged task. +

+
template<
+    typename Function>
+unspecified operator()(
+    Function && f) const;
+
+

+ The package function + is used to adapt a function object as a packaged task. When this adapter + is passed as a completion token to an asynchronous operation, the result + of the function object is returned via a std::future. +

+
+ + Example +
+
std::future<std::size_t> fut =
+  my_socket.async_read_some(buffer,
+    use_future([](asio::error_code ec, std::size_t n)
+      {
+        return ec ? 0 : n;
+      }));
+...
+std::size_t n = fut.get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_/overload2.html new file mode 100644 index 0000000..f99913e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/operator_lp__rp_/overload2.html @@ -0,0 +1,41 @@ + + + +use_future_t::operator() (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
template<
+    typename Function>
+detail::packaged_token< decay_t< Function >, Allocator > operator()(
+    Function && f) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/rebind.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/rebind.html new file mode 100644 index 0000000..8b83587 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/rebind.html @@ -0,0 +1,45 @@ + + + +use_future_t::rebind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Specify an alternate + allocator. +

+
template<
+    typename OtherAllocator>
+use_future_t< OtherAllocator > rebind(
+    const OtherAllocator & allocator) const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t.html new file mode 100644 index 0000000..655ab6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t.html @@ -0,0 +1,50 @@ + + + +use_future_t::use_future_t + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + using default-constructed allocator. +

+
constexpr use_future_t();
+  » more...
+
+

+ Construct using specified allocator. +

+
explicit use_future_t(
+    const Allocator & allocator);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t/overload1.html new file mode 100644 index 0000000..2770299 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t/overload1.html @@ -0,0 +1,41 @@ + + + +use_future_t::use_future_t (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct using default-constructed allocator. +

+
constexpr use_future_t();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t/overload2.html new file mode 100644 index 0000000..f24eadf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/use_future_t/use_future_t/overload2.html @@ -0,0 +1,42 @@ + + + +use_future_t::use_future_t (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct using specified allocator. +

+
use_future_t(
+    const Allocator & allocator);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/uses_executor.html b/Packages/asio-1.36.0/doc/asio/reference/uses_executor.html new file mode 100644 index 0000000..6d72ae9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/uses_executor.html @@ -0,0 +1,66 @@ + + + +uses_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The uses_executor + trait detects whether a type T has an associated executor that is convertible + from type Executor. +

+
template<
+    typename T,
+    typename Executor>
+struct uses_executor :
+  public false_type
+
+

+ Meets the BinaryTypeTrait requirements. The Asio library provides a definition + that is derived from false_type. A program may specialize this template to + derive from true_type for a user-defined type T that can be constructed with + an executor, where the first argument of a constructor has type executor_arg_t and the second argument + is convertible from type Executor. +

+
+ + Requirements +
+

+ Header: asio/uses_executor.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/wait_traits.html b/Packages/asio-1.36.0/doc/asio/reference/wait_traits.html new file mode 100644 index 0000000..b2e46c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/wait_traits.html @@ -0,0 +1,90 @@ + + + +wait_traits + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wait traits suitable for use with the basic_waitable_timer class template. +

+
template<
+    typename Clock>
+struct wait_traits
+
+
+ + Member + Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ to_wait_duration [static] +

+ 		+

+ Convert a clock duration into a duration used for waiting. +

+
+
+ + Requirements +
+

+ Header: asio/wait_traits.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration.html b/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration.html new file mode 100644 index 0000000..2312f6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration.html @@ -0,0 +1,48 @@ + + + +wait_traits::to_wait_duration + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Convert + a clock duration into a duration used for waiting. +

+
static Clock::duration to_wait_duration(
+    const typename Clock::duration & d);
+  » more...
+
+static Clock::duration to_wait_duration(
+    const typename Clock::time_point & t);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration/overload1.html new file mode 100644 index 0000000..a885ef8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration/overload1.html @@ -0,0 +1,50 @@ + + + +wait_traits::to_wait_duration (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Convert a clock duration into a duration used for waiting. +

+
static Clock::duration to_wait_duration(
+    const typename Clock::duration & d);
+
+
+ + Return + Value +
+

+ d. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration/overload2.html new file mode 100644 index 0000000..18c7ba1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/wait_traits/to_wait_duration/overload2.html @@ -0,0 +1,50 @@ + + + +wait_traits::to_wait_duration (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Convert a clock duration into a duration used for waiting. +

+
static Clock::duration to_wait_duration(
+    const typename Clock::time_point & t);
+
+
+ + Return + Value +
+

+ d. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle.html new file mode 100644 index 0000000..a42a8ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle.html @@ -0,0 +1,304 @@ + + + +windows::basic_object_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides object-oriented handle functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_object_handle
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An object handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the object handle. +

+
+

+ basic_object_handle [constructor] +

+ 		+

+ Construct an object handle without opening it.
—
Construct + an object handle on an existing native handle.
—
Move-construct + an object handle from another.
—
Move-construct an + object handle from a handle of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an object handle from another.
—
Move-assign + an object handle from a handle of another executor type. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the object handle. +

+
+

+ The windows::basic_object_handle class provides + asynchronous and blocking object-oriented handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_object_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign.html new file mode 100644 index 0000000..481c5c0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign.html @@ -0,0 +1,49 @@ + + + +windows::basic_object_handle::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+  » more...
+
+void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign/overload1.html new file mode 100644 index 0000000..8e9e2b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign/overload1.html @@ -0,0 +1,42 @@ + + + +windows::basic_object_handle::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign/overload2.html new file mode 100644 index 0000000..a78818b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/assign/overload2.html @@ -0,0 +1,43 @@ + + + +windows::basic_object_handle::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/async_wait.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/async_wait.html new file mode 100644 index 0000000..5821d7f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/async_wait.html @@ -0,0 +1,89 @@ + + + +windows::basic_object_handle::async_wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous wait on the object handle. +

+
template<
+    typename WaitToken = default_completion_token_t<executor_type>>
+DEDUCED async_wait(
+    WaitToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is be used to initiate an asynchronous wait against the object + handle. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the wait completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::error_code& error // Result of operation.
+);
+
+

+ Regardless of whether the asynchronous operation completes immediately + or not, the completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code)
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle.html new file mode 100644 index 0000000..342ccdf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle.html @@ -0,0 +1,84 @@ + + + +windows::basic_object_handle::basic_object_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an object handle without opening it. +

+
explicit basic_object_handle(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_object_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct an object handle on an existing native handle. +

+
basic_object_handle(
+    const executor_type & ex,
+    const native_handle_type & native_handle);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_object_handle(
+    ExecutionContext & context,
+    const native_handle_type & native_handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct an object handle from another. +

+
basic_object_handle(
+    basic_object_handle && other);
+  » more...
+
+

+ Move-construct an object handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+basic_object_handle(
+    basic_object_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload1.html new file mode 100644 index 0000000..a82efe2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload1.html @@ -0,0 +1,60 @@ + + + +windows::basic_object_handle::basic_object_handle (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an object handle without opening it. +

+
basic_object_handle(
+    const executor_type & ex);
+
+

+ This constructor creates an object handle without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the object handle will use, by default, to + dispatch handlers for any asynchronous operations performed on + the object handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload2.html new file mode 100644 index 0000000..174f13d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload2.html @@ -0,0 +1,63 @@ + + + +windows::basic_object_handle::basic_object_handle (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an object handle without opening it. +

+
template<
+    typename ExecutionContext>
+basic_object_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates an object handle without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the object + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the object handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload3.html new file mode 100644 index 0000000..4449a66 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload3.html @@ -0,0 +1,79 @@ + + + +windows::basic_object_handle::basic_object_handle (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an object handle on an existing native handle. +

+
basic_object_handle(
+    const executor_type & ex,
+    const native_handle_type & native_handle);
+
+

+ This constructor creates an object handle object to hold an existing + native handle. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the object handle will use, by default, to + dispatch handlers for any asynchronous operations performed on + the object handle. +

+
native_handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload4.html new file mode 100644 index 0000000..613c7c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload4.html @@ -0,0 +1,82 @@ + + + +windows::basic_object_handle::basic_object_handle (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an object handle on an existing native handle. +

+
template<
+    typename ExecutionContext>
+basic_object_handle(
+    ExecutionContext & context,
+    const native_handle_type & native_handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates an object handle object to hold an existing + native handle. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the object + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the object handle. +

+
native_handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload5.html new file mode 100644 index 0000000..e46df26 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload5.html @@ -0,0 +1,67 @@ + + + +windows::basic_object_handle::basic_object_handle (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct an object handle from another. +

+
basic_object_handle(
+    basic_object_handle && other);
+
+

+ This constructor moves an object handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other object handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_object_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload6.html new file mode 100644 index 0000000..8217eb9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/basic_object_handle/overload6.html @@ -0,0 +1,70 @@ + + + +windows::basic_object_handle::basic_object_handle (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct an object handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+basic_object_handle(
+    basic_object_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves an object handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other object handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_object_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel.html new file mode 100644 index 0000000..9b1d34d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel.html @@ -0,0 +1,47 @@ + + + +windows::basic_object_handle::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the handle. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel/overload1.html new file mode 100644 index 0000000..70a2748 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel/overload1.html @@ -0,0 +1,59 @@ + + + +windows::basic_object_handle::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel/overload2.html new file mode 100644 index 0000000..3e216c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/cancel/overload2.html @@ -0,0 +1,60 @@ + + + +windows::basic_object_handle::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close.html new file mode 100644 index 0000000..9c8cc92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close.html @@ -0,0 +1,47 @@ + + + +windows::basic_object_handle::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the handle. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close/overload1.html new file mode 100644 index 0000000..80f3d0e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close/overload1.html @@ -0,0 +1,59 @@ + + + +windows::basic_object_handle::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the handle. +

+
void close();
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close/overload2.html new file mode 100644 index 0000000..5ce4dcd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/close/overload2.html @@ -0,0 +1,60 @@ + + + +windows::basic_object_handle::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the handle. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/executor_type.html new file mode 100644 index 0000000..5e58f66 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/executor_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_object_handle::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_object_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/get_executor.html new file mode 100644 index 0000000..3b6cf80 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/get_executor.html @@ -0,0 +1,42 @@ + + + +windows::basic_object_handle::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/is_open.html new file mode 100644 index 0000000..51ec601 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/is_open.html @@ -0,0 +1,42 @@ + + + +windows::basic_object_handle::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the handle is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer.html new file mode 100644 index 0000000..65be9f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer.html @@ -0,0 +1,49 @@ + + + +windows::basic_object_handle::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer/overload1.html new file mode 100644 index 0000000..bd6a0cb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer/overload1.html @@ -0,0 +1,55 @@ + + + +windows::basic_object_handle::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 an object handle cannot contain any further layers, it simply returns + a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer/overload2.html new file mode 100644 index 0000000..cae1666 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer/overload2.html @@ -0,0 +1,55 @@ + + + +windows::basic_object_handle::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since an object handle cannot contain any further layers, + it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer_type.html new file mode 100644 index 0000000..5c2d289 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/lowest_layer_type.html @@ -0,0 +1,302 @@ + + + +windows::basic_object_handle::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +An + object handle is always the lowest layer. +

+
typedef basic_object_handle lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An object handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the object handle. +

+
+

+ basic_object_handle [constructor] +

+ 		+

+ Construct an object handle without opening it.
—
+ Construct an object handle on an existing native handle.
+ —
Move-construct an object handle from another.
— +
Move-construct an object handle from a handle of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an object handle from another.
—
Move-assign + an object handle from a handle of another executor type. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the object handle. +

+
+

+ The windows::basic_object_handle class provides + asynchronous and blocking object-oriented handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_object_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/native_handle.html new file mode 100644 index 0000000..c149cfc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/native_handle.html @@ -0,0 +1,47 @@ + + + +windows::basic_object_handle::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the native handle representation. +

+
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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/native_handle_type.html new file mode 100644 index 0000000..881adbc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/native_handle_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_object_handle::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a handle. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_object_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_.html new file mode 100644 index 0000000..81edf79 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_.html @@ -0,0 +1,53 @@ + + + +windows::basic_object_handle::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + an object handle from another. +

+
basic_object_handle & operator=(
+    basic_object_handle && other);
+  » more...
+
+

+ Move-assign an object handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_object_handle & > operator=(
+    basic_object_handle< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_/overload1.html new file mode 100644 index 0000000..8bd5b81 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_/overload1.html @@ -0,0 +1,67 @@ + + + +windows::basic_object_handle::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign an object handle from another. +

+
basic_object_handle & operator=(
+    basic_object_handle && other);
+
+

+ This assignment operator moves an object handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other object handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_object_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_/overload2.html new file mode 100644 index 0000000..22b08b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/operator_eq_/overload2.html @@ -0,0 +1,69 @@ + + + +windows::basic_object_handle::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign an object handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_object_handle & > operator=(
+    basic_object_handle< Executor1 > && other);
+
+

+ This assignment operator moves an object handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other object handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_object_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait.html new file mode 100644 index 0000000..f6771aa --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait.html @@ -0,0 +1,47 @@ + + + +windows::basic_object_handle::wait + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Perform + a blocking wait on the object handle. +

+
void wait();
+  » more...
+
+void wait(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait/overload1.html new file mode 100644 index 0000000..b5e5de4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait/overload1.html @@ -0,0 +1,59 @@ + + + +windows::basic_object_handle::wait (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait/overload2.html new file mode 100644 index 0000000..3adf5e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle/wait/overload2.html @@ -0,0 +1,60 @@ + + + +windows::basic_object_handle::wait (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Perform a blocking wait on the object handle. +

+
void wait(
+    asio::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. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle__rebind_executor.html new file mode 100644 index 0000000..6321793 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle__rebind_executor.html @@ -0,0 +1,89 @@ + + + +windows::basic_object_handle::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the handle type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The handle type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/windows/basic_object_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle__rebind_executor/other.html new file mode 100644 index 0000000..169b553 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_object_handle__rebind_executor/other.html @@ -0,0 +1,302 @@ + + + +windows::basic_object_handle::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + handle type when rebound to the specified executor. +

+
typedef basic_object_handle< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An object handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the object handle. +

+
+

+ basic_object_handle [constructor] +

+ 		+

+ Construct an object handle without opening it.
—
+ Construct an object handle on an existing native handle.
+ —
Move-construct an object handle from another.
— +
Move-construct an object handle from a handle of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an object handle from another.
—
Move-assign + an object handle from a handle of another executor type. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the object handle. +

+
+

+ The windows::basic_object_handle class provides + asynchronous and blocking object-oriented handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_object_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle.html new file mode 100644 index 0000000..7052429 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle.html @@ -0,0 +1,330 @@ + + + +windows::basic_overlapped_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides Windows handle functionality for objects that support overlapped + I/O. +

+
template<
+    typename Executor = any_io_executor>
+class basic_overlapped_handle
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ basic_overlapped_handle [constructor] +

+ 		+

+ Construct an overlapped handle without opening it.
—
+ Construct an overlapped handle on an existing native handle.
+ —
Move-construct an overlapped handle from another.
+ —
Move-construct an overlapped handle from a handle of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an overlapped handle from another.
—
Move-assign + an overlapped handle from a handle of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_overlapped_handle [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The windows::overlapped_handle class provides + the ability to wrap a Windows handle. The underlying object referred to by + the handle must support overlapped I/O. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_overlapped_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/_basic_overlapped_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/_basic_overlapped_handle.html new file mode 100644 index 0000000..20ed95a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/_basic_overlapped_handle.html @@ -0,0 +1,46 @@ + + + +windows::basic_overlapped_handle::~basic_overlapped_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Protected + destructor to prevent deletion through this type. +

+
~basic_overlapped_handle();
+
+

+ This function destroys the handle, cancelling any outstanding asynchronous + wait operations associated with the handle as if by calling cancel. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign.html new file mode 100644 index 0000000..2f08ad2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign.html @@ -0,0 +1,49 @@ + + + +windows::basic_overlapped_handle::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+  » more...
+
+void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign/overload1.html new file mode 100644 index 0000000..31ced86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign/overload1.html @@ -0,0 +1,42 @@ + + + +windows::basic_overlapped_handle::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign/overload2.html new file mode 100644 index 0000000..72f3f96 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/assign/overload2.html @@ -0,0 +1,43 @@ + + + +windows::basic_overlapped_handle::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle.html new file mode 100644 index 0000000..ebe734e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle.html @@ -0,0 +1,84 @@ + + + +windows::basic_overlapped_handle::basic_overlapped_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an overlapped handle without opening it. +

+
explicit basic_overlapped_handle(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_overlapped_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct an overlapped handle on an existing native handle. +

+
basic_overlapped_handle(
+    const executor_type & ex,
+    const native_handle_type & native_handle);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_overlapped_handle(
+    ExecutionContext & context,
+    const native_handle_type & native_handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct an overlapped handle from another. +

+
basic_overlapped_handle(
+    basic_overlapped_handle && other);
+  » more...
+
+

+ Move-construct an overlapped handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+basic_overlapped_handle(
+    basic_overlapped_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload1.html new file mode 100644 index 0000000..a6c8826 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload1.html @@ -0,0 +1,60 @@ + + + +windows::basic_overlapped_handle::basic_overlapped_handle (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an overlapped handle without opening it. +

+
basic_overlapped_handle(
+    const executor_type & ex);
+
+

+ This constructor creates an overlapped handle without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the overlapped handle will use, by default, + to dispatch handlers for any asynchronous operations performed + on the overlapped handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload2.html new file mode 100644 index 0000000..fbfb67c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload2.html @@ -0,0 +1,63 @@ + + + +windows::basic_overlapped_handle::basic_overlapped_handle (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an overlapped handle without opening it. +

+
template<
+    typename ExecutionContext>
+basic_overlapped_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates an overlapped handle without opening it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the overlapped + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the overlapped handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload3.html new file mode 100644 index 0000000..c927045 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload3.html @@ -0,0 +1,79 @@ + + + +windows::basic_overlapped_handle::basic_overlapped_handle (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an overlapped handle on an existing native handle. +

+
basic_overlapped_handle(
+    const executor_type & ex,
+    const native_handle_type & native_handle);
+
+

+ This constructor creates an overlapped handle object to hold an existing + native handle. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the overlapped handle will use, by default, + to dispatch handlers for any asynchronous operations performed + on the overlapped handle. +

+
native_handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload4.html new file mode 100644 index 0000000..e9fe03f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload4.html @@ -0,0 +1,82 @@ + + + +windows::basic_overlapped_handle::basic_overlapped_handle (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an overlapped handle on an existing native handle. +

+
template<
+    typename ExecutionContext>
+basic_overlapped_handle(
+    ExecutionContext & context,
+    const native_handle_type & native_handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates an overlapped handle object to hold an existing + native handle. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the overlapped + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the overlapped handle. +

+
native_handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload5.html new file mode 100644 index 0000000..f0969fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload5.html @@ -0,0 +1,67 @@ + + + +windows::basic_overlapped_handle::basic_overlapped_handle (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct an overlapped handle from another. +

+
basic_overlapped_handle(
+    basic_overlapped_handle && other);
+
+

+ This constructor moves a handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other overlapped handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the overlapped_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload6.html new file mode 100644 index 0000000..3a84d7b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/basic_overlapped_handle/overload6.html @@ -0,0 +1,71 @@ + + + +windows::basic_overlapped_handle::basic_overlapped_handle (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct an overlapped handle from a handle of another executor + type. +

+
template<
+    typename Executor1>
+basic_overlapped_handle(
+    basic_overlapped_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other overlapped handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the overlapped_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel.html new file mode 100644 index 0000000..52c648b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel.html @@ -0,0 +1,47 @@ + + + +windows::basic_overlapped_handle::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the handle. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel/overload1.html new file mode 100644 index 0000000..c7df5bc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel/overload1.html @@ -0,0 +1,59 @@ + + + +windows::basic_overlapped_handle::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel/overload2.html new file mode 100644 index 0000000..5084a78 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/cancel/overload2.html @@ -0,0 +1,60 @@ + + + +windows::basic_overlapped_handle::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close.html new file mode 100644 index 0000000..e43d1ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close.html @@ -0,0 +1,47 @@ + + + +windows::basic_overlapped_handle::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the handle. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close/overload1.html new file mode 100644 index 0000000..e9666ea --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close/overload1.html @@ -0,0 +1,59 @@ + + + +windows::basic_overlapped_handle::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the handle. +

+
void close();
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close/overload2.html new file mode 100644 index 0000000..8fcf7ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/close/overload2.html @@ -0,0 +1,60 @@ + + + +windows::basic_overlapped_handle::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Close the handle. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/executor_type.html new file mode 100644 index 0000000..905e0e0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/executor_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_overlapped_handle::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_overlapped_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/get_executor.html new file mode 100644 index 0000000..0ed5697 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/get_executor.html @@ -0,0 +1,42 @@ + + + +windows::basic_overlapped_handle::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/is_open.html new file mode 100644 index 0000000..fa86194 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/is_open.html @@ -0,0 +1,42 @@ + + + +windows::basic_overlapped_handle::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Determine + whether the handle is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer.html new file mode 100644 index 0000000..1745296 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer.html @@ -0,0 +1,49 @@ + + + +windows::basic_overlapped_handle::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer/overload1.html new file mode 100644 index 0000000..9f381ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer/overload1.html @@ -0,0 +1,55 @@ + + + +windows::basic_overlapped_handle::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ 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 an overlapped_handle cannot contain any further layers, it simply + returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer/overload2.html new file mode 100644 index 0000000..69485be --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer/overload2.html @@ -0,0 +1,55 @@ + + + +windows::basic_overlapped_handle::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since an overlapped_handle cannot contain any further layers, + it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer_type.html new file mode 100644 index 0000000..aa7a836 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/lowest_layer_type.html @@ -0,0 +1,327 @@ + + + +windows::basic_overlapped_handle::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +An + overlapped_handle is always the lowest layer. +

+
typedef basic_overlapped_handle lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ basic_overlapped_handle [constructor] +

+ 		+

+ Construct an overlapped handle without opening it.
—
+ Construct an overlapped handle on an existing native handle. +
—
Move-construct an overlapped handle from another. +
—
Move-construct an overlapped handle from a handle + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an overlapped handle from another.
—
+ Move-assign an overlapped handle from a handle of another executor + type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_overlapped_handle [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The windows::overlapped_handle class provides + the ability to wrap a Windows handle. The underlying object referred to + by the handle must support overlapped I/O. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_overlapped_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/native_handle.html new file mode 100644 index 0000000..2277944 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/native_handle.html @@ -0,0 +1,47 @@ + + + +windows::basic_overlapped_handle::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the native handle representation. +

+
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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/native_handle_type.html new file mode 100644 index 0000000..8bcc6ca --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/native_handle_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_overlapped_handle::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a handle. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_overlapped_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_.html new file mode 100644 index 0000000..8ec3a26 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_.html @@ -0,0 +1,53 @@ + + + +windows::basic_overlapped_handle::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + an overlapped handle from another. +

+
basic_overlapped_handle & operator=(
+    basic_overlapped_handle && other);
+  » more...
+
+

+ Move-assign an overlapped handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_overlapped_handle & > operator=(
+    basic_overlapped_handle< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_/overload1.html new file mode 100644 index 0000000..a00e04b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_/overload1.html @@ -0,0 +1,67 @@ + + + +windows::basic_overlapped_handle::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign an overlapped handle from another. +

+
basic_overlapped_handle & operator=(
+    basic_overlapped_handle && other);
+
+

+ This assignment operator moves a handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other overlapped handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the overlapped_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_/overload2.html new file mode 100644 index 0000000..f420548 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/operator_eq_/overload2.html @@ -0,0 +1,69 @@ + + + +windows::basic_overlapped_handle::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign an overlapped handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_overlapped_handle & > operator=(
+    basic_overlapped_handle< Executor1 > && other);
+
+

+ This assignment operator moves a handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other overlapped handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the overlapped_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release.html new file mode 100644 index 0000000..782c8a4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release.html @@ -0,0 +1,47 @@ + + + +windows::basic_overlapped_handle::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native handle. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release/overload1.html new file mode 100644 index 0000000..7182270 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release/overload1.html @@ -0,0 +1,69 @@ + + + +windows::basic_overlapped_handle::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native handle. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous operations to finish + immediately, and the handlers for cancelled operations will be passed + the asio::error::operation_aborted error. Ownership + of the native handle is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release/overload2.html new file mode 100644 index 0000000..0cbe274 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle/release/overload2.html @@ -0,0 +1,70 @@ + + + +windows::basic_overlapped_handle::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Release ownership of the underlying native handle. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous operations to finish + immediately, and the handlers for cancelled operations will be passed + the asio::error::operation_aborted error. Ownership + of the native handle is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle__rebind_executor.html new file mode 100644 index 0000000..6041da8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle__rebind_executor.html @@ -0,0 +1,89 @@ + + + +windows::basic_overlapped_handle::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the handle type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The handle type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/windows/basic_overlapped_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle__rebind_executor/other.html new file mode 100644 index 0000000..5a3c504 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_overlapped_handle__rebind_executor/other.html @@ -0,0 +1,327 @@ + + + +windows::basic_overlapped_handle::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + handle type when rebound to the specified executor. +

+
typedef basic_overlapped_handle< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ basic_overlapped_handle [constructor] +

+ 		+

+ Construct an overlapped handle without opening it.
—
+ Construct an overlapped handle on an existing native handle. +
—
Move-construct an overlapped handle from another. +
—
Move-construct an overlapped handle from a handle + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an overlapped handle from another.
—
+ Move-assign an overlapped handle from a handle of another executor + type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_overlapped_handle [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The windows::overlapped_handle class provides + the ability to wrap a Windows handle. The underlying object referred to + by the handle must support overlapped I/O. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_overlapped_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle.html new file mode 100644 index 0000000..1ac08ab --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle.html @@ -0,0 +1,343 @@ + + + +windows::basic_random_access_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides random-access handle functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_random_access_handle :
+  public windows::basic_overlapped_handle< any_io_executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_read_some_at +

+ 		+

+ Start an asynchronous read at the specified offset. +

+
+

+ async_write_some_at +

+ 		+

+ Start an asynchronous write at the specified offset. +

+
+

+ basic_random_access_handle [constructor] +

+ 		+

+ Construct a random-access handle without opening it.
—
+ Construct a random-access handle on an existing native handle. +
—
Move-construct a random-access handle from another. +
—
Move-construct a random-access handle from a handle + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a random-access handle from another.
—
+ Move-assign a random-access handle from a handle of another executor + type. +

+
+

+ read_some_at +

+ 		+

+ Read some data from the handle at the specified offset. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+

+ write_some_at +

+ 		+

+ Write some data to the handle at the specified offset. +

+
+

+ The windows::basic_random_access_handle class + provides asynchronous and blocking random-access handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_random_access_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign.html new file mode 100644 index 0000000..56c21d8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign.html @@ -0,0 +1,49 @@ + + + +windows::basic_random_access_handle::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+  » more...
+
+void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign/overload1.html new file mode 100644 index 0000000..d94ff37 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign/overload1.html @@ -0,0 +1,45 @@ + + + +windows::basic_random_access_handle::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign/overload2.html new file mode 100644 index 0000000..01af1ec --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/assign/overload2.html @@ -0,0 +1,46 @@ + + + +windows::basic_random_access_handle::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/async_read_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/async_read_some_at.html new file mode 100644 index 0000000..c8133cc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/async_read_some_at.html @@ -0,0 +1,148 @@ + + + +windows::basic_random_access_handle::async_read_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read at the specified offset. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the random-access + handle. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be read. +

+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read_at + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
handle.async_read_some_at(42, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/async_write_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/async_write_some_at.html new file mode 100644 index 0000000..503135e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/async_write_some_at.html @@ -0,0 +1,148 @@ + + + +windows::basic_random_access_handle::async_write_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write at the specified offset. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the random-access + handle. It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more data buffers to be written to the handle. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not transmit all of the data to the peer. Consider + using the async_write_at + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
handle.async_write_some_at(42, asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle.html new file mode 100644 index 0000000..ce5a4d4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle.html @@ -0,0 +1,85 @@ + + + +windows::basic_random_access_handle::basic_random_access_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a random-access handle without opening it. +

+
explicit basic_random_access_handle(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_random_access_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a random-access handle on an existing native handle. +

+
basic_random_access_handle(
+    const executor_type & ex,
+    const native_handle_type & handle);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_random_access_handle(
+    ExecutionContext & context,
+    const native_handle_type & handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a random-access handle from another. +

+
basic_random_access_handle(
+    basic_random_access_handle && other);
+  » more...
+
+

+ Move-construct a random-access handle from a handle of another executor + type. +

+
template<
+    typename Executor1>
+basic_random_access_handle(
+    basic_random_access_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload1.html new file mode 100644 index 0000000..26995ff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload1.html @@ -0,0 +1,60 @@ + + + +windows::basic_random_access_handle::basic_random_access_handle (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a random-access handle without opening it. +

+
basic_random_access_handle(
+    const executor_type & ex);
+
+

+ This constructor creates a random-access handle without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the random-access handle will use, by default, + to dispatch handlers for any asynchronous operations performed + on the random-access handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload2.html new file mode 100644 index 0000000..eeb5f4a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload2.html @@ -0,0 +1,65 @@ + + + +windows::basic_random_access_handle::basic_random_access_handle (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a random-access handle without opening it. +

+
template<
+    typename ExecutionContext>
+basic_random_access_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a random-access handle without opening it. The + handle needs to be opened or assigned before data can be written to or + read from it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the random-access + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the random-access handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload3.html new file mode 100644 index 0000000..78fafbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload3.html @@ -0,0 +1,79 @@ + + + +windows::basic_random_access_handle::basic_random_access_handle (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a random-access handle on an existing native handle. +

+
basic_random_access_handle(
+    const executor_type & ex,
+    const native_handle_type & handle);
+
+

+ This constructor creates a random-access handle object to hold an existing + native handle. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the random-access handle will use, by default, + to dispatch handlers for any asynchronous operations performed + on the random-access handle. +

+
handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload4.html new file mode 100644 index 0000000..11bc762 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload4.html @@ -0,0 +1,82 @@ + + + +windows::basic_random_access_handle::basic_random_access_handle (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a random-access handle on an existing native handle. +

+
template<
+    typename ExecutionContext>
+basic_random_access_handle(
+    ExecutionContext & context,
+    const native_handle_type & handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a random-access handle object to hold an existing + native handle. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the random-access + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the random-access handle. +

+
handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload5.html new file mode 100644 index 0000000..c8d1b68 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload5.html @@ -0,0 +1,68 @@ + + + +windows::basic_random_access_handle::basic_random_access_handle (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a random-access handle from another. +

+
basic_random_access_handle(
+    basic_random_access_handle && other);
+
+

+ This constructor moves a random-access handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other random-access handle object from which the move will + occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload6.html new file mode 100644 index 0000000..0c56fee --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/basic_random_access_handle/overload6.html @@ -0,0 +1,72 @@ + + + +windows::basic_random_access_handle::basic_random_access_handle (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a random-access handle from a handle of another executor + type. +

+
template<
+    typename Executor1>
+basic_random_access_handle(
+    basic_random_access_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a random-access handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other random-access handle object from which the move will + occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel.html new file mode 100644 index 0000000..0fdc7fc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel.html @@ -0,0 +1,47 @@ + + + +windows::basic_random_access_handle::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the handle. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel/overload1.html new file mode 100644 index 0000000..5c9e3d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel/overload1.html @@ -0,0 +1,62 @@ + + + +windows::basic_random_access_handle::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel/overload2.html new file mode 100644 index 0000000..a891549 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/cancel/overload2.html @@ -0,0 +1,63 @@ + + + +windows::basic_random_access_handle::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close.html new file mode 100644 index 0000000..73b1062 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close.html @@ -0,0 +1,47 @@ + + + +windows::basic_random_access_handle::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the handle. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close/overload1.html new file mode 100644 index 0000000..2b848e8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close/overload1.html @@ -0,0 +1,62 @@ + + + +windows::basic_random_access_handle::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Close the handle. +

+
void close();
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close/overload2.html new file mode 100644 index 0000000..817e3ce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/close/overload2.html @@ -0,0 +1,63 @@ + + + +windows::basic_random_access_handle::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Close the handle. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/executor_type.html new file mode 100644 index 0000000..0027845 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/executor_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_random_access_handle::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_random_access_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/get_executor.html new file mode 100644 index 0000000..d44e8e6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/get_executor.html @@ -0,0 +1,45 @@ + + + +windows::basic_random_access_handle::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/is_open.html new file mode 100644 index 0000000..6fee5fe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/is_open.html @@ -0,0 +1,45 @@ + + + +windows::basic_random_access_handle::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +Determine + whether the handle is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer.html new file mode 100644 index 0000000..821ea57 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer.html @@ -0,0 +1,49 @@ + + + +windows::basic_random_access_handle::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer/overload1.html new file mode 100644 index 0000000..a4db4f6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer/overload1.html @@ -0,0 +1,58 @@ + + + +windows::basic_random_access_handle::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ 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 an overlapped_handle cannot contain any further layers, it simply + returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer/overload2.html new file mode 100644 index 0000000..09eae6f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer/overload2.html @@ -0,0 +1,58 @@ + + + +windows::basic_random_access_handle::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since an overlapped_handle cannot contain any further layers, + it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer_type.html new file mode 100644 index 0000000..7d7d9ef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/lowest_layer_type.html @@ -0,0 +1,330 @@ + + + +windows::basic_random_access_handle::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +An + overlapped_handle is always the lowest layer. +

+
typedef basic_overlapped_handle lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ basic_overlapped_handle [constructor] +

+ 		+

+ Construct an overlapped handle without opening it.
—
+ Construct an overlapped handle on an existing native handle. +
—
Move-construct an overlapped handle from another. +
—
Move-construct an overlapped handle from a handle + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an overlapped handle from another.
—
+ Move-assign an overlapped handle from a handle of another executor + type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_overlapped_handle [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The windows::overlapped_handle class provides + the ability to wrap a Windows handle. The underlying object referred to + by the handle must support overlapped I/O. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_random_access_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/native_handle.html new file mode 100644 index 0000000..25e0036 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/native_handle.html @@ -0,0 +1,50 @@ + + + +windows::basic_random_access_handle::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +Get + the native handle representation. +

+
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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/native_handle_type.html new file mode 100644 index 0000000..7388802 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/native_handle_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_random_access_handle::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a handle. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_random_access_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_.html new file mode 100644 index 0000000..fda3f20 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_.html @@ -0,0 +1,53 @@ + + + +windows::basic_random_access_handle::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a random-access handle from another. +

+
basic_random_access_handle & operator=(
+    basic_random_access_handle && other);
+  » more...
+
+

+ Move-assign a random-access handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_random_access_handle & > operator=(
+    basic_random_access_handle< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_/overload1.html new file mode 100644 index 0000000..0e94a0a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_/overload1.html @@ -0,0 +1,69 @@ + + + +windows::basic_random_access_handle::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a random-access handle from another. +

+
basic_random_access_handle & operator=(
+    basic_random_access_handle && other);
+
+

+ This assignment operator moves a random-access handle from one object + to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other random-access handle object from which the move will + occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_/overload2.html new file mode 100644 index 0000000..d840c30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/operator_eq_/overload2.html @@ -0,0 +1,72 @@ + + + +windows::basic_random_access_handle::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a random-access handle from a handle of another executor + type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_random_access_handle & > operator=(
+    basic_random_access_handle< Executor1 > && other);
+
+

+ This assignment operator moves a random-access handle from one object + to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other random-access handle object from which the move will + occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_random_access_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at.html new file mode 100644 index 0000000..94abc10 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at.html @@ -0,0 +1,55 @@ + + + +windows::basic_random_access_handle::read_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the handle at the specified offset. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at/overload1.html new file mode 100644 index 0000000..9d880f8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at/overload1.html @@ -0,0 +1,113 @@ + + + +windows::basic_random_access_handle::read_some_at (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the handle at the specified offset. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to read data from the random-access handle. The + function call will block until one or more bytes of data has been read + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be read. +

+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read_at function if you need + to ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
handle.read_some_at(42, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at/overload2.html new file mode 100644 index 0000000..46cdfbe --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/read_some_at/overload2.html @@ -0,0 +1,90 @@ + + + +windows::basic_random_access_handle::read_some_at (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the handle at the specified offset. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some_at(
+    uint64_t offset,
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to read data from the random-access handle. The + function call will block until one or more bytes of data has been read + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be read. +

+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read_at function if you need + to ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release.html new file mode 100644 index 0000000..bad6c92 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release.html @@ -0,0 +1,47 @@ + + + +windows::basic_random_access_handle::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native handle. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release/overload1.html new file mode 100644 index 0000000..9c5a164 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release/overload1.html @@ -0,0 +1,72 @@ + + + +windows::basic_random_access_handle::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Release ownership of the underlying native handle. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous operations to finish + immediately, and the handlers for cancelled operations will be passed + the asio::error::operation_aborted error. Ownership + of the native handle is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release/overload2.html new file mode 100644 index 0000000..4f959d6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/release/overload2.html @@ -0,0 +1,73 @@ + + + +windows::basic_random_access_handle::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Release ownership of the underlying native handle. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous operations to finish + immediately, and the handlers for cancelled operations will be passed + the asio::error::operation_aborted error. Ownership + of the native handle is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at.html new file mode 100644 index 0000000..e9ab157 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at.html @@ -0,0 +1,55 @@ + + + +windows::basic_random_access_handle::write_some_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the handle at the specified offset. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at/overload1.html new file mode 100644 index 0000000..da6b953 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at/overload1.html @@ -0,0 +1,113 @@ + + + +windows::basic_random_access_handle::write_some_at (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the handle at the specified offset. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write data to the random-access handle. The + function call will block until one or more bytes of the data has been + written successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more data buffers to be written to the handle. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The write_some_at operation may not write all of the data. Consider using + the write_at + function if you need to ensure that all data is written before the blocking + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
handle.write_some_at(42, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at/overload2.html new file mode 100644 index 0000000..8f149d2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle/write_some_at/overload2.html @@ -0,0 +1,89 @@ + + + +windows::basic_random_access_handle::write_some_at (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the handle at the specified offset. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some_at(
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write data to the random-access handle. The + function call will block until one or more bytes of the data has been + written successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more data buffers to be written to the handle. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write_at function if you need + to ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle__rebind_executor.html new file mode 100644 index 0000000..689ccc3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle__rebind_executor.html @@ -0,0 +1,89 @@ + + + +windows::basic_random_access_handle::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the handle type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The handle type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/windows/basic_random_access_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle__rebind_executor/other.html new file mode 100644 index 0000000..0bdf081 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_random_access_handle__rebind_executor/other.html @@ -0,0 +1,339 @@ + + + +windows::basic_random_access_handle::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + handle type when rebound to the specified executor. +

+
typedef basic_random_access_handle< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_read_some_at +

+ 		+

+ Start an asynchronous read at the specified offset. +

+
+

+ async_write_some_at +

+ 		+

+ Start an asynchronous write at the specified offset. +

+
+

+ basic_random_access_handle [constructor] +

+ 		+

+ Construct a random-access handle without opening it.
— +
Construct a random-access handle on an existing native + handle.
—
Move-construct a random-access handle from + another.
—
Move-construct a random-access handle + from a handle of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a random-access handle from another.
—
+ Move-assign a random-access handle from a handle of another executor + type. +

+
+

+ read_some_at +

+ 		+

+ Read some data from the handle at the specified offset. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+

+ write_some_at +

+ 		+

+ Write some data to the handle at the specified offset. +

+
+

+ The windows::basic_random_access_handle class + provides asynchronous and blocking random-access handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_random_access_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle.html new file mode 100644 index 0000000..afcdba2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle.html @@ -0,0 +1,341 @@ + + + +windows::basic_stream_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Provides stream-oriented handle functionality. +

+
template<
+    typename Executor = any_io_executor>
+class basic_stream_handle :
+  public windows::basic_overlapped_handle< any_io_executor >
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_handle [constructor] +

+ 		+

+ Construct a stream handle without opening it.
—
Construct + a stream handle on an existing native handle.
—
Move-construct + a stream handle from another.
—
Move-construct a stream + handle from a handle of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a stream handle from another.
—
Move-assign + a stream handle from a handle of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the handle. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+

+ write_some +

+ 		+

+ Write some data to the handle. +

+
+

+ The windows::basic_stream_handle class provides + asynchronous and blocking stream-oriented handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_stream_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign.html new file mode 100644 index 0000000..6c76cdb --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign.html @@ -0,0 +1,49 @@ + + + +windows::basic_stream_handle::assign + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Assign + an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+  » more...
+
+void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign/overload1.html new file mode 100644 index 0000000..cf5eb02 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign/overload1.html @@ -0,0 +1,45 @@ + + + +windows::basic_stream_handle::assign (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign/overload2.html new file mode 100644 index 0000000..54f8e33 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/assign/overload2.html @@ -0,0 +1,46 @@ + + + +windows::basic_stream_handle::assign (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Assign an existing native handle to the handle. +

+
void assign(
+    const native_handle_type & handle,
+    asio::error_code & ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/async_read_some.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/async_read_some.html new file mode 100644 index 0000000..6281865 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/async_read_some.html @@ -0,0 +1,143 @@ + + + +windows::basic_stream_handle::async_read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous read. +

+
template<
+    typename MutableBufferSequence,
+    typename ReadToken = default_completion_token_t<executor_type>>
+DEDUCED async_read_some(
+    const MutableBufferSequence & buffers,
+    ReadToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously read data from the stream handle. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the read completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The read operation may not read all of the requested number of bytes. Consider + using the async_read + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
handle.async_read_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/async_write_some.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/async_write_some.html new file mode 100644 index 0000000..70b149f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/async_write_some.html @@ -0,0 +1,143 @@ + + + +windows::basic_stream_handle::async_write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Start + an asynchronous write. +

+
template<
+    typename ConstBufferSequence,
+    typename WriteToken = default_completion_token_t<executor_type>>
+DEDUCED async_write_some(
+    const ConstBufferSequence & buffers,
+    WriteToken && token = default_completion_token_t< executor_type >());
+
+

+ This function is used to asynchronously write data to the stream handle. + It is an initiating function for an asynchronous + operation, and always returns immediately. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the handle. 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 completion handler is called. +

+
token
+
+

+ The completion + token that will be used to produce a completion handler, which + will be called when the write completes. Potential completion tokens + include use_future, + use_awaitable, + yield_context, + or a function object with the correct completion signature. The function + signature of the completion handler must be: +

+
void handler(
+  const asio::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 completion handler will not be invoked from within this + function. On immediate completion, invocation of the handler will + be performed in a manner equivalent to using async_immediate. +

+
+
+
+
+ + Completion + Signature +
+
void(asio::error_code, std::size_t)
+
+
+ + Remarks +
+

+ The write operation may not transmit all of the data to the peer. Consider + using the async_write + function if you need to ensure that all data is written before the asynchronous + operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
handle.async_write_some(asio::buffer(data, size), handler);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Per-Operation + Cancellation +
+

+ This asynchronous operation supports cancellation for the following cancellation_type + values: +

+
    +
  • + cancellation_type::terminal +
    • +
  • + cancellation_type::partial +
    • +
  • + cancellation_type::total +
    • +
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle.html new file mode 100644 index 0000000..b712c5c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle.html @@ -0,0 +1,84 @@ + + + +windows::basic_stream_handle::basic_stream_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + a stream handle without opening it. +

+
explicit basic_stream_handle(
+    const executor_type & ex);
+  » more...
+
+template<
+    typename ExecutionContext>
+explicit basic_stream_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+

+ Construct a stream handle on an existing native handle. +

+
basic_stream_handle(
+    const executor_type & ex,
+    const native_handle_type & handle);
+  » more...
+
+template<
+    typename ExecutionContext>
+basic_stream_handle(
+    ExecutionContext & context,
+    const native_handle_type & handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+

+ Move-construct a stream handle from another. +

+
basic_stream_handle(
+    basic_stream_handle && other);
+  » more...
+
+

+ Move-construct a stream handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+basic_stream_handle(
+    basic_stream_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload1.html new file mode 100644 index 0000000..2f0fdef --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload1.html @@ -0,0 +1,60 @@ + + + +windows::basic_stream_handle::basic_stream_handle (1 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream handle without opening it. +

+
basic_stream_handle(
+    const executor_type & ex);
+
+

+ This constructor creates a stream handle without opening it. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the stream handle will use, by default, to + dispatch handlers for any asynchronous operations performed on + the stream handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload2.html new file mode 100644 index 0000000..c248286 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload2.html @@ -0,0 +1,65 @@ + + + +windows::basic_stream_handle::basic_stream_handle (2 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream handle without opening it. +

+
template<
+    typename ExecutionContext>
+basic_stream_handle(
+    ExecutionContext & context,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor creates a stream handle without opening it. The handle + needs to be opened or assigned before data can be written to or read + from it. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the stream + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the stream handle. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload3.html new file mode 100644 index 0000000..523987f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload3.html @@ -0,0 +1,79 @@ + + + +windows::basic_stream_handle::basic_stream_handle (3 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream handle on an existing native handle. +

+
basic_stream_handle(
+    const executor_type & ex,
+    const native_handle_type & handle);
+
+

+ This constructor creates a stream handle object to hold an existing native + handle. +

+
+ + Parameters +
+
+

+
+
ex
+

+ The I/O executor that the stream handle will use, by default, to + dispatch handlers for any asynchronous operations performed on + the stream handle. +

+
handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload4.html new file mode 100644 index 0000000..84b1558 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload4.html @@ -0,0 +1,82 @@ + + + +windows::basic_stream_handle::basic_stream_handle (4 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct a stream handle on an existing native handle. +

+
template<
+    typename ExecutionContext>
+basic_stream_handle(
+    ExecutionContext & context,
+    const native_handle_type & handle,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+

+ This constructor creates a stream handle object to hold an existing native + handle. +

+
+ + Parameters +
+
+

+
+
context
+

+ An execution context which provides the I/O executor that the stream + handle will use, by default, to dispatch handlers for any asynchronous + operations performed on the stream handle. +

+
handle
+

+ The new underlying handle implementation. +

+
+
+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload5.html new file mode 100644 index 0000000..de854a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload5.html @@ -0,0 +1,67 @@ + + + +windows::basic_stream_handle::basic_stream_handle (5 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a stream handle from another. +

+
basic_stream_handle(
+    basic_stream_handle && other);
+
+

+ This constructor moves a stream handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other stream handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload6.html new file mode 100644 index 0000000..79a03b6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/basic_stream_handle/overload6.html @@ -0,0 +1,70 @@ + + + +windows::basic_stream_handle::basic_stream_handle (6 of 6 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-construct a stream handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+basic_stream_handle(
+    basic_stream_handle< Executor1 > && other,
+    constraint_t< is_convertible< Executor1, Executor >::value, defaulted_constraint >  = defaulted_constraint());
+
+

+ This constructor moves a stream handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other stream handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel.html new file mode 100644 index 0000000..dd12e9b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel.html @@ -0,0 +1,47 @@ + + + +windows::basic_stream_handle::cancel + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Cancel + all asynchronous operations associated with the handle. +

+
void cancel();
+  » more...
+
+void cancel(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel/overload1.html new file mode 100644 index 0000000..6fe9276 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel/overload1.html @@ -0,0 +1,62 @@ + + + +windows::basic_stream_handle::cancel (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel/overload2.html new file mode 100644 index 0000000..9afbd25 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/cancel/overload2.html @@ -0,0 +1,63 @@ + + + +windows::basic_stream_handle::cancel (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Cancel all asynchronous operations associated with the handle. +

+
void cancel(
+    asio::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 asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close.html new file mode 100644 index 0000000..482d2fd --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close.html @@ -0,0 +1,47 @@ + + + +windows::basic_stream_handle::close + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Close + the handle. +

+
void close();
+  » more...
+
+void close(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close/overload1.html new file mode 100644 index 0000000..f46ca70 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close/overload1.html @@ -0,0 +1,62 @@ + + + +windows::basic_stream_handle::close (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Close the handle. +

+
void close();
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close/overload2.html new file mode 100644 index 0000000..196b49b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/close/overload2.html @@ -0,0 +1,63 @@ + + + +windows::basic_stream_handle::close (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Close the handle. +

+
void close(
+    asio::error_code & ec);
+
+

+ This function is used to close the handle. Any asynchronous read or write + operations will be cancelled immediately, and will complete with the + asio::error::operation_aborted error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/executor_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/executor_type.html new file mode 100644 index 0000000..c2ff58a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/executor_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_stream_handle::executor_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + type of the executor associated with the object. +

+
typedef Executor executor_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_stream_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/get_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/get_executor.html new file mode 100644 index 0000000..d51bee5 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/get_executor.html @@ -0,0 +1,45 @@ + + + +windows::basic_stream_handle::get_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +Get + the executor associated with the object. +

+
const executor_type & get_executor();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/is_open.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/is_open.html new file mode 100644 index 0000000..eb18577 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/is_open.html @@ -0,0 +1,45 @@ + + + +windows::basic_stream_handle::is_open + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +Determine + whether the handle is open. +

+
bool is_open() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer.html new file mode 100644 index 0000000..e689099 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer.html @@ -0,0 +1,49 @@ + + + +windows::basic_stream_handle::lowest_layer + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + a reference to the lowest layer. +

+
lowest_layer_type & lowest_layer();
+  » more...
+
+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer/overload1.html new file mode 100644 index 0000000..8395fce --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer/overload1.html @@ -0,0 +1,58 @@ + + + +windows::basic_stream_handle::lowest_layer (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ 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 an overlapped_handle cannot contain any further layers, it simply + returns a reference to itself. +

+
+ + Return + Value +
+

+ A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer/overload2.html new file mode 100644 index 0000000..0b01f16 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer/overload2.html @@ -0,0 +1,58 @@ + + + +windows::basic_stream_handle::lowest_layer (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Get a const reference to the lowest layer. +

+
const lowest_layer_type & lowest_layer() const;
+
+

+ This function returns a const reference to the lowest layer in a stack + of layers. Since an overlapped_handle cannot contain any further layers, + it simply returns a reference to itself. +

+
+ + Return + Value +
+

+ A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer_type.html new file mode 100644 index 0000000..39cc00e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/lowest_layer_type.html @@ -0,0 +1,330 @@ + + + +windows::basic_stream_handle::lowest_layer_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +An + overlapped_handle is always the lowest layer. +

+
typedef basic_overlapped_handle lowest_layer_type;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ basic_overlapped_handle [constructor] +

+ 		+

+ Construct an overlapped handle without opening it.
—
+ Construct an overlapped handle on an existing native handle. +
—
Move-construct an overlapped handle from another. +
—
Move-construct an overlapped handle from a handle + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an overlapped handle from another.
—
+ Move-assign an overlapped handle from a handle of another executor + type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_overlapped_handle [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The windows::overlapped_handle class provides + the ability to wrap a Windows handle. The underlying object referred to + by the handle must support overlapped I/O. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_stream_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/native_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/native_handle.html new file mode 100644 index 0000000..e537b86 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/native_handle.html @@ -0,0 +1,50 @@ + + + +windows::basic_stream_handle::native_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ +Get + the native handle representation. +

+
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. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/native_handle_type.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/native_handle_type.html new file mode 100644 index 0000000..33de9ad --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/native_handle_type.html @@ -0,0 +1,52 @@ + + + +windows::basic_stream_handle::native_handle_type + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + native representation of a handle. +

+
typedef implementation_defined native_handle_type;
+
+
+ + Requirements +
+

+ Header: asio/windows/basic_stream_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_.html new file mode 100644 index 0000000..62be93f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_.html @@ -0,0 +1,53 @@ + + + +windows::basic_stream_handle::operator= + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Move-assign + a stream handle from another. +

+
basic_stream_handle & operator=(
+    basic_stream_handle && other);
+  » more...
+
+

+ Move-assign a stream handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_stream_handle & > operator=(
+    basic_stream_handle< Executor1 > && other);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_/overload1.html new file mode 100644 index 0000000..f74fa29 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_/overload1.html @@ -0,0 +1,67 @@ + + + +windows::basic_stream_handle::operator= (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a stream handle from another. +

+
basic_stream_handle & operator=(
+    basic_stream_handle && other);
+
+

+ This assignment operator moves a stream handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other stream handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_/overload2.html new file mode 100644 index 0000000..b951303 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/operator_eq_/overload2.html @@ -0,0 +1,69 @@ + + + +windows::basic_stream_handle::operator= (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Move-assign a stream handle from a handle of another executor type. +

+
template<
+    typename Executor1>
+constraint_t< is_convertible< Executor1, Executor >::value, basic_stream_handle & > operator=(
+    basic_stream_handle< Executor1 > && other);
+
+

+ This assignment operator moves a stream handle from one object to another. +

+
+ + Parameters +
+
+

+
+
other
+

+ The other stream handle object from which the move will occur. +

+
+
+
+ + Remarks +
+

+ Following the move, the moved-from object is in the same state as if + constructed using the basic_stream_handle(const executor_type&) + constructor. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some.html new file mode 100644 index 0000000..7ae9c4c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some.html @@ -0,0 +1,53 @@ + + + +windows::basic_stream_handle::read_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Read + some data from the handle. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+  » more...
+
+template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some/overload1.html new file mode 100644 index 0000000..5167351 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some/overload1.html @@ -0,0 +1,108 @@ + + + +windows::basic_stream_handle::read_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the handle. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers);
+
+

+ This function is used to read data from the stream handle. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+ + Example +
+

+ To read into a single data buffer use the buffer function as follows: +

+
handle.read_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some/overload2.html new file mode 100644 index 0000000..d8799c4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/read_some/overload2.html @@ -0,0 +1,85 @@ + + + +windows::basic_stream_handle::read_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Read some data from the handle. +

+
template<
+    typename MutableBufferSequence>
+std::size_t read_some(
+    const MutableBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to read data from the stream handle. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more buffers into which the data will be read. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes read. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The read_some operation may not read all of the requested number of bytes. + Consider using the read function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release.html new file mode 100644 index 0000000..0ab2bf0 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release.html @@ -0,0 +1,47 @@ + + + +windows::basic_stream_handle::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the underlying native handle. +

+
native_handle_type release();
+  » more...
+
+native_handle_type release(
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release/overload1.html new file mode 100644 index 0000000..3ed1d53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release/overload1.html @@ -0,0 +1,72 @@ + + + +windows::basic_stream_handle::release (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Release ownership of the underlying native handle. +

+
native_handle_type release();
+
+

+ This function causes all outstanding asynchronous operations to finish + immediately, and the handlers for cancelled operations will be passed + the asio::error::operation_aborted error. Ownership + of the native handle is then transferred to the caller. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release/overload2.html new file mode 100644 index 0000000..5f5708b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/release/overload2.html @@ -0,0 +1,73 @@ + + + +windows::basic_stream_handle::release (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from windows::basic_overlapped_handle. +

+

+ Release ownership of the underlying native handle. +

+
native_handle_type release(
+    asio::error_code & ec);
+
+

+ This function causes all outstanding asynchronous operations to finish + immediately, and the handlers for cancelled operations will be passed + the asio::error::operation_aborted error. Ownership + of the native handle is then transferred to the caller. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ This function is unsupported on Windows versions prior to Windows 8.1, + and will fail with asio::error::operation_not_supported + on these platforms. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some.html new file mode 100644 index 0000000..c18ba08 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some.html @@ -0,0 +1,53 @@ + + + +windows::basic_stream_handle::write_some + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Write + some data to the handle. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some/overload1.html new file mode 100644 index 0000000..629df22 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some/overload1.html @@ -0,0 +1,107 @@ + + + +windows::basic_stream_handle::write_some (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the handle. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write data to the stream handle. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the handle. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. An error code of asio::error::eof + indicates that the connection was closed by the peer. +

+
+
+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
handle.write_some(asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some/overload2.html new file mode 100644 index 0000000..bc1feb4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle/write_some/overload2.html @@ -0,0 +1,84 @@ + + + +windows::basic_stream_handle::write_some (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write some data to the handle. +

+
template<
+    typename ConstBufferSequence>
+std::size_t write_some(
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write data to the stream handle. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. +

+
+ + Parameters +
+
+

+
+
buffers
+

+ One or more data buffers to be written to the handle. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. Returns 0 if an error occurred. +

+
+ + Remarks +
+

+ The write_some operation may not transmit all of the data to the peer. + Consider using the write function if you need to + ensure that all data is written before the blocking operation completes. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle__rebind_executor.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle__rebind_executor.html new file mode 100644 index 0000000..64dc20d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle__rebind_executor.html @@ -0,0 +1,89 @@ + + + +windows::basic_stream_handle::rebind_executor + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Rebinds the handle type to another executor. +

+
template<
+    typename Executor1>
+struct rebind_executor
+
+
+ + Types +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ other +

+ 		+

+ The handle type when rebound to the specified executor. +

+
+
+ + Requirements +
+

+ Header: asio/windows/basic_stream_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle__rebind_executor/other.html b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle__rebind_executor/other.html new file mode 100644 index 0000000..9859bae --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__basic_stream_handle__rebind_executor/other.html @@ -0,0 +1,337 @@ + + + +windows::basic_stream_handle::rebind_executor::other + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +The + handle type when rebound to the specified executor. +

+
typedef basic_stream_handle< Executor1 > other;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_handle [constructor] +

+ 		+

+ Construct a stream handle without opening it.
—
Construct + a stream handle on an existing native handle.
—
Move-construct + a stream handle from another.
—
Move-construct a + stream handle from a handle of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a stream handle from another.
—
Move-assign + a stream handle from a handle of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the handle. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+

+ write_some +

+ 		+

+ Write some data to the handle. +

+
+

+ The windows::basic_stream_handle class provides + asynchronous and blocking stream-oriented handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/basic_stream_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__object_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__object_handle.html new file mode 100644 index 0000000..5a6a9f3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__object_handle.html @@ -0,0 +1,301 @@ + + + +windows::object_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of an object handle. +

+
typedef basic_object_handle object_handle;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An object handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_wait +

+ 		+

+ Start an asynchronous wait on the object handle. +

+
+

+ basic_object_handle [constructor] +

+ 		+

+ Construct an object handle without opening it.
—
Construct + an object handle on an existing native handle.
—
Move-construct + an object handle from another.
—
Move-construct an + object handle from a handle of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an object handle from another.
—
Move-assign + an object handle from a handle of another executor type. +

+
+

+ wait +

+ 		+

+ Perform a blocking wait on the object handle. +

+
+

+ The windows::basic_object_handle class provides + asynchronous and blocking object-oriented handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/object_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_handle.html new file mode 100644 index 0000000..b4224c9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_handle.html @@ -0,0 +1,327 @@ + + + +windows::overlapped_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of an overlapped handle. +

+
typedef basic_overlapped_handle overlapped_handle;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ basic_overlapped_handle [constructor] +

+ 		+

+ Construct an overlapped handle without opening it.
—
+ Construct an overlapped handle on an existing native handle.
+ —
Move-construct an overlapped handle from another.
+ —
Move-construct an overlapped handle from a handle of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign an overlapped handle from another.
—
Move-assign + an overlapped handle from a handle of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+
+ + Protected + Member Functions +
+
++++ + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ ~basic_overlapped_handle [destructor] +

+ 		+

+ Protected destructor to prevent deletion through this type. +

+
+

+ The windows::overlapped_handle class provides + the ability to wrap a Windows handle. The underlying object referred to by + the handle must support overlapped I/O. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/overlapped_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr.html new file mode 100644 index 0000000..518586e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr.html @@ -0,0 +1,168 @@ + + + +windows::overlapped_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Wraps a handler to create an OVERLAPPED object for use with overlapped I/O. +

+
class overlapped_ptr :
+  noncopyable
+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ complete +

+ 		+

+ Post completion notification for overlapped operation. Releases + ownership. +

+
+

+ get +

+ 		+

+ Get the contained OVERLAPPED object. +

+
+

+ overlapped_ptr [constructor] +

+ 		+

+ Construct an empty overlapped_ptr.
—
Construct an overlapped_ptr + to contain the specified handler. +

+
+

+ release +

+ 		+

+ Release ownership of the OVERLAPPED object. +

+
+

+ reset +

+ 		+

+ Reset to empty.
—
Reset to contain the specified handler, + freeing any current OVERLAPPED object. +

+
+

+ ~overlapped_ptr [destructor] +

+ 		+

+ Destructor automatically frees the OVERLAPPED object unless released. +

+
+

+ A special-purpose smart pointer used to wrap an application handler so that + it can be passed as the LPOVERLAPPED argument to overlapped I/O functions. +

+
+ + Thread Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/overlapped_ptr.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/_overlapped_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/_overlapped_ptr.html new file mode 100644 index 0000000..4edb4b8 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/_overlapped_ptr.html @@ -0,0 +1,42 @@ + + + +windows::overlapped_ptr::~overlapped_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Destructor + automatically frees the OVERLAPPED object unless released. +

+
~overlapped_ptr();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/complete.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/complete.html new file mode 100644 index 0000000..dfa5f8d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/complete.html @@ -0,0 +1,44 @@ + + + +windows::overlapped_ptr::complete + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Post + completion notification for overlapped operation. Releases ownership. +

+
void complete(
+    const asio::error_code & ec,
+    std::size_t bytes_transferred);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get.html new file mode 100644 index 0000000..8d28a6c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get.html @@ -0,0 +1,46 @@ + + + +windows::overlapped_ptr::get + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Get + the contained OVERLAPPED object. +

+
OVERLAPPED * get();
+  » more...
+
+const OVERLAPPED * get() const;
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get/overload1.html new file mode 100644 index 0000000..08a3e08 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get/overload1.html @@ -0,0 +1,41 @@ + + + +windows::overlapped_ptr::get (1 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the contained OVERLAPPED object. +

+
OVERLAPPED * get();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get/overload2.html new file mode 100644 index 0000000..e1aa714 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/get/overload2.html @@ -0,0 +1,41 @@ + + + +windows::overlapped_ptr::get (2 of 2 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Get the contained OVERLAPPED object. +

+
const OVERLAPPED * get() const;
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr.html new file mode 100644 index 0000000..46137f4 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr.html @@ -0,0 +1,65 @@ + + + +windows::overlapped_ptr::overlapped_ptr + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Construct + an empty windows::overlapped_ptr. +

+
overlapped_ptr();
+  » more...
+
+

+ Construct an windows::overlapped_ptr to contain the + specified handler. +

+
template<
+    typename ExecutionContext,
+    typename Handler>
+explicit overlapped_ptr(
+    ExecutionContext & context,
+    Handler && handler,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+template<
+    typename Executor,
+    typename Handler>
+explicit overlapped_ptr(
+    const Executor & ex,
+    Handler && handler,
+    constraint_t< execution::is_executor< Executor >::value||is_executor< Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload1.html new file mode 100644 index 0000000..4253b1f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload1.html @@ -0,0 +1,41 @@ + + + +windows::overlapped_ptr::overlapped_ptr (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an empty windows::overlapped_ptr. +

+
overlapped_ptr();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload2.html new file mode 100644 index 0000000..67bead6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload2.html @@ -0,0 +1,48 @@ + + + +windows::overlapped_ptr::overlapped_ptr (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an windows::overlapped_ptr to contain the + specified handler. +

+
template<
+    typename ExecutionContext,
+    typename Handler>
+overlapped_ptr(
+    ExecutionContext & context,
+    Handler && handler,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload3.html new file mode 100644 index 0000000..59fdc05 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/overlapped_ptr/overload3.html @@ -0,0 +1,48 @@ + + + +windows::overlapped_ptr::overlapped_ptr (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Construct an windows::overlapped_ptr to contain the + specified handler. +

+
template<
+    typename Executor,
+    typename Handler>
+overlapped_ptr(
+    const Executor & ex,
+    Handler && handler,
+    constraint_t< execution::is_executor< Executor >::value||is_executor< Executor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/release.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/release.html new file mode 100644 index 0000000..3b45d97 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/release.html @@ -0,0 +1,42 @@ + + + +windows::overlapped_ptr::release + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Release + ownership of the OVERLAPPED object. +

+
OVERLAPPED * release();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset.html new file mode 100644 index 0000000..f84d668 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset.html @@ -0,0 +1,65 @@ + + + +windows::overlapped_ptr::reset + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +Reset + to empty. +

+
void reset();
+  » more...
+
+

+ Reset to contain the specified handler, freeing any current OVERLAPPED + object. +

+
template<
+    typename ExecutionContext,
+    typename Handler>
+void reset(
+    ExecutionContext & context,
+    Handler && handler,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+  » more...
+
+template<
+    typename Executor,
+    typename Handler>
+void reset(
+    const Executor & ex,
+    Handler && handler,
+    constraint_t< execution::is_executor< Executor >::value||is_executor< Executor >::value >  = 0);
+  » more...
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload1.html new file mode 100644 index 0000000..a9da4ac --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload1.html @@ -0,0 +1,41 @@ + + + +windows::overlapped_ptr::reset (1 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Reset to empty. +

+
void reset();
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload2.html new file mode 100644 index 0000000..e3d110e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload2.html @@ -0,0 +1,48 @@ + + + +windows::overlapped_ptr::reset (2 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Reset to contain the specified handler, freeing any current OVERLAPPED + object. +

+
template<
+    typename ExecutionContext,
+    typename Handler>
+void reset(
+    ExecutionContext & context,
+    Handler && handler,
+    constraint_t< is_convertible< ExecutionContext &, execution_context & >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload3.html new file mode 100644 index 0000000..0cb8305 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__overlapped_ptr/reset/overload3.html @@ -0,0 +1,48 @@ + + + +windows::overlapped_ptr::reset (3 of 3 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Reset to contain the specified handler, freeing any current OVERLAPPED + object. +

+
template<
+    typename Executor,
+    typename Handler>
+void reset(
+    const Executor & ex,
+    Handler && handler,
+    constraint_t< execution::is_executor< Executor >::value||is_executor< Executor >::value >  = 0);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__random_access_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__random_access_handle.html new file mode 100644 index 0000000..2392a01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__random_access_handle.html @@ -0,0 +1,340 @@ + + + +windows::random_access_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a random-access handle. +

+
typedef basic_random_access_handle random_access_handle;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_read_some_at +

+ 		+

+ Start an asynchronous read at the specified offset. +

+
+

+ async_write_some_at +

+ 		+

+ Start an asynchronous write at the specified offset. +

+
+

+ basic_random_access_handle [constructor] +

+ 		+

+ Construct a random-access handle without opening it.
—
+ Construct a random-access handle on an existing native handle. +
—
Move-construct a random-access handle from another. +
—
Move-construct a random-access handle from a handle + of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a random-access handle from another.
—
+ Move-assign a random-access handle from a handle of another executor + type. +

+
+

+ read_some_at +

+ 		+

+ Read some data from the handle at the specified offset. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+

+ write_some_at +

+ 		+

+ Write some data to the handle at the specified offset. +

+
+

+ The windows::basic_random_access_handle class + provides asynchronous and blocking random-access handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/random_access_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/windows__stream_handle.html b/Packages/asio-1.36.0/doc/asio/reference/windows__stream_handle.html new file mode 100644 index 0000000..c28be30 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/windows__stream_handle.html @@ -0,0 +1,337 @@ + + + +windows::stream_handle + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a stream-oriented handle. +

+
typedef basic_stream_handle stream_handle;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the handle type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ An overlapped_handle is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a handle. +

+
+
+ + Member Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native handle to the handle. +

+
+

+ async_read_some +

+ 		+

+ Start an asynchronous read. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_stream_handle [constructor] +

+ 		+

+ Construct a stream handle without opening it.
—
Construct + a stream handle on an existing native handle.
—
Move-construct + a stream handle from another.
—
Move-construct a stream + handle from a handle of another executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the handle. +

+
+

+ close +

+ 		+

+ Close the handle. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the handle is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native handle representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a stream handle from another.
—
Move-assign + a stream handle from a handle of another executor type. +

+
+

+ read_some +

+ 		+

+ Read some data from the handle. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native handle. +

+
+

+ write_some +

+ 		+

+ Write some data to the handle. +

+
+

+ The windows::basic_stream_handle class provides + asynchronous and blocking stream-oriented handle functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/windows/stream_handle.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/writable_pipe.html b/Packages/asio-1.36.0/doc/asio/reference/writable_pipe.html new file mode 100644 index 0000000..af60415 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/writable_pipe.html @@ -0,0 +1,327 @@ + + + +writable_pipe + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ Typedef for the typical usage of a writable pipe. +

+
typedef basic_writable_pipe writable_pipe;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ rebind_executor +

+ 		+

+ Rebinds the pipe type to another executor. +

+
+

+ executor_type +

+ 		+

+ The type of the executor associated with the object. +

+
+

+ lowest_layer_type +

+ 		+

+ A basic_writable_pipe is always the lowest layer. +

+
+

+ native_handle_type +

+ 		+

+ The native representation of a pipe. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ assign +

+ 		+

+ Assign an existing native pipe to the pipe. +

+
+

+ async_write_some +

+ 		+

+ Start an asynchronous write. +

+
+

+ basic_writable_pipe [constructor] +

+ 		+

+ Construct a basic_writable_pipe without opening it.
—
+ Construct a basic_writable_pipe on an existing native pipe.
+ —
Move-construct a basic_writable_pipe from another.
+ —
Move-construct a basic_writable_pipe from a pipe of another + executor type. +

+
+

+ cancel +

+ 		+

+ Cancel all asynchronous operations associated with the pipe. +

+
+

+ close +

+ 		+

+ Close the pipe. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the object. +

+
+

+ is_open +

+ 		+

+ Determine whether the pipe is open. +

+
+

+ lowest_layer +

+ 		+

+ Get a reference to the lowest layer.
—
Get a const + reference to the lowest layer. +

+
+

+ native_handle +

+ 		+

+ Get the native pipe representation. +

+
+

+ operator= +

+ 		+

+ Move-assign a basic_writable_pipe from another.
—
Move-assign + a basic_writable_pipe from a pipe of another executor type. +

+
+

+ release +

+ 		+

+ Release ownership of the underlying native pipe. +

+
+

+ write_some +

+ 		+

+ Write some data to the pipe. +

+
+

+ ~basic_writable_pipe [destructor] +

+ 		+

+ Destroys the pipe. +

+
+

+ The basic_writable_pipe + class provides a wrapper over pipe functionality. +

+
+ + Thread + Safety +
+

+ Distinct objects: Safe. +

+

+ Shared objects: Unsafe. +

+
+ + Requirements +
+

+ Header: asio/writable_pipe.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write.html b/Packages/asio-1.36.0/doc/asio/reference/write.html new file mode 100644 index 0000000..35d2f55 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write.html @@ -0,0 +1,252 @@ + + + +write + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+

+write +

+

+ +

+

+ The write function is a composed + operation that writes a certain amount of data to a stream before returning. +

+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0);
+  » more...
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+  » more...
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename Allocator>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename Allocator>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    asio::error_code & ec);
+  » more...
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+  » more...
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/impl/write.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload1.html new file mode 100644 index 0000000..7744940 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload1.html @@ -0,0 +1,129 @@ + + + +write (1 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the stream. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::write(s, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload10.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload10.html new file mode 100644 index 0000000..baefb05 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload10.html @@ -0,0 +1,104 @@ + + + +write (10 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename Allocator>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    asio::error_code & ec);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, b,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload11.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload11.html new file mode 100644 index 0000000..9ff4a6e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload11.html @@ -0,0 +1,124 @@ + + + +write (11 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload12.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload12.html new file mode 100644 index 0000000..4f1ab5d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload12.html @@ -0,0 +1,117 @@ + + + +write (12 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload13.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload13.html new file mode 100644 index 0000000..ba23391 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload13.html @@ -0,0 +1,113 @@ + + + +write (13 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload14.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload14.html new file mode 100644 index 0000000..8772b01 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload14.html @@ -0,0 +1,105 @@ + + + +write (14 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload15.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload15.html new file mode 100644 index 0000000..9744899 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload15.html @@ -0,0 +1,125 @@ + + + +write (15 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload16.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload16.html new file mode 100644 index 0000000..e012600 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload16.html @@ -0,0 +1,118 @@ + + + +write (16 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v2,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v2 buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload2.html new file mode 100644 index 0000000..1ea1e89 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload2.html @@ -0,0 +1,121 @@ + + + +write (2 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the stream. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::write(s, asio::buffer(data, size), ec);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload3.html new file mode 100644 index 0000000..616bc6a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload3.html @@ -0,0 +1,142 @@ + + + +write (3 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the stream. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::write(s, asio::buffer(data, size),
+   asio::transfer_at_least(32));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload4.html new file mode 100644 index 0000000..4e482e1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload4.html @@ -0,0 +1,120 @@ + + + +write (4 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_const_buffer_sequence< ConstBufferSequence >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the stream. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload5.html new file mode 100644 index 0000000..c94e62f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload5.html @@ -0,0 +1,114 @@ + + + +write (5 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload6.html new file mode 100644 index 0000000..272394d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload6.html @@ -0,0 +1,106 @@ + + + +write (6 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload7.html new file mode 100644 index 0000000..5acf73d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload7.html @@ -0,0 +1,126 @@ + + + +write (7 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload8.html new file mode 100644 index 0000000..90daf1d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload8.html @@ -0,0 +1,119 @@ + + + +write (8 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename DynamicBuffer_v1,
+    typename CompletionCondition>
+std::size_t write(
+    SyncWriteStream & s,
+    DynamicBuffer_v1 && buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_dynamic_buffer_v1< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< !is_dynamic_buffer_v2< decay_t< DynamicBuffer_v1 > >::value >  = 0,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied dynamic buffer sequence has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
buffers
+

+ The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write/overload9.html b/Packages/asio-1.36.0/doc/asio/reference/write/overload9.html new file mode 100644 index 0000000..374d39b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write/overload9.html @@ -0,0 +1,112 @@ + + + +write (9 of 16 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data to a stream before returning. +

+
template<
+    typename SyncWriteStream,
+    typename Allocator>
+std::size_t write(
+    SyncWriteStream & s,
+    basic_streambuf< Allocator > & b);
+
+

+ This function is used to write a certain number of bytes of data to a stream. + The call will block until one of the following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the stream's + write_some function. +

+
+ + Parameters +
+
+

+
+
s
+

+ The stream to which the data is to be written. The type must support + the SyncWriteStream concept. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write(
+   s, b,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at.html b/Packages/asio-1.36.0/doc/asio/reference/write_at.html new file mode 100644 index 0000000..8525d53 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at.html @@ -0,0 +1,153 @@ + + + +write_at + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ The write_at function is + a composed operation that writes a certain amount of data at a specified + offset before returning. +

+

+ Write all of the supplied data at the specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers);
+  » more...
+
+template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+  » more...
+
+

+ Write a certain amount of data at a specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+

+ Write all of the supplied data at the specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b);
+  » more...
+
+template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    asio::error_code & ec);
+  » more...
+
+

+ Write a certain amount of data at a specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+  » more...
+
+
+ + Requirements +
+

+ Header: asio/impl/write_at.hpp +

+

+ Convenience header: asio.hpp +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload1.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload1.html new file mode 100644 index 0000000..f8d6856 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload1.html @@ -0,0 +1,135 @@ + + + +write_at (1 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data at the specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the device. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::write_at(d, 42, asio::buffer(data, size));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write_at(
+   d, offset, buffers,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload2.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload2.html new file mode 100644 index 0000000..ca92d31 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload2.html @@ -0,0 +1,128 @@ + + + +write_at (2 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data at the specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    asio::error_code & ec);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the device. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::write_at(d, 42,
+   asio::buffer(data, size), ec);
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write_at(
+   d, offset, buffers,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload3.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload3.html new file mode 100644 index 0000000..d6c5a2f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload3.html @@ -0,0 +1,148 @@ + + + +write_at (3 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data at a specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the device. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some_at operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the device's write_some_at function. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Example +
+

+ To write a single data buffer use the buffer function as follows: +

+
asio::write_at(d, 42, asio::buffer(data, size),
+   asio::transfer_at_least(32));
+
+

+ See the buffer + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload4.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload4.html new file mode 100644 index 0000000..11664c6 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload4.html @@ -0,0 +1,126 @@ + + + +write_at (4 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data at a specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename ConstBufferSequence,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    const ConstBufferSequence & buffers,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied buffers has been written. That is, + the bytes transferred is equal to the sum of the buffer sizes. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
buffers
+

+ One or more buffers containing the data to be written. The sum of + the buffer sizes indicates the maximum number of bytes to write to + the device. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some_at operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the device's write_some_at function. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload5.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload5.html new file mode 100644 index 0000000..d3d0f1b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload5.html @@ -0,0 +1,119 @@ + + + +write_at (5 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data at the specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write_at(
+   d, 42, b,
+   asio::transfer_all());
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload6.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload6.html new file mode 100644 index 0000000..3e9a55d --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload6.html @@ -0,0 +1,111 @@ + + + +write_at (6 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write all of the supplied data at the specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    asio::error_code & ec);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + An error occurred. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Remarks +
+

+ This overload is equivalent to calling: +

+
asio::write_at(
+   d, 42, b,
+   asio::transfer_all(), ec);
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload7.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload7.html new file mode 100644 index 0000000..b4b50e9 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload7.html @@ -0,0 +1,131 @@ + + + +write_at (7 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data at a specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some_at operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the device's write_some_at function. +

+
+
+
+
+ + Return + Value +
+

+ The number of bytes transferred. +

+
+ + Exceptions +
+
+

+
+
asio::system_error
+

+ Thrown on failure. +

+
+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/write_at/overload8.html b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload8.html new file mode 100644 index 0000000..73efbc2 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/write_at/overload8.html @@ -0,0 +1,124 @@ + + + +write_at (8 of 8 overloads) + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Write a certain amount of data at a specified offset before returning. +

+
template<
+    typename SyncRandomAccessWriteDevice,
+    typename Allocator,
+    typename CompletionCondition>
+std::size_t write_at(
+    SyncRandomAccessWriteDevice & d,
+    uint64_t offset,
+    basic_streambuf< Allocator > & b,
+    CompletionCondition completion_condition,
+    asio::error_code & ec,
+    constraint_t< is_completion_condition< CompletionCondition >::value >  = 0);
+
+

+ This function is used to write a certain number of bytes of data to a random + access device at a specified offset. The call will block until one of the + following conditions is true: +

+
    +
  • + All of the data in the supplied basic_streambuf has been written. +
    • +
  • + The completion_condition function object returns 0. +
    • +
+

+ This operation is implemented in terms of zero or more calls to the device's + write_some_at function. +

+
+ + Parameters +
+
+

+
+
d
+

+ The device to which the data is to be written. The type must support + the SyncRandomAccessWriteDevice concept. +

+
offset
+

+ The offset at which the data will be written. +

+
b
+

+ The basic_streambuf object from + which data will be written. +

+
completion_condition
+
+

+ The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +

+
std::size_t completion_condition(
+  // Result of latest write_some_at operation.
+  const asio::error_code& error,
+
+  // Number of bytes transferred so far.
+  std::size_t bytes_transferred
+);
+
+

+ A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the device's write_some_at function. +

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Return + Value +
+

+ The number of bytes written. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/reference/yield_context.html b/Packages/asio-1.36.0/doc/asio/reference/yield_context.html new file mode 100644 index 0000000..287abe1 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/reference/yield_context.html @@ -0,0 +1,244 @@ + + + +yield_context + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ +

+

+ A completion token + object that represents the currently executing coroutine. +

+
typedef basic_yield_context< any_io_executor > yield_context;
+
+
+ + Types +
+
++++ + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ cancellation_slot_type +

+ 		+

+ The cancellation slot type associated with the yield context. +

+
+

+ executor_type +

+ 		+

+ The executor type associated with the yield context. +

+
+
+ + Member + Functions +
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Name +

+ 		+

+ Description +

+
+

+ basic_yield_context [constructor] +

+ 		+

+ Construct a yield context from another yield context type. +

+
+

+ cancelled +

+ 		+

+ Determine whether the current coroutine has been cancelled. +

+
+

+ get_cancellation_slot +

+ 		+

+ Get the cancellation slot associated with the coroutine. +

+
+

+ get_cancellation_state +

+ 		+

+ Get the cancellation state associated with the coroutine. +

+
+

+ get_executor +

+ 		+

+ Get the executor associated with the yield context. +

+
+

+ operator[] +

+ 		+

+ Return a yield context that sets the specified error_code. +

+
+

+ reset_cancellation_state +

+ 		+

+ Reset the cancellation state associated with the coroutine. +

+
+

+ throw_if_cancelled +

+ 		+

+ Determine whether the coroutine throws if trying to suspend when + it has been cancelled.
—
Set whether the coroutine + throws if trying to suspend when it has been cancelled. +

+
+

+ The basic_yield_context + class is a completion token type that is used to represent the currently + executing stackful coroutine. A basic_yield_context object may be + passed as a completion token to an asynchronous operation. For example: +

+
template <typename Executor>
+void my_coroutine(basic_yield_context<Executor> yield)
+{
+  ...
+  std::size_t n = my_socket.async_read_some(buffer, yield);
+  ...
+}
+
+

+ The initiating function (async_read_some in the above example) suspends the + current coroutine. The coroutine is resumed when the asynchronous operation + completes, and the result of the operation is returned. +

+
+ + Requirements +
+

+ Header: asio/spawn.hpp +

+

+ Convenience header: None +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/std_executors.html b/Packages/asio-1.36.0/doc/asio/std_executors.html new file mode 100644 index 0000000..8d22bf3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/std_executors.html @@ -0,0 +1,252 @@ + + + +Proposed Standard Executors + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ Asio provides a complete implementation of the proposed standard executors, + as described in P0443r13, P1348r0, and P1393r0. +

+

+ Just as with executors under the Networking TS model, a standard executor represents + a policy as to how, when, and where a piece of code should be executed. Most + existing code should continue to work with little or no change. +

+

+ + Standard + Executor Implementations in Asio +

+

+ The io_context::executor_type, + thread_pool::executor_type, + system_executor, + and strand + executors meet the requirements for the proposed standard executors. For compatibility, + these classes also meet the requirements for the Networking TS model of executors. +

+

+ + Standard + Executor Use in Asio +

+

+ All I/O objects such as ip::tcp::socket, + asynchronous operations, and utilities including dispatch, post, defer, get_associated_executor, bind_executor, make_work_guard, spawn, co_spawn, async_compose, use_future, etc., can interoperate + with both proposed standard executors, and with Networking TS executors. Asio's + implementation determines at compile time which model a particular executor + meets; the proposed standard executor model is used in preference if both are + detected. +

+

+ Support for the existing Networking TS model of executors can be disabled by + defining ASIO_NO_TS_EXECUTORS. +

+

+ + Polymorphic + I/O Executor +

+

+ The any_io_executor + type alias is the default runtime-polymorphic executor for all I/O objects. + This type alias points to the execution::any_executor<> + template with a set of supportable properties specified for use with I/O. +

+

+ This new name may break existing code that directly uses the old polymorphic + wrapper, executor. + If required for backward compatibility, ASIO_USE_TS_EXECUTOR_AS_DEFAULT + can be defined, which changes the any_io_executor + type alias to instead point to the executor + polymorphic wrapper. +

+

+ + Implementing + a Minimal I/O Executor +

+

+ Standard executor properties make what were previously hard requirements on + an executor (such as work counting, or the ability to distinguish between + post, dispatch, + and defer) into optional facilities. + With this relaxation, the minimal requirements for an I/O executor are: +

+
+

+ The following example shows a minimal I/O executor. Given a queue submission + operation implemented elsewhere: +

+
queue_t queue_create();
+template <typename F> void queue_submit(queue_t q, F f);
+
+

+ the executor may be defined as follows: +

+
struct minimal_io_executor
+{
+  asio::execution_context* context_;
+  queue_t queue_;
+
+  bool operator==(const minimal_io_executor& other) const noexcept
+  {
+    return context_ == other.context_ && queue_ == other.queue_;
+  }
+
+  bool operator!=(const minimal_io_executor& other) const noexcept
+  {
+    return !(*this == other);
+  }
+
+  asio::execution_context& query(
+      asio::execution::context_t) const noexcept
+  {
+    return *context_;
+  }
+
+  static constexpr asio::execution::blocking_t::never_t query(
+      asio::execution::blocking_t) noexcept
+  {
+    // This executor always has blocking.never semantics.
+    return asio::execution::blocking.never;
+  }
+
+  template <class F>
+  void execute(F f) const
+  {
+    queue_submit(queue_, std::move(f));
+  }
+};
+
+

+ This executor may be created as follows: +

+
asio::execution_context context;
+queue_t queue = queue_create();
+minimal_io_executor executor{&context, queue};
+
+

+ and then used with I/O objects: +

+
asio::ip::tcp::acceptor acceptor(executor);
+
+

+ or assigned into the any_io_executor polymorphic wrapper: +

+
asio::any_io_executor poly_executor = executor;
+
+

+ + Traits + for Deducing Conformance to the Executor Concept +

+

+ Older C++ standards and compilers require some assistance to determine whether + an executor implementation conforms to the executor + concept and type requirements. This is achieved through specialisation of traits. + The following code shows a specialisation of these traits for the minimal_io_executor example from above: +

+
namespace asio {
+namespace traits {
+
+#if !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT)
+
+template <typename F>
+struct execute_member<minimal_io_executor, F>
+{
+  static constexpr bool is_valid = true;
+  static constexpr bool is_noexcept = true;
+  typedef void result_type;
+};
+
+#endif // !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT)
+#if !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
+
+template <>
+struct equality_comparable<minimal_io_executor>
+{
+  static constexpr bool is_valid = true;
+  static constexpr bool is_noexcept = true;
+};
+
+#endif // !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
+#if !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT)
+
+template <>
+struct query_member<minimal_io_executor,
+    asio::execution::context_t>
+{
+  static constexpr bool is_valid = true;
+  static constexpr bool is_noexcept = true;
+  typedef asio::execution_context& result_type;
+};
+
+#endif // !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT)
+#if !defined(ASIO_HAS_DEDUCED_QUERY_STATIC_CONSTEXPR_MEMBER_TRAIT)
+
+template <typename Property>
+struct query_static_constexpr_member<minimal_io_executor, Property,
+    typename enable_if<
+      std::is_convertible<Property, asio::execution::blocking_t>::value
+    >::type>
+{
+  static constexpr bool is_valid = true;
+  static constexpr bool is_noexcept = true;
+  typedef asio::execution::blocking_t::never_t result_type;
+  static constexpr result_type value() noexcept { return result_type(); }
+};
+
+#endif // !defined(ASIO_HAS_DEDUCED_QUERY_STATIC_CONSTEXPR_MEMBER_TRAIT)
+
+} // namespace traits
+} // namespace asio
+
+

+ Asio uses an extensive set of traits to implement all of the proposed standard + executor functionality on older C++ standards. These traits may be found under + the asio/traits include directory. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial.html b/Packages/asio-1.36.0/doc/asio/tutorial.html new file mode 100644 index 0000000..ded86ed --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial.html @@ -0,0 +1,118 @@ + + + +Tutorial + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ + Basic + Skills +

+

+ The tutorial programs in this first section introduce the fundamental concepts + required to use the asio toolkit. Before plunging into the complex world of + network programming, these tutorial programs illustrate the basic skills using + simple asynchronous timers. +

+
+

+ + Introduction + to Sockets +

+

+ The tutorial programs in this section show how to use asio to develop simple + client and server programs. These tutorial programs are based around the daytime protocol, which supports + both TCP and UDP. +

+

+ The first three tutorial programs implement the daytime protocol using TCP. +

+
+

+ The next three tutorial programs implement the daytime protocol using UDP. +

+
+

+ The last tutorial program in this section demonstrates how asio allows the + TCP and UDP servers to be easily combined into a single program. +

+
+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/boost_bind.html b/Packages/asio-1.36.0/doc/asio/tutorial/boost_bind.html new file mode 100644 index 0000000..aadecba --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/boost_bind.html @@ -0,0 +1,39 @@ + + + +boost::bind + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ See the Boost: bind.hpp + documentation for more information on how to use boost::bind. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime1.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime1.html new file mode 100644 index 0000000..64b0902 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime1.html @@ -0,0 +1,149 @@ + + + +Daytime.1 - A synchronous TCP daytime client + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial program shows how to use asio to implement a client application + with TCP. +

+

+ We start by including the necessary header files. +

+
#include <array>
+#include <iostream>
+#include <asio.hpp>
+
+

+ The purpose of this application is to access a daytime service, so we need + the user to specify the server. +

+
using asio::ip::tcp;
+
+int main(int argc, char* argv[])
+{
+  try
+  {
+    if (argc != 2)
+    {
+      std::cerr << "Usage: client <host>" << std::endl;
+      return 1;
+    }
+
+

+ All programs that use asio need to have at least one I/O execution context, + such as an io_context object. +

+
    asio::io_context io_context;
+
+

+ We need to turn the server name that was specified as a parameter to the + application, into a TCP endpoint. To do this we use an ip::tcp::resolver + object. +

+
    tcp::resolver resolver(io_context);
+
+

+ A resolver takes a host name and service name and turns them into a list + of endpoints. We perform a resolve call using the name of the server, specified + in argv[1], and the + name of the service, in this case "daytime". +

+

+ The list of endpoints is returned using an object of type ip::tcp::resolver::results_type. + This object is a range, with begin() and end() member functions that may + be used for iterating over the results. +

+
    tcp::resolver::results_type endpoints =
+      resolver.resolve(argv[1], "daytime");
+
+

+ 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. The asio::connect() function does this for us automatically. +

+
    tcp::socket socket(io_context);
+    asio::connect(socket, endpoints);
+
+

+ The connection is open. All we need to do now is read the response from the + daytime service. +

+

+ We use a std::array to hold the received data. The asio::buffer() + function automatically determines the size of the array to help prevent buffer + overruns. Instead of a std::array, + we could have used a char [] + or std::vector. +

+
    for (;;)
+    {
+      std::array<char, 128> buf;
+      std::error_code error;
+
+      size_t len = socket.read_some(asio::buffer(buf), error);
+
+

+ When the server closes the connection, the ip::tcp::socket::read_some() + function will exit with the asio::error::eof error, which is how we know + to exit the loop. +

+
      if (error == asio::error::eof)
+        break; // Connection closed cleanly by peer.
+      else if (error)
+        throw std::system_error(error); // Some other error.
+
+      std::cout.write(buf.data(), len);
+    }
+
+

+ Finally, handle any exceptions that may have been thrown. +

+
  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Next: Daytime.2 - A synchronous + TCP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime1/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime1/src.html new file mode 100644 index 0000000..4a0c744 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime1/src.html @@ -0,0 +1,97 @@ + + + +Source listing for Daytime.1 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// client.cpp
+// ~~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <array>
+#include <iostream>
+#include <asio.hpp>
+
+using asio::ip::tcp;
+
+int main(int argc, char* argv[])
+{
+  try
+  {
+    if (argc != 2)
+    {
+      std::cerr << "Usage: client <host>" << std::endl;
+      return 1;
+    }
+
+    asio::io_context io_context;
+
+    tcp::resolver resolver(io_context);
+    tcp::resolver::results_type endpoints =
+      resolver.resolve(argv[1], "daytime");
+
+    tcp::socket socket(io_context);
+    asio::connect(socket, endpoints);
+
+    for (;;)
+    {
+      std::array<char, 128> buf;
+      std::error_code error;
+
+      size_t len = socket.read_some(asio::buffer(buf), error);
+
+      if (error == asio::error::eof)
+        break; // Connection closed cleanly by peer.
+      else if (error)
+        throw std::system_error(error); // Some other error.
+
+      std::cout.write(buf.data(), len);
+    }
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ Return to Daytime.1 - A synchronous + TCP daytime client +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime2.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime2.html new file mode 100644 index 0000000..1c22377 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime2.html @@ -0,0 +1,117 @@ + + + +Daytime.2 - A synchronous TCP daytime server + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial program shows how to use asio to implement a server application + with TCP. +

+
#include <ctime>
+#include <iostream>
+#include <string>
+#include <asio.hpp>
+
+using asio::ip::tcp;
+
+

+ We define the function make_daytime_string() to create the string to be sent back to + the client. This function will be reused in all of our daytime server applications. +

+
std::string make_daytime_string()
+{
+  using namespace std; // For time_t, time and ctime;
+  time_t now = time(0);
+  return ctime(&now);
+}
+
+int main()
+{
+  try
+  {
+    asio::io_context io_context;
+
+

+ A ip::tcp::acceptor + object needs to be created to listen for new connections. It is initialised + to listen on TCP port 13, for IP version 4. +

+
    tcp::acceptor acceptor(io_context, tcp::endpoint(tcp::v4(), 13));
+
+

+ This is an iterative server, which means that it will handle one connection + at a time. Create a socket that will represent the connection to the client, + and then wait for a connection. +

+
    for (;;)
+    {
+      tcp::socket socket(io_context);
+      acceptor.accept(socket);
+
+

+ A client is accessing our service. Determine the current time and transfer + this information to the client. +

+
      std::string message = make_daytime_string();
+
+      std::error_code ignored_error;
+      asio::write(socket, asio::buffer(message), ignored_error);
+    }
+  }
+
+

+ Finally, handle any exceptions. +

+
  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Daytime.1 - A synchronous + TCP daytime client +

+

+ Next: Daytime.3 - An asynchronous + TCP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime2/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime2/src.html new file mode 100644 index 0000000..3ec0755 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime2/src.html @@ -0,0 +1,90 @@ + + + +Source listing for Daytime.2 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// server.cpp
+// ~~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <ctime>
+#include <iostream>
+#include <string>
+#include <asio.hpp>
+
+using asio::ip::tcp;
+
+std::string make_daytime_string()
+{
+  using namespace std; // For time_t, time and ctime;
+  time_t now = time(0);
+  return ctime(&now);
+}
+
+int main()
+{
+  try
+  {
+    asio::io_context io_context;
+
+    tcp::acceptor acceptor(io_context, tcp::endpoint(tcp::v4(), 13));
+
+    for (;;)
+    {
+      tcp::socket socket(io_context);
+      acceptor.accept(socket);
+
+      std::string message = make_daytime_string();
+
+      std::error_code ignored_error;
+      asio::write(socket, asio::buffer(message), ignored_error);
+    }
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ Return to Daytime.2 - A synchronous + TCP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime3.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime3.html new file mode 100644 index 0000000..b79f83b --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime3.html @@ -0,0 +1,230 @@ + + + +Daytime.3 - An asynchronous TCP daytime server + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + The + main() function +
+
int main()
+{
+  try
+  {
+
+

+ We need to create a server object to accept incoming client connections. + The io_context object provides + I/O services, such as sockets, that the server object will use. +

+
    asio::io_context io_context;
+    tcp_server server(io_context);
+
+

+ Run the io_context object + so that it will perform asynchronous operations on your behalf. +

+
    io_context.run();
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+
+ + The + tcp_server class +
+
class tcp_server
+{
+public:
+
+

+ The constructor initialises an acceptor to listen on TCP port 13. +

+
  tcp_server(asio::io_context& io_context)
+    : io_context_(io_context),
+      acceptor_(io_context, tcp::endpoint(tcp::v4(), 13))
+  {
+    start_accept();
+  }
+
+private:
+
+

+ The function start_accept() creates a socket and initiates an asynchronous + accept operation to wait for a new connection. +

+
  void start_accept()
+  {
+    tcp_connection::pointer new_connection =
+      tcp_connection::create(io_context_);
+
+    acceptor_.async_accept(new_connection->socket(),
+        std::bind(&tcp_server::handle_accept, this, new_connection,
+          asio::placeholders::error));
+  }
+
+

+ The function handle_accept() is called when the asynchronous accept + operation initiated by start_accept() finishes. It services the client request, + and then calls start_accept() to initiate the next accept operation. +

+
  void handle_accept(tcp_connection::pointer new_connection,
+      const std::error_code& error)
+  {
+    if (!error)
+    {
+      new_connection->start();
+    }
+
+    start_accept();
+  }
+
+
+ + The + tcp_connection class +
+

+ We will use shared_ptr and + enable_shared_from_this because + we want to keep the tcp_connection + object alive as long as there is an operation that refers to it. +

+
class tcp_connection
+  : public std::enable_shared_from_this<tcp_connection>
+{
+public:
+  typedef std::shared_ptr<tcp_connection> pointer;
+
+  static pointer create(asio::io_context& io_context)
+  {
+    return pointer(new tcp_connection(io_context));
+  }
+
+  tcp::socket& socket()
+  {
+    return socket_;
+  }
+
+

+ In the function start(), + we call asio::async_write() to serve the data to the client. Note that we + are using asio::async_write(), rather than ip::tcp::socket::async_write_some(), + to ensure that the entire block of data is sent. +

+
  void start()
+  {
+
+

+ The data to be sent is stored in the class member message_ + as we need to keep the data valid until the asynchronous operation is complete. +

+
    message_ = make_daytime_string();
+
+

+ When initiating the asynchronous operation, and if using std::bind, + you must specify only the arguments that match the handler's parameter list. + In this program, both of the argument placeholders (asio::placeholders::error + and asio::placeholders::bytes_transferred) could potentially have been removed, + since they are not being used in handle_write(). +

+
    asio::async_write(socket_, asio::buffer(message_),
+        std::bind(&tcp_connection::handle_write, shared_from_this(),
+          asio::placeholders::error,
+          asio::placeholders::bytes_transferred));
+
+

+ Any further actions for this client connection are now the responsibility + of handle_write(). +

+
  }
+
+private:
+  tcp_connection(asio::io_context& io_context)
+    : socket_(io_context)
+  {
+  }
+
+  void handle_write(const std::error_code& /*error*/,
+      size_t /*bytes_transferred*/)
+  {
+  }
+
+  tcp::socket socket_;
+  std::string message_;
+};
+
+
+ + Removing + unused handler parameters +
+

+ You may have noticed that the error, + and bytes_transferred parameters + are not used in the body of the handle_write() function. If parameters are not needed, + it is possible to remove them from the function so that it looks like: +

+
void handle_write()
+{
+}
+
+

+ The asio::async_write() call used to initiate the call can then be changed + to just: +

+
asio::async_write(socket_, asio::buffer(message_),
+    std::bind(&tcp_connection::handle_write, shared_from_this()));
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Daytime.2 - A synchronous + TCP daytime server +

+

+ Next: Daytime.4 - A synchronous + UDP daytime client +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime3/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime3/src.html new file mode 100644 index 0000000..9da16cf --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime3/src.html @@ -0,0 +1,158 @@ + + + +Source listing for Daytime.3 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// server.cpp
+// ~~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <ctime>
+#include <functional>
+#include <iostream>
+#include <memory>
+#include <string>
+#include <asio.hpp>
+
+using asio::ip::tcp;
+
+std::string make_daytime_string()
+{
+  using namespace std; // For time_t, time and ctime;
+  time_t now = time(0);
+  return ctime(&now);
+}
+
+class tcp_connection
+  : public std::enable_shared_from_this<tcp_connection>
+{
+public:
+  typedef std::shared_ptr<tcp_connection> pointer;
+
+  static pointer create(asio::io_context& io_context)
+  {
+    return pointer(new tcp_connection(io_context));
+  }
+
+  tcp::socket& socket()
+  {
+    return socket_;
+  }
+
+  void start()
+  {
+    message_ = make_daytime_string();
+
+    asio::async_write(socket_, asio::buffer(message_),
+        std::bind(&tcp_connection::handle_write, shared_from_this(),
+          asio::placeholders::error,
+          asio::placeholders::bytes_transferred));
+  }
+
+private:
+  tcp_connection(asio::io_context& io_context)
+    : socket_(io_context)
+  {
+  }
+
+  void handle_write(const std::error_code& /*error*/,
+      size_t /*bytes_transferred*/)
+  {
+  }
+
+  tcp::socket socket_;
+  std::string message_;
+};
+
+class tcp_server
+{
+public:
+  tcp_server(asio::io_context& io_context)
+    : io_context_(io_context),
+      acceptor_(io_context, tcp::endpoint(tcp::v4(), 13))
+  {
+    start_accept();
+  }
+
+private:
+  void start_accept()
+  {
+    tcp_connection::pointer new_connection =
+      tcp_connection::create(io_context_);
+
+    acceptor_.async_accept(new_connection->socket(),
+        std::bind(&tcp_server::handle_accept, this, new_connection,
+          asio::placeholders::error));
+  }
+
+  void handle_accept(tcp_connection::pointer new_connection,
+      const std::error_code& error)
+  {
+    if (!error)
+    {
+      new_connection->start();
+    }
+
+    start_accept();
+  }
+
+  asio::io_context& io_context_;
+  tcp::acceptor acceptor_;
+};
+
+int main()
+{
+  try
+  {
+    asio::io_context io_context;
+    tcp_server server(io_context);
+    io_context.run();
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ Return to Daytime.3 - An asynchronous + TCP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime4.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime4.html new file mode 100644 index 0000000..ff59a1e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime4.html @@ -0,0 +1,125 @@ + + + +Daytime.4 - A synchronous UDP daytime client + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial program shows how to use asio to implement a client application + with UDP. +

+
#include <array>
+#include <iostream>
+#include <asio.hpp>
+
+using asio::ip::udp;
+
+

+ The start of the application is essentially the same as for the TCP daytime + client. +

+
int main(int argc, char* argv[])
+{
+  try
+  {
+    if (argc != 2)
+    {
+      std::cerr << "Usage: client <host>" << std::endl;
+      return 1;
+    }
+
+    asio::io_context io_context;
+
+

+ We use an ip::udp::resolver + object to find the correct remote endpoint to use based on the host and service + names. The query is restricted to return only IPv4 endpoints by the ip::udp::v4() argument. +

+
    udp::resolver resolver(io_context);
+    udp::endpoint receiver_endpoint =
+      *resolver.resolve(udp::v4(), argv[1], "daytime").begin();
+
+

+ The ip::udp::resolver::resolve() + function is guaranteed to return at least one endpoint in the list if it + does not fail. This means it is safe to dereference the return value directly. +

+

+ Since UDP is datagram-oriented, we will not be using a stream socket. Create + an ip::udp::socket and + initiate contact with the remote endpoint. +

+
    udp::socket socket(io_context);
+    socket.open(udp::v4());
+
+    std::array<char, 1> send_buf  = {{ 0 }};
+    socket.send_to(asio::buffer(send_buf), receiver_endpoint);
+
+

+ Now we need to be ready to accept whatever the server sends back to us. The + endpoint on our side that receives the server's response will be initialised + by ip::udp::socket::receive_from(). +

+
    std::array<char, 128> recv_buf;
+    udp::endpoint sender_endpoint;
+    size_t len = socket.receive_from(
+        asio::buffer(recv_buf), sender_endpoint);
+
+    std::cout.write(recv_buf.data(), len);
+  }
+
+

+ Finally, handle any exceptions that may have been thrown. +

+
  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Daytime.3 - An asynchronous + TCP daytime server +

+

+ Next: Daytime.5 - A synchronous + UDP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime4/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime4/src.html new file mode 100644 index 0000000..2f4b6de --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime4/src.html @@ -0,0 +1,92 @@ + + + +Source listing for Daytime.4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// client.cpp
+// ~~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <array>
+#include <iostream>
+#include <asio.hpp>
+
+using asio::ip::udp;
+
+int main(int argc, char* argv[])
+{
+  try
+  {
+    if (argc != 2)
+    {
+      std::cerr << "Usage: client <host>" << std::endl;
+      return 1;
+    }
+
+    asio::io_context io_context;
+
+    udp::resolver resolver(io_context);
+    udp::endpoint receiver_endpoint =
+      *resolver.resolve(udp::v4(), argv[1], "daytime").begin();
+
+    udp::socket socket(io_context);
+    socket.open(udp::v4());
+
+    std::array<char, 1> send_buf  = {{ 0 }};
+    socket.send_to(asio::buffer(send_buf), receiver_endpoint);
+
+    std::array<char, 128> recv_buf;
+    udp::endpoint sender_endpoint;
+    size_t len = socket.receive_from(
+        asio::buffer(recv_buf), sender_endpoint);
+
+    std::cout.write(recv_buf.data(), len);
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ Return to Daytime.4 - A synchronous + UDP daytime client +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime5.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime5.html new file mode 100644 index 0000000..602f10f --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime5.html @@ -0,0 +1,101 @@ + + + +Daytime.5 - A synchronous UDP daytime server + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial program shows how to use asio to implement a server application + with UDP. +

+
int main()
+{
+  try
+  {
+    asio::io_context io_context;
+
+

+ Create an ip::udp::socket + object to receive requests on UDP port 13. +

+
    udp::socket socket(io_context, udp::endpoint(udp::v4(), 13));
+
+

+ Wait for a client to initiate contact with us. The remote_endpoint object + will be populated by ip::udp::socket::receive_from(). +

+
    for (;;)
+    {
+      std::array<char, 1> recv_buf;
+      udp::endpoint remote_endpoint;
+      socket.receive_from(asio::buffer(recv_buf), remote_endpoint);
+
+

+ Determine what we are going to send back to the client. +

+
      std::string message = make_daytime_string();
+
+

+ Send the response to the remote_endpoint. +

+
      std::error_code ignored_error;
+      socket.send_to(asio::buffer(message),
+          remote_endpoint, 0, ignored_error);
+    }
+  }
+
+

+ Finally, handle any exceptions. +

+
  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Daytime.4 - A synchronous + UDP daytime client +

+

+ Next: Daytime.6 - An asynchronous + UDP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime5/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime5/src.html new file mode 100644 index 0000000..c3e091e --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime5/src.html @@ -0,0 +1,93 @@ + + + +Source listing for Daytime.5 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// server.cpp
+// ~~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <array>
+#include <ctime>
+#include <iostream>
+#include <string>
+#include <asio.hpp>
+
+using asio::ip::udp;
+
+std::string make_daytime_string()
+{
+  using namespace std; // For time_t, time and ctime;
+  time_t now = time(0);
+  return ctime(&now);
+}
+
+int main()
+{
+  try
+  {
+    asio::io_context io_context;
+
+    udp::socket socket(io_context, udp::endpoint(udp::v4(), 13));
+
+    for (;;)
+    {
+      std::array<char, 1> recv_buf;
+      udp::endpoint remote_endpoint;
+      socket.receive_from(asio::buffer(recv_buf), remote_endpoint);
+
+      std::string message = make_daytime_string();
+
+      std::error_code ignored_error;
+      socket.send_to(asio::buffer(message),
+          remote_endpoint, 0, ignored_error);
+    }
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ Return to Daytime.5 - A synchronous + UDP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime6.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime6.html new file mode 100644 index 0000000..1349fde --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime6.html @@ -0,0 +1,179 @@ + + + +Daytime.6 - An asynchronous UDP daytime server + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
+ + The + main() function +
+
int main()
+{
+  try
+  {
+
+

+ Create a server object to accept incoming client requests, and run the io_context object. +

+
    asio::io_context io_context;
+    udp_server server(io_context);
+    io_context.run();
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+
+ + The + udp_server class +
+
class udp_server
+{
+public:
+
+

+ The constructor initialises a socket to listen on UDP port 13. +

+
  udp_server(asio::io_context& io_context)
+    : socket_(io_context, udp::endpoint(udp::v4(), 13))
+  {
+    start_receive();
+  }
+
+private:
+  void start_receive()
+  {
+
+

+ The function ip::udp::socket::async_receive_from() + will cause the application to listen in the background for a new request. + When such a request is received, the io_context + object will invoke the handle_receive() function with two arguments: a value of + type std::error_code indicating whether the operation succeeded or failed, + and a size_t value bytes_transferred specifying the number + of bytes received. +

+
    socket_.async_receive_from(
+        asio::buffer(recv_buffer_), remote_endpoint_,
+        std::bind(&udp_server::handle_receive, this,
+          asio::placeholders::error,
+          asio::placeholders::bytes_transferred));
+  }
+
+

+ The function handle_receive() will service the client request. +

+
  void handle_receive(const std::error_code& error,
+      std::size_t /*bytes_transferred*/)
+  {
+
+

+ The error parameter contains + the result of the asynchronous operation. Since we only provide the 1-byte + recv_buffer_ to contain the + client's request, the io_context + object would return an error if the client sent anything larger. We can ignore + such an error if it comes up. +

+
    if (!error)
+    {
+
+

+ Determine what we are going to send. +

+
      std::shared_ptr<std::string> message(
+          new std::string(make_daytime_string()));
+
+

+ We now call ip::udp::socket::async_send_to() + to serve the data to the client. +

+
      socket_.async_send_to(asio::buffer(*message), remote_endpoint_,
+          std::bind(&udp_server::handle_send, this, message,
+            asio::placeholders::error,
+            asio::placeholders::bytes_transferred));
+
+

+ When initiating the asynchronous operation, and if using std::bind, + you must specify only the arguments that match the handler's parameter list. + In this program, both of the argument placeholders (asio::placeholders::error + and asio::placeholders::bytes_transferred) could potentially have been removed. +

+

+ Start listening for the next client request. +

+
      start_receive();
+
+

+ Any further actions for this client request are now the responsibility of + handle_send(). +

+
    }
+  }
+
+

+ The function handle_send() is invoked after the service request has + been completed. +

+
  void handle_send(std::shared_ptr<std::string> /*message*/,
+      const std::error_code& /*error*/,
+      std::size_t /*bytes_transferred*/)
+  {
+  }
+
+  udp::socket socket_;
+  udp::endpoint remote_endpoint_;
+  std::array<char, 1> recv_buffer_;
+};
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Daytime.5 - A synchronous + UDP daytime server +

+

+ Next: Daytime.7 - A combined TCP/UDP + asynchronous server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime6/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime6/src.html new file mode 100644 index 0000000..98b965a --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime6/src.html @@ -0,0 +1,129 @@ + + + +Source listing for Daytime.6 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// server.cpp
+// ~~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <array>
+#include <ctime>
+#include <functional>
+#include <iostream>
+#include <memory>
+#include <string>
+#include <asio.hpp>
+
+using asio::ip::udp;
+
+std::string make_daytime_string()
+{
+  using namespace std; // For time_t, time and ctime;
+  time_t now = time(0);
+  return ctime(&now);
+}
+
+class udp_server
+{
+public:
+  udp_server(asio::io_context& io_context)
+    : socket_(io_context, udp::endpoint(udp::v4(), 13))
+  {
+    start_receive();
+  }
+
+private:
+  void start_receive()
+  {
+    socket_.async_receive_from(
+        asio::buffer(recv_buffer_), remote_endpoint_,
+        std::bind(&udp_server::handle_receive, this,
+          asio::placeholders::error,
+          asio::placeholders::bytes_transferred));
+  }
+
+  void handle_receive(const std::error_code& error,
+      std::size_t /*bytes_transferred*/)
+  {
+    if (!error)
+    {
+      std::shared_ptr<std::string> message(
+          new std::string(make_daytime_string()));
+
+      socket_.async_send_to(asio::buffer(*message), remote_endpoint_,
+          std::bind(&udp_server::handle_send, this, message,
+            asio::placeholders::error,
+            asio::placeholders::bytes_transferred));
+
+      start_receive();
+    }
+  }
+
+  void handle_send(std::shared_ptr<std::string> /*message*/,
+      const std::error_code& /*error*/,
+      std::size_t /*bytes_transferred*/)
+  {
+  }
+
+  udp::socket socket_;
+  udp::endpoint remote_endpoint_;
+  std::array<char, 1> recv_buffer_;
+};
+
+int main()
+{
+  try
+  {
+    asio::io_context io_context;
+    udp_server server(io_context);
+    io_context.run();
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ Return to Daytime.6 - An asynchronous + UDP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime7.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime7.html new file mode 100644 index 0000000..81eedcc --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime7.html @@ -0,0 +1,217 @@ + + + +Daytime.7 - A combined TCP/UDP asynchronous server + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial program shows how to combine the two asynchronous servers that + we have just written, into a single server application. +

+
+ + The + main() function +
+
int main()
+{
+  try
+  {
+    asio::io_context io_context;
+
+

+ We will begin by creating a server object to accept a TCP client connection. +

+
    tcp_server server1(io_context);
+
+

+ We also need a server object to accept a UDP client request. +

+
    udp_server server2(io_context);
+
+

+ We have created two lots of work for the io_context + object to do. +

+
    io_context.run();
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+
+ + The + tcp_connection and tcp_server classes +
+

+ The following two classes are taken from Daytime.3. +

+
class tcp_connection
+  : public std::enable_shared_from_this<tcp_connection>
+{
+public:
+  typedef std::shared_ptr<tcp_connection> pointer;
+
+  static pointer create(asio::io_context& io_context)
+  {
+    return pointer(new tcp_connection(io_context));
+  }
+
+  tcp::socket& socket()
+  {
+    return socket_;
+  }
+
+  void start()
+  {
+    message_ = make_daytime_string();
+
+    asio::async_write(socket_, asio::buffer(message_),
+        std::bind(&tcp_connection::handle_write, shared_from_this()));
+  }
+
+private:
+  tcp_connection(asio::io_context& io_context)
+    : socket_(io_context)
+  {
+  }
+
+  void handle_write()
+  {
+  }
+
+  tcp::socket socket_;
+  std::string message_;
+};
+
+class tcp_server
+{
+public:
+  tcp_server(asio::io_context& io_context)
+    : io_context_(io_context),
+      acceptor_(io_context, tcp::endpoint(tcp::v4(), 13))
+  {
+    start_accept();
+  }
+
+private:
+  void start_accept()
+  {
+    tcp_connection::pointer new_connection =
+      tcp_connection::create(io_context_);
+
+    acceptor_.async_accept(new_connection->socket(),
+        std::bind(&tcp_server::handle_accept, this, new_connection,
+          asio::placeholders::error));
+  }
+
+  void handle_accept(tcp_connection::pointer new_connection,
+      const std::error_code& error)
+  {
+    if (!error)
+    {
+      new_connection->start();
+    }
+
+    start_accept();
+  }
+
+  asio::io_context& io_context_;
+  tcp::acceptor acceptor_;
+};
+
+
+ + The + udp_server class +
+

+ Similarly, this next class is taken from the previous + tutorial step. +

+
class udp_server
+{
+public:
+  udp_server(asio::io_context& io_context)
+    : socket_(io_context, udp::endpoint(udp::v4(), 13))
+  {
+    start_receive();
+  }
+
+private:
+  void start_receive()
+  {
+    socket_.async_receive_from(
+        asio::buffer(recv_buffer_), remote_endpoint_,
+        std::bind(&udp_server::handle_receive, this,
+          asio::placeholders::error));
+  }
+
+  void handle_receive(const std::error_code& error)
+  {
+    if (!error)
+    {
+      std::shared_ptr<std::string> message(
+          new std::string(make_daytime_string()));
+
+      socket_.async_send_to(asio::buffer(*message), remote_endpoint_,
+          std::bind(&udp_server::handle_send, this, message));
+
+      start_receive();
+    }
+  }
+
+  void handle_send(std::shared_ptr<std::string> /*message*/)
+  {
+  }
+
+  udp::socket socket_;
+  udp::endpoint remote_endpoint_;
+  std::array<char, 1> recv_buffer_;
+};
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Daytime.6 - An asynchronous + UDP daytime server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime7/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime7/src.html new file mode 100644 index 0000000..b99ca2c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tutdaytime7/src.html @@ -0,0 +1,199 @@ + + + +Source listing for Daytime.7 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// server.cpp
+// ~~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <array>
+#include <ctime>
+#include <functional>
+#include <iostream>
+#include <memory>
+#include <string>
+#include <asio.hpp>
+
+using asio::ip::tcp;
+using asio::ip::udp;
+
+std::string make_daytime_string()
+{
+  using namespace std; // For time_t, time and ctime;
+  time_t now = time(0);
+  return ctime(&now);
+}
+
+class tcp_connection
+  : public std::enable_shared_from_this<tcp_connection>
+{
+public:
+  typedef std::shared_ptr<tcp_connection> pointer;
+
+  static pointer create(asio::io_context& io_context)
+  {
+    return pointer(new tcp_connection(io_context));
+  }
+
+  tcp::socket& socket()
+  {
+    return socket_;
+  }
+
+  void start()
+  {
+    message_ = make_daytime_string();
+
+    asio::async_write(socket_, asio::buffer(message_),
+        std::bind(&tcp_connection::handle_write, shared_from_this()));
+  }
+
+private:
+  tcp_connection(asio::io_context& io_context)
+    : socket_(io_context)
+  {
+  }
+
+  void handle_write()
+  {
+  }
+
+  tcp::socket socket_;
+  std::string message_;
+};
+
+class tcp_server
+{
+public:
+  tcp_server(asio::io_context& io_context)
+    : io_context_(io_context),
+      acceptor_(io_context, tcp::endpoint(tcp::v4(), 13))
+  {
+    start_accept();
+  }
+
+private:
+  void start_accept()
+  {
+    tcp_connection::pointer new_connection =
+      tcp_connection::create(io_context_);
+
+    acceptor_.async_accept(new_connection->socket(),
+        std::bind(&tcp_server::handle_accept, this, new_connection,
+          asio::placeholders::error));
+  }
+
+  void handle_accept(tcp_connection::pointer new_connection,
+      const std::error_code& error)
+  {
+    if (!error)
+    {
+      new_connection->start();
+    }
+
+    start_accept();
+  }
+
+  asio::io_context& io_context_;
+  tcp::acceptor acceptor_;
+};
+
+class udp_server
+{
+public:
+  udp_server(asio::io_context& io_context)
+    : socket_(io_context, udp::endpoint(udp::v4(), 13))
+  {
+    start_receive();
+  }
+
+private:
+  void start_receive()
+  {
+    socket_.async_receive_from(
+        asio::buffer(recv_buffer_), remote_endpoint_,
+        std::bind(&udp_server::handle_receive, this,
+          asio::placeholders::error));
+  }
+
+  void handle_receive(const std::error_code& error)
+  {
+    if (!error)
+    {
+      std::shared_ptr<std::string> message(
+          new std::string(make_daytime_string()));
+
+      socket_.async_send_to(asio::buffer(*message), remote_endpoint_,
+          std::bind(&udp_server::handle_send, this, message));
+
+      start_receive();
+    }
+  }
+
+  void handle_send(std::shared_ptr<std::string> /*message*/)
+  {
+  }
+
+  udp::socket socket_;
+  udp::endpoint remote_endpoint_;
+  std::array<char, 1> recv_buffer_;
+};
+
+int main()
+{
+  try
+  {
+    asio::io_context io_context;
+    tcp_server server1(io_context);
+    udp_server server2(io_context);
+    io_context.run();
+  }
+  catch (std::exception& e)
+  {
+    std::cerr << e.what() << std::endl;
+  }
+
+  return 0;
+}
+
+

+ Return to Daytime.7 - A combined + TCP/UDP asynchronous server +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer1.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer1.html new file mode 100644 index 0000000..b463954 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer1.html @@ -0,0 +1,100 @@ + + + +Timer.1 - Using a timer synchronously + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial program introduces asio by showing how to perform a blocking + wait on a timer. +

+

+ We start by including the necessary header files. +

+

+ All of the asio classes can be used by simply including the "asio.hpp" header file. +

+
#include <iostream>
+#include <asio.hpp>
+
+

+ All programs that use asio need to have at least one I/O execution context, + such as an io_context or + thread_pool object. An + I/O execution context provides access to I/O functionality. We declare an + object of type io_context + first thing in the main function. +

+
int main()
+{
+  asio::io_context io;
+
+

+ Next we declare an object of type asio::steady_timer. The core asio classes + that provide I/O functionality (or as in this case timer functionality) always + take an executor, or a reference to an execution context (such as io_context), + as their first constructor argument. The second argument to the constructor + sets the timer to expire 5 seconds from now. +

+
  asio::steady_timer t(io, asio::chrono::seconds(5));
+
+

+ In this simple example we perform a blocking wait on the timer. That is, + the call to steady_timer::wait() + will not return until the timer has expired, 5 seconds after it was created + (i.e. not from when the wait starts). +

+

+ A timer is always in one of two states: "expired" or "not + expired". If the steady_timer::wait() + function is called on an expired timer, it will return immediately. +

+
  t.wait();
+
+

+ Finally we print the obligatory "Hello, + world!" message to show when the timer has expired. +

+
  std::cout << "Hello, world!" << std::endl;
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Next: Timer.2 - Using a timer asynchronously +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer1/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer1/src.html new file mode 100644 index 0000000..e0c3c95 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer1/src.html @@ -0,0 +1,64 @@ + + + +Source listing for Timer.1 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// timer.cpp
+// ~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <iostream>
+#include <asio.hpp>
+
+int main()
+{
+  asio::io_context io;
+
+  asio::steady_timer t(io, asio::chrono::seconds(5));
+  t.wait();
+
+  std::cout << "Hello, world!" << std::endl;
+
+  return 0;
+}
+
+

+ Return to Timer.1 - Using a timer + synchronously +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer2.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer2.html new file mode 100644 index 0000000..3abfd24 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer2.html @@ -0,0 +1,112 @@ + + + +Timer.2 - Using a timer asynchronously + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial program demonstrates how to use asio's asynchronous functionality + by modifying the program from tutorial Timer.1 to perform an asynchronous + wait on the timer. +

+
#include <iostream>
+#include <asio.hpp>
+
+

+ Using asio's asynchronous functionality means supplying a completion + token, which determines how the result will be delivered to a completion handler when an asynchronous + operation completes. In this program we define a function called + print to be called when the + asynchronous wait finishes. +

+
void print(const std::error_code& /*e*/)
+{
+  std::cout << "Hello, world!" << std::endl;
+}
+
+int main()
+{
+  asio::io_context io;
+
+  asio::steady_timer t(io, asio::chrono::seconds(5));
+
+

+ Next, instead of doing a blocking wait as in tutorial Timer.1, we call the + steady_timer::async_wait() + function to perform an asynchronous wait. When calling this function we pass + the print function that was + defined above. +

+
  t.async_wait(&print);
+
+

+ Finally, we must call the asio::io_context::run() member function on the + io_context object. +

+

+ The asio library provides a guarantee that completion handlers will only + be called from threads that are currently calling asio::io_context::run(). + Therefore unless the asio::io_context::run() function is called the completion + handler for the asynchronous wait completion will never be invoked. +

+

+ The asio::io_context::run() function will also continue to run while there + is still "work" to do. In this example, the work is the asynchronous + wait on the timer, so the call will not return until the timer has expired + and the completion handler has returned. +

+

+ It is important to remember to give the io_context some work to do before + calling asio::io_context::run(). For example, if we had omitted the above + call to steady_timer::async_wait(), + the io_context would not have had any work to do, and consequently asio::io_context::run() + would have returned immediately. +

+
  io.run();
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Timer.1 - Using a timer + synchronously +

+

+ Next: Timer.3 - Binding arguments + to a completion handler +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer2/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer2/src.html new file mode 100644 index 0000000..cbd4756 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer2/src.html @@ -0,0 +1,69 @@ + + + +Source listing for Timer.2 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// timer.cpp
+// ~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <iostream>
+#include <asio.hpp>
+
+void print(const std::error_code& /*e*/)
+{
+  std::cout << "Hello, world!" << std::endl;
+}
+
+int main()
+{
+  asio::io_context io;
+
+  asio::steady_timer t(io, asio::chrono::seconds(5));
+  t.async_wait(&print);
+
+  io.run();
+
+  return 0;
+}
+
+

+ Return to Timer.2 - Using a timer + asynchronously +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer3.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer3.html new file mode 100644 index 0000000..3c41eff --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer3.html @@ -0,0 +1,158 @@ + + + +Timer.3 - Binding arguments to a completion handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In this tutorial we will modify the program from tutorial Timer.2 so that + the timer fires once a second. This will show how to pass additional parameters + to your handler function. +

+
#include <functional>
+#include <iostream>
+#include <asio.hpp>
+
+

+ To implement a repeating timer using asio you need to change the timer's + expiry time in your completion handler, and to then start a new asynchronous + wait. Obviously this means that the completion handler will need to be able + to access the timer object. To this end we add two new parameters to the + print function: +

+
    +
  • + a pointer to a timer object; and +
    • +
  • + a counter so that we can stop the program when the timer fires for the + sixth time +
    • +
+

+ at the end of the parameter list. +

+
void print(const std::error_code& /*e*/,
+    asio::steady_timer* t, int* count)
+{
+
+

+ As mentioned above, this tutorial program uses a counter to stop running + when the timer fires for the sixth time. However you will observe that there + is no explicit call to ask the io_context to stop. Recall that in tutorial + Timer.2 we learnt that the asio::io_context::run() function completes when + there is no more "work" to do. By not starting a new asynchronous + wait on the timer when count + reaches 5, the io_context will run out of work and stop running. +

+
  if (*count < 5)
+  {
+    std::cout << *count << std::endl;
+    ++(*count);
+
+

+ Next we move the expiry time for the timer along by one second from the previous + expiry time. By calculating the new expiry time relative to the old, we can + ensure that the timer does not drift away from the whole-second mark due + to any delays in processing the handler. +

+
    t->expires_at(t->expiry() + asio::chrono::seconds(1));
+
+

+ Then we start a new asynchronous wait on the timer. As you can see, the + std::bind function is used to associate the + extra parameters with your completion handler. The steady_timer::async_wait() + function expects a handler function (or function object) with the signature + void(const std::error_code&). Binding the additional parameters + converts your print function + into a function object that matches the signature correctly. +

+

+ In this example, the asio::placeholders::error argument to std::bind + is a named placeholder for the error object passed to the handler. When initiating + the asynchronous operation, and if using std::bind, + you must specify only the arguments that match the handler's parameter list. + In tutorial Timer.4 you will see that this placeholder may be elided if the + parameter is not needed by the completion handler. +

+
    t->async_wait(std::bind(print,
+          asio::placeholders::error, t, count));
+  }
+}
+
+int main()
+{
+  asio::io_context io;
+
+

+ A new count variable is added + so that we can stop the program when the timer fires for the sixth time. +

+
  int count = 0;
+  asio::steady_timer t(io, asio::chrono::seconds(1));
+
+

+ As in Step 4, when making the call to steady_timer::async_wait() + from main we bind the additional + parameters needed for the print + function. +

+
  t.async_wait(std::bind(print,
+        asio::placeholders::error, &t, &count));
+
+  io.run();
+
+

+ Finally, just to prove that the count + variable was being used in the print + handler function, we will print out its new value. +

+
  std::cout << "Final count is " << count << std::endl;
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Timer.2 - Using a timer + asynchronously +

+

+ Next: Timer.4 - Using a member function + as a completion handler +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer3/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer3/src.html new file mode 100644 index 0000000..8f6568c --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer3/src.html @@ -0,0 +1,83 @@ + + + +Source listing for Timer.3 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// timer.cpp
+// ~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <functional>
+#include <iostream>
+#include <asio.hpp>
+
+void print(const std::error_code& /*e*/,
+    asio::steady_timer* t, int* count)
+{
+  if (*count < 5)
+  {
+    std::cout << *count << std::endl;
+    ++(*count);
+
+    t->expires_at(t->expiry() + asio::chrono::seconds(1));
+    t->async_wait(std::bind(print,
+          asio::placeholders::error, t, count));
+  }
+}
+
+int main()
+{
+  asio::io_context io;
+
+  int count = 0;
+  asio::steady_timer t(io, asio::chrono::seconds(1));
+  t.async_wait(std::bind(print,
+        asio::placeholders::error, &t, &count));
+
+  io.run();
+
+  std::cout << "Final count is " << count << std::endl;
+
+  return 0;
+}
+
+

+ Return to Timer.3 - Binding arguments + to a completion handler +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer4.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer4.html new file mode 100644 index 0000000..b34ff25 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer4.html @@ -0,0 +1,141 @@ + + + +Timer.4 - Using a member function as a completion handler + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ In this tutorial we will see how to use a class member function as a completion + handler. The program should execute identically to the tutorial program from + tutorial Timer.3. +

+
#include <functional>
+#include <iostream>
+#include <asio.hpp>
+
+

+ Instead of defining a free function print + as the completion handler, as we did in the earlier tutorial programs, we + now define a class called printer. +

+
class printer
+{
+public:
+
+

+ The constructor of this class will take a reference to the io_context object + and use it when initialising the timer_ + member. The counter used to shut down the program is now also a member of + the class. +

+
  printer(asio::io_context& io)
+    : timer_(io, asio::chrono::seconds(1)),
+      count_(0)
+  {
+
+

+ The std::bind function works just as well with class + member functions as with free functions. Since all non-static class member + functions have an implicit this + parameter, we need to bind this + to the function. As in tutorial Timer.3, std::bind + converts our completion handler (now a member function) into a function object + that can be invoked as though it has the signature void(const std::error_code&). +

+

+ You will note that the asio::placeholders::error placeholder is not specified + here, as the print member + function does not accept an error object as a parameter. +

+
    timer_.async_wait(std::bind(&printer::print, this));
+  }
+
+

+ In the class destructor we will print out the final value of the counter. +

+
  ~printer()
+  {
+    std::cout << "Final count is " << count_ << std::endl;
+  }
+
+

+ The print member function + is very similar to the print + function from tutorial Timer.3, except that it now operates on the class + data members instead of having the timer and counter passed in as parameters. +

+
  void print()
+  {
+    if (count_ < 5)
+    {
+      std::cout << count_ << std::endl;
+      ++count_;
+
+      timer_.expires_at(timer_.expiry() + asio::chrono::seconds(1));
+      timer_.async_wait(std::bind(&printer::print, this));
+    }
+  }
+
+private:
+  asio::steady_timer timer_;
+  int count_;
+};
+
+

+ The main function is much + simpler than before, as it now declares a local printer + object before running the io_context as normal. +

+
int main()
+{
+  asio::io_context io;
+  printer p(io);
+  io.run();
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Timer.3 - Binding arguments + to a completion handler +

+

+ Next: Timer.5 - Synchronising completion + handlers in multithreaded programs +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer4/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer4/src.html new file mode 100644 index 0000000..90533a3 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer4/src.html @@ -0,0 +1,94 @@ + + + +Source listing for Timer.4 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// timer.cpp
+// ~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <functional>
+#include <iostream>
+#include <asio.hpp>
+
+class printer
+{
+public:
+  printer(asio::io_context& io)
+    : timer_(io, asio::chrono::seconds(1)),
+      count_(0)
+  {
+    timer_.async_wait(std::bind(&printer::print, this));
+  }
+
+  ~printer()
+  {
+    std::cout << "Final count is " << count_ << std::endl;
+  }
+
+  void print()
+  {
+    if (count_ < 5)
+    {
+      std::cout << count_ << std::endl;
+      ++count_;
+
+      timer_.expires_at(timer_.expiry() + asio::chrono::seconds(1));
+      timer_.async_wait(std::bind(&printer::print, this));
+    }
+  }
+
+private:
+  asio::steady_timer timer_;
+  int count_;
+};
+
+int main()
+{
+  asio::io_context io;
+  printer p(io);
+  io.run();
+
+  return 0;
+}
+
+

+ Return to Timer.4 - Using a member + function as a completion handler +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer5.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer5.html new file mode 100644 index 0000000..0312458 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer5.html @@ -0,0 +1,197 @@ + + + +Timer.5 - Synchronising completion handlers in multithreaded programs + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ This tutorial demonstrates the use of the strand + class template to synchronise completion handlers in a multithreaded program. +

+

+ The previous four tutorials avoided the issue of handler synchronisation + by calling the asio::io_context::run() function from one thread only. As + you already know, the asio library provides a guarantee that completion handlers + will only be called from threads that are currently calling asio::io_context::run(). + Consequently, calling asio::io_context::run() from only one thread ensures + that completion handlers cannot run concurrently. +

+

+ The single threaded approach is usually the best place to start when developing + applications using asio. The downside is the limitations it places on programs, + particularly servers, including: +

+
    +
  • + Poor responsiveness when handlers can take a long time to complete. +
    • +
  • + An inability to scale on multiprocessor systems. +
    • +
+

+ If you find yourself running into these limitations, an alternative approach + is to have a pool of threads calling asio::io_context::run(). However, as + this allows handlers to execute concurrently, we need a method of synchronisation + when handlers might be accessing a shared, thread-unsafe resource. +

+
#include <functional>
+#include <iostream>
+#include <thread>
+#include <asio.hpp>
+
+

+ We start by defining a class called printer, + similar to the class in the previous tutorial. This class will extend the + previous tutorial by running two timers in parallel. +

+
class printer
+{
+public:
+
+

+ In addition to initialising a pair of asio::steady_timer members, the constructor + initialises the strand_ member, + an object of type asio::strand<asio::io_context::executor_type>. +

+

+ The strand class template is + an executor adapter that guarantees that, for those handlers that are dispatched + through it, an executing handler will be allowed to complete before the next + one is started. This is guaranteed irrespective of the number of threads + that are calling asio::io_context::run(). Of course, the handlers may still + execute concurrently with other handlers that were not dispatched through + an strand, or were dispatched + through a different strand object. +

+
  printer(asio::io_context& io)
+    : strand_(asio::make_strand(io)),
+      timer1_(io, asio::chrono::seconds(1)),
+      timer2_(io, asio::chrono::seconds(1)),
+      count_(0)
+  {
+
+

+ When initiating the asynchronous operations, each completion handler is "bound" + to an asio::strand<asio::io_context::executor_type> object. The asio::bind_executor() + function returns a new handler that automatically dispatches its contained + handler through the strand object. + By binding the handlers to the same strand, + we are ensuring that they cannot execute concurrently. +

+
    timer1_.async_wait(asio::bind_executor(strand_,
+          std::bind(&printer::print1, this)));
+
+    timer2_.async_wait(asio::bind_executor(strand_,
+          std::bind(&printer::print2, this)));
+  }
+
+  ~printer()
+  {
+    std::cout << "Final count is " << count_ << std::endl;
+  }
+
+

+ In a multithreaded program, the handlers for asynchronous operations should + be synchronised if they access shared resources. In this tutorial, the shared + resources used by the handlers (print1 + and print2) are std::cout + and the count_ data member. +

+
  void print1()
+  {
+    if (count_ < 10)
+    {
+      std::cout << "Timer 1: " << count_ << std::endl;
+      ++count_;
+
+      timer1_.expires_at(timer1_.expiry() + asio::chrono::seconds(1));
+
+      timer1_.async_wait(asio::bind_executor(strand_,
+            std::bind(&printer::print1, this)));
+    }
+  }
+
+  void print2()
+  {
+    if (count_ < 10)
+    {
+      std::cout << "Timer 2: " << count_ << std::endl;
+      ++count_;
+
+      timer2_.expires_at(timer2_.expiry() + asio::chrono::seconds(1));
+
+      timer2_.async_wait(asio::bind_executor(strand_,
+            std::bind(&printer::print2, this)));
+    }
+  }
+
+private:
+  asio::strand<asio::io_context::executor_type> strand_;
+  asio::steady_timer timer1_;
+  asio::steady_timer timer2_;
+  int count_;
+};
+
+

+ The main function now causes + asio::io_context::run() to be called from two threads: the main thread and + one additional thread. This is accomplished using an thread + object. +

+

+ Just as it would with a call from a single thread, concurrent calls to asio::io_context::run() + will continue to execute while there is "work" left to do. The + background thread will not exit until all asynchronous operations have completed. +

+
int main()
+{
+  asio::io_context io;
+  printer p(io);
+  std::thread t([&]{ io.run(); });
+  io.run();
+  t.join();
+
+  return 0;
+}
+
+

+ See the full source listing +

+

+ Return to the tutorial index +

+

+ Previous: Timer.4 - Using a member + function as a completion handler +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer5/src.html b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer5/src.html new file mode 100644 index 0000000..715c908 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/tutorial/tuttimer5/src.html @@ -0,0 +1,121 @@ + + + +Source listing for Timer.5 + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+
//
+// timer.cpp
+// ~~~~~~~~~
+//
+// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+
+#include <functional>
+#include <iostream>
+#include <thread>
+#include <asio.hpp>
+
+class printer
+{
+public:
+  printer(asio::io_context& io)
+    : strand_(asio::make_strand(io)),
+      timer1_(io, asio::chrono::seconds(1)),
+      timer2_(io, asio::chrono::seconds(1)),
+      count_(0)
+  {
+    timer1_.async_wait(asio::bind_executor(strand_,
+          std::bind(&printer::print1, this)));
+
+    timer2_.async_wait(asio::bind_executor(strand_,
+          std::bind(&printer::print2, this)));
+  }
+
+  ~printer()
+  {
+    std::cout << "Final count is " << count_ << std::endl;
+  }
+
+  void print1()
+  {
+    if (count_ < 10)
+    {
+      std::cout << "Timer 1: " << count_ << std::endl;
+      ++count_;
+
+      timer1_.expires_at(timer1_.expiry() + asio::chrono::seconds(1));
+
+      timer1_.async_wait(asio::bind_executor(strand_,
+            std::bind(&printer::print1, this)));
+    }
+  }
+
+  void print2()
+  {
+    if (count_ < 10)
+    {
+      std::cout << "Timer 2: " << count_ << std::endl;
+      ++count_;
+
+      timer2_.expires_at(timer2_.expiry() + asio::chrono::seconds(1));
+
+      timer2_.async_wait(asio::bind_executor(strand_,
+            std::bind(&printer::print2, this)));
+    }
+  }
+
+private:
+  asio::strand<asio::io_context::executor_type> strand_;
+  asio::steady_timer timer1_;
+  asio::steady_timer timer2_;
+  int count_;
+};
+
+int main()
+{
+  asio::io_context io;
+  printer p(io);
+  std::thread t([&]{ io.run(); });
+  io.run();
+  t.join();
+
+  return 0;
+}
+
+

+ Return to Timer.5 - Synchronising + completion handlers in multithreaded programs +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/asio/using.html b/Packages/asio-1.36.0/doc/asio/using.html new file mode 100644 index 0000000..7e9f374 --- /dev/null +++ b/Packages/asio-1.36.0/doc/asio/using.html @@ -0,0 +1,2369 @@ + + + +Using, Building, and Configuring Asio + + + + + + + + + +
asio C++ library
+
+
+PrevUpHomeNext +
+
+
+

+ + Supported + Platforms +

+

+ The following platform and compiler combinations are regularly tested: +

+
    +
  • + Linux using g++ 4.6 or later +
    • +
  • + Linux using clang 3.4 or later +
    • +
  • + FreeBSD using g++ 9 or later +
    • +
  • + macOS using Xcode 10 or later +
    • +
  • + Win32 using Visual C++ 11.0 (Visual Studio 2012) or later +
    • +
  • + Win64 using Visual C++ 11.0 (Visual Studio 2012) or later +
    • +
+

+ The following platforms may also work: +

+
    +
  • + AIX +
    • +
  • + Android +
    • +
  • + HP-UX +
    • +
  • + iOS +
    • +
  • + NetBSD +
    • +
  • + OpenBSD +
    • +
  • + QNX Neutrino +
    • +
  • + Solaris +
    • +
  • + Tru64 +
    • +
  • + Win32 using MinGW. +
    • +
  • + Win32 using Cygwin. (__USE_W32_SOCKETS + must be defined.) +
    • +
+

+ + Dependencies +

+

+ The following libraries must be available in order to link programs that use + Asio: +

+
    +
  • + Boost.Coroutine (optional) if you use spawn() + to launch coroutines. +
    • +
  • + Boost.Regex (optional) if you use any of the read_until() + or async_read_until() overloads that take a boost::regex parameter. +
    • +
  • + OpenSSL (optional) if you use + Asio's SSL support. +
    • +
+

+ Furthermore, some of the examples also require Boost.Date_Time or Boost.Serialization + libraries. +

+
+ + + + + +
[Note]Note

+ With MSVC or Borland C++ you may want to add -DBOOST_DATE_TIME_NO_LIB and -DBOOST_REGEX_NO_LIB + to your project settings to disable autolinking of the Boost.Date_Time and + Boost.Regex libraries respectively. Alternatively, you may choose to build + these libraries and link to them. +

+

+ + Optional + separate compilation +

+

+ By default, Asio is a header-only library. However, some developers may prefer + to build Asio using separately compiled source code. To do this, add #include <asio/impl/src.hpp> to + one (and only one) source file in a program, then build the program with ASIO_SEPARATE_COMPILATION defined in the + project/compiler settings. Alternatively, ASIO_DYN_LINK + may be defined to build a separately-compiled Asio as part of a shared library. +

+

+ If using Asio's SSL support, you will also need to add #include + <asio/ssl/impl/src.hpp>. +

+

+ + Debugger + support +

+

+ Some debugger extensions for use with Asio may be found at https://github.com/chriskohlhoff/asio-debugger-extensions. +

+

+ + Building + the tests and examples on Linux or UNIX +

+

+ If the boost directory (e.g. the directory called boost_1_34_1) + is in the same directory as the asio source kit, then you may configure asio + by simply going: +

+
./configure
+
+

+ in the root directory of the asio source kit. Note that configure will always + use the most recent boost version it knows about (i.e. 1.34.1) in preference + to earlier versions, if there is more than one version present. +

+

+ If the boost directory is in some other location, then you need to specify + this directory when running configure: +

+
./configure --with-boost=path_to_boost
+
+

+ When specifying the boost directory in this way you should ensure that you + use an absolute path. +

+

+ To build the examples, simply run make + in the root directory of the asio source kit. To also build and run the unit + tests, to confirm that asio is working correctly, run make + check. +

+

+ + Building + the tests and examples with MSVC +

+

+ To build using the MSVC 9.0 (or later) command line compiler, perform the following + steps in a Command Prompt window: +

+
    +
  • + If you are using a version of boost other than 1.34.1, or if the boost + directory (i.e. the directory called boost_1_34_1) + is not in the same directory as the asio source kit, then specify the location + of boost by running a command similar to set BOOSTDIR=path_to_boost. + Ensure that you specify an absolute path. +
    • +
  • + Change to the asio src + directory. +
    • +
  • + Execute the command nmake -f Makefile.msc. +
    • +
  • + Execute the command nmake -f Makefile.msc check to run a suite of tests to confirm + that asio is working correctly. +
    • +
+

+ + Building + the tests and examples with MinGW +

+

+ To build using the MinGW g++ compiler from the command line, perform the following + steps in a Command Prompt window: +

+
    +
  • + If you are using a version of boost other than 1.34.1, or if the boost + directory (i.e. the directory called boost_1_34_1) + is not in the same directory as the asio source kit, then specify the location + of boost by running a command similar to set BOOSTDIR=path_to_boost. + Ensure that you specify an absolute path using forward slashes + (i.e. c:/projects/boost_1_34_1 rather than c:\projects\boost_1_34_1). +
    • +
  • + Change to the asio src + directory. +
    • +
  • + Execute the command make -f Makefile.mgw. +
    • +
  • + Execute the command make -f Makefile.mgw check to run a suite of tests to confirm + that asio is working correctly. +
    • +
+
+ + + + + +
[Note]Note

+ The above instructions do not work when building inside MSYS. If you want + to build using MSYS, you should use export rather than + set to specify the location of boost. +

+

+ + Macros +

+

+ The macros listed in the table below may be used to control the interface, + functionality, and behaviour of Asio. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Macro +

+ 		+

+ Description +

+
+

+ ASIO_NO_DEPRECATED +

+ 		+

+ Disables Asio's deprecated interfaces and functionality. +

+

+ See Networking TS Compatibility + for a list of older interfaces that have been deprecated, and their + replacements. +

+
+

+ ASIO_NO_TS_EXECUTORS +

+ 		+

+ Disables Asio's support for the Networking TS executor model. +

+

+ By default, Asio simultaneously supports both Networking TS-style + executors, and executors that adhere to the proposed standard executor + model. This macro may be used to limit support to the proposed standard + executors only. See Proposed Standard + Executors for more information. +

+
+

+ ASIO_USE_TS_EXECUTOR_AS_DEFAULT +

+ 		+

+ Specifies that any_io_executor refer to + the Networking TS-style polymorphic wrapper. +

+

+ The any_io_executor + type alias is the default runtime-polymorphic executor for all I/O + objects. This type alias points to the execution::any_executor<> + template with a set of supportable properties specified for use with + I/O. +

+

+ This new name may break existing code that directly uses the old + Networking TS-style polymorphic wrapper, executor. If required for + backward compatibility, ASIO_USE_TS_EXECUTOR_AS_DEFAULT + changes the any_io_executor + type alias to instead point to the executor + polymorphic wrapper. +

+

+ See Proposed Standard Executors + for more information. +

+
+

+ ASIO_NO_DYNAMIC_BUFFER_V1 +

+ 		+

+ Disables support for the DynamicBuffer_v1 type requirements. +

+

+ By default, dynamic buffer operations such as read, async_read, read_until, async_read_until, write, + and async_write + support both the DynamicBuffer_v1 + and the DynamicBuffer_v2 type requirements + for dynamic buffers. +

+

+ When ASIO_NO_DYNAMIC_BUFFER_V1 + is defined, all support for DynamicBuffer_v1 + types and functions is #ifdef-ed out. Support for using basic_streambuf with the + read, async_read, read_until, + async_read_until, + write, and async_write functions is also disabled + as a consequence. +

+
+

+ ASIO_ENABLE_BUFFER_DEBUGGING +

+ 		+

+ Enables Asio's buffer debugging support, which can help identify + when invalid buffers are used in read or write operations (e.g. if + a std::string object being written is destroyed before the write + operation completes). +

+

+ When using Microsoft Visual C++ 11.0 or later, this macro is defined + automatically if the compiler's iterator debugging support is enabled, + unless ASIO_DISABLE_BUFFER_DEBUGGING + has been defined. +

+

+ When using g++, this macro is defined automatically if standard library + debugging is enabled (_GLIBCXX_DEBUG + is defined), unless ASIO_DISABLE_BUFFER_DEBUGGING + has been defined. +

+
+

+ ASIO_DISABLE_BUFFER_DEBUGGING +

+ 		+

+ Explictly disables Asio's buffer debugging support. +

+
+

+ ASIO_ENABLE_HANDLER_TRACKING +

+ 		+

+ Enables Asio's Handler + Tracking debugging facility. +

+
+

+ ASIO_DISABLE_DEV_POLL +

+ 		+

+ Explicitly disables /dev/poll support on Solaris, + forcing the use of a select-based + implementation. +

+
+

+ ASIO_DISABLE_EPOLL +

+ 		+

+ Explicitly disables epoll + support on Linux, forcing the use of a select-based + implementation. +

+
+

+ ASIO_DISABLE_EVENTFD +

+ 		+

+ Explicitly disables eventfd + support on Linux, forcing the use of a pipe to interrupt blocked + epoll/select system calls. +

+
+

+ ASIO_DISABLE_KQUEUE +

+ 		+

+ Explicitly disables kqueue + support on macOS and BSD variants, forcing the use of a select-based implementation. +

+
+

+ ASIO_DISABLE_IOCP +

+ 		+

+ Explicitly disables I/O completion ports support on Windows, forcing + the use of a select-based + implementation. +

+
+

+ ASIO_DISABLE_THREADS +

+ 		+

+ Explicitly disables Asio's threading support, independent of whether + or not Boost supports threads. +

+
+

+ ASIO_NO_WIN32_LEAN_AND_MEAN +

+ 		+

+ By default, Asio will automatically define WIN32_LEAN_AND_MEAN + when compiling for Windows, to minimise the number of Windows SDK + header files and features that are included. The presence of ASIO_NO_WIN32_LEAN_AND_MEAN prevents + WIN32_LEAN_AND_MEAN + from being defined. +

+
+

+ ASIO_NO_NOMINMAX +

+ 		+

+ By default, Asio will automatically define NOMINMAX + when compiling for Windows, to suppress the definition of the min() + and max() + macros. The presence of ASIO_NO_NOMINMAX + prevents NOMINMAX + from being defined. +

+
+

+ ASIO_NO_DEFAULT_LINKED_LIBS +

+ 		+

+ When compiling for Windows using Microsoft Visual C++ or Borland + C++, Asio will automatically link in the necessary Windows SDK libraries + for sockets support (i.e. ws2_32.lib and mswsock.lib, + or ws2.lib when building for Windows CE). The + ASIO_NO_DEFAULT_LINKED_LIBS + macro prevents these libraries from being linked. +

+
+

+ ASIO_ENABLE_CANCELIO +

+ 		+

+ Enables use of the CancelIo + function on older versions of Windows. If not enabled, calls to + cancel() + on a socket object will always fail with asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions + of Windows. When running on Windows Vista, Windows Server 2008, and + later, the CancelIoEx + function is always used. +

+

+ The CancelIo function + has two issues that should be considered before enabling its use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated + in the current thread. +
    • +
  • +

    + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers + that are installed. +

    +

    + For portable cancellation, consider using one of the following + alternatives: +

    +
    • +
  • + Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. +
    • +
  • + Use the socket object's close() function to simultaneously cancel + the outstanding operations and close the socket. +
    • +
+
+

+ ASIO_NO_TYPEID +

+ 		+

+ Disables uses of the typeid + operator in asio. Defined automatically if BOOST_NO_TYPEID + is defined. +

+
+

+ ASIO_HASH_MAP_BUCKETS +

+ 		+

+ Determines the number of buckets in asio's internal hash_map objects. The value should + be a comma separated list of prime numbers, in ascending order. The + hash_map implementation + will automatically increase the number of buckets as the number of + elements in the map increases. +

+

+ Some examples: +

+
    +
  • + Defining ASIO_HASH_MAP_BUCKETS + to 1021 means that + the hash_map + objects will always contain 1021 buckets, irrespective of the + number of elements in the map. +
    • +
  • + Defining ASIO_HASH_MAP_BUCKETS + to 53,389,1543 means that the hash_map objects will initially + contain 53 buckets. The number of buckets will be increased to + 389 and then 1543 as elements are added to the map. +
    • +
+
+

+ ASIO_USE_BOOST_DATE_TIME_FOR_SOCKET_IOSTREAM +

+ 		+

+ Changes basic_socket_streambuf and + basic_socket_iostream to + use the old Boost.Date_Time interface, rather than chrono. +

+
+

+ ASIO_SEPARATE_COMPILATION +

+ 		+

+ Uses separately compiled source code for Asio's implementation. +

+

+ See above + for further information. +

+
+

+ ASIO_DYN_LINK +

+ 		+

+ Uses separately compiled source code for Asio's implementation, with + symbols exported for inclusion as part of a shared library. +

+

+ See above + for further information. +

+
+

+ ASIO_DISABLE_VISIBILITY +

+ 		+

+ Disables all symbol visibility pragmas. +

+

+ Note: If symbols are hidden, extra care must be taken to ensure that + Asio types are not passed across shared library API boundaries. +

+
+

+ + Compiler/platform + feature detection macros +

+

+ Asio automatically defines preprocessor macros corresponding to the detected + available features on a particular compiler and target platform. These macros + are named with the prefix ASIO_HAS_, + and are listed in the table below. +

+

+ Many of these macros also have a corresponding ASIO_DISABLE_ + macro that may be used to explicitly disable the feature. +

+

+ In general, ASIO_HAS_ macros + should not be explicitly defined by the user, except when absolutely required + as a workaround for the latest version of a compiler or platform. For older + compiler/platform combinations where a specific ASIO_HAS_ + macro is not automatically defined, testing may have shown that a claimed feature + isn't sufficiently conformant to be compatible with Asio's needs. +

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Macro +

+ 		+

+ Description +

+ 		+

+ Macro to disable feature +

+
+

+ ASIO_HAS_ALIAS_TEMPLATES +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_ALIGNOF +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_BOOST_ALIGN +

+ 		+

+ Boost align library. +

+ 		+

+ ASIO_DISABLE_BOOST_ALIGN +

+
+

+ ASIO_HAS_BOOST_ARRAY +

+ 		+

+ Boost array library. +

+ 		+

+ ASIO_DISABLE_BOOST_ARRAY +

+
+

+ ASIO_HAS_BOOST_ASSERT +

+ 		+

+ Boost assert macro. +

+ 		+

+ ASIO_DISABLE_BOOST_ASSERT +

+
+

+ ASIO_HAS_BOOST_BIND +

+ 		+

+ Boost bind function. +

+ 		+

+ ASIO_DISABLE_BOOST_BIND +

+
+

+ ASIO_HAS_BOOST_CHRONO +

+ 		+

+ Boost support for chrono. +

+ 		+

+ ASIO_DISABLE_BOOST_CHRONO +

+
+

+ ASIO_HAS_BOOST_CONFIG +

+ 		+

+ Boost.Config library is available. +

+ 		+
+

+ ASIO_HAS_BOOST_CONTEXT_FIBER +

+ 		+

+ Boost support for the Context library's fibers. +

+ 		+

+ ASIO_DISABLE_BOOST_CONTEXT_FIBER +

+
+

+ ASIO_HAS_BOOST_COROUTINE +

+ 		+

+ Boost support for the Coroutine library. +

+ 		+

+ ASIO_DISABLE_BOOST_COROUTINE +

+
+

+ ASIO_HAS_BOOST_DATE_TIME +

+ 		+

+ Boost support for the DateTime library. +

+ 		+

+ ASIO_DISABLE_BOOST_DATE_TIME +

+
+

+ ASIO_HAS_BOOST_LIMITS +

+ 		+

+ Boost limits header. +

+ 		+

+ ASIO_DISABLE_BOOST_LIMITS +

+
+

+ ASIO_HAS_BOOST_REGEX +

+ 		+

+ Boost regex library. +

+ 		+

+ ASIO_DISABLE_BOOST_REGEX +

+
+

+ ASIO_HAS_BOOST_SOURCE_LOCATION +

+ 		+

+ Boost support for source_location and system errors. +

+ 		+

+ ASIO_DISABLE_BOOST_SOURCE_LOCATION +

+
+

+ ASIO_HAS_BOOST_THROW_EXCEPTION +

+ 		+

+ Boost throw_exception function. +

+ 		+

+ ASIO_DISABLE_BOOST_THROW_EXCEPTION +

+
+

+ ASIO_HAS_BOOST_WORKAROUND +

+ 		+

+ Boost's BOOST_WORKAROUND macro. +

+ 		+

+ ASIO_DISABLE_BOOST_WORKAROUND +

+
+

+ ASIO_HAS_CHRONO +

+ 		+

+ Some form of chrono library is available. +

+ 		+
+

+ ASIO_HAS_CLANG_LIBCXX +

+ 		+

+ Clang / libc++ detection. +

+ 		+
+

+ ASIO_HAS_CONCEPTS +

+ 		+

+ Support concepts on compilers known to allow them. +

+ 		+

+ ASIO_DISABLE_CONCEPTS +

+
+

+ ASIO_HAS_CONSTANT_EXPRESSION_SFINAE +

+ 		+

+ Support SFINAE use of constant expressions on compilers known to + allow it. +

+ 		+

+ ASIO_DISABLE_CONSTANT_EXPRESSION_SFINAE +

+
+

+ ASIO_HAS_CONSTEXPR +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_CO_AWAIT +

+ 		+

+ Support the co_await keyword on compilers known to allow it. +

+ 		+

+ ASIO_DISABLE_CO_AWAIT +

+
+

+ ASIO_HAS_CSTDINT +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_CXX11_ALLOCATORS +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_DECLTYPE +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_DEFAULT_FUNCTION_TEMPLATE_ARGUMENTS +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_DEV_POLL +

+ 		+

+ Solaris: /dev/poll. +

+ 		+

+ ASIO_DISABLE_DEV_POLL +

+
+

+ ASIO_HAS_ENUM_CLASS +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_EPOLL +

+ 		+

+ Linux: epoll, eventfd, timerfd and io_uring. +

+ 		+

+ ASIO_DISABLE_EPOLL +

+
+

+ ASIO_HAS_EVENTFD +

+ 		+

+ Linux: epoll, eventfd, timerfd and io_uring. +

+ 		+

+ ASIO_DISABLE_EVENTFD +

+
+

+ ASIO_HAS_FILE +

+ 		+

+ Files. +

+ 		+

+ ASIO_DISABLE_FILE +

+
+

+ ASIO_HAS_GETADDRINFO +

+ 		+

+ Can use getaddrinfo() and getnameinfo(). +

+ 		+

+ ASIO_DISABLE_GETADDRINFO +

+
+

+ ASIO_HAS_HANDLER_HOOKS +

+ 		+

+ Handler hooking. Disabled for ancient Borland C++ and gcc compilers. +

+ 		+

+ ASIO_DISABLE_HANDLER_HOOKS +

+
+

+ ASIO_HAS_IOCP +

+ 		+

+ Windows: IO Completion Ports. +

+ 		+

+ ASIO_DISABLE_IOCP +

+
+

+ ASIO_HAS_IO_URING_AS_DEFAULT +

+ 		+

+ Linux: io_uring is used instead of epoll. +

+ 		+
+

+ ASIO_HAS_KQUEUE +

+ 		+

+ Mac OS X, FreeBSD, NetBSD, OpenBSD: kqueue. +

+ 		+

+ ASIO_DISABLE_KQUEUE +

+
+

+ ASIO_HAS_LOCAL_SOCKETS +

+ 		+

+ UNIX domain sockets. +

+ 		+

+ ASIO_DISABLE_LOCAL_SOCKETS +

+
+

+ ASIO_HAS_MOVE +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_MSG_NOSIGNAL +

+ 		+

+ Kernel support for MSG_NOSIGNAL. +

+ 		+
+

+ ASIO_HAS_NOEXCEPT +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_NOEXCEPT_FUNCTION_TYPE +

+ 		+

+ Support noexcept on function types on compilers known to allow it. +

+ 		+

+ ASIO_DISABLE_NOEXCEPT_FUNCTION_TYPE +

+
+

+ ASIO_HAS_NULLPTR +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_PIPE +

+ 		+

+ Pipes. +

+ 		+

+ ASIO_DISABLE_PIPE +

+
+

+ ASIO_HAS_POSIX_STREAM_DESCRIPTOR +

+ 		+

+ POSIX: stream-oriented file descriptors. +

+ 		+

+ ASIO_DISABLE_POSIX_STREAM_DESCRIPTOR +

+
+

+ ASIO_HAS_PTHREADS +

+ 		+

+ POSIX threads. +

+ 		+
+

+ ASIO_HAS_REF_QUALIFIED_FUNCTIONS +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_RETURN_TYPE_DEDUCTION +

+ 		+

+ Support return type deduction on compilers known to allow it. +

+ 		+

+ ASIO_DISABLE_RETURN_TYPE_DEDUCTION +

+
+

+ ASIO_HAS_SECURE_RTL +

+ 		+

+ Microsoft Visual C++'s secure C runtime library. +

+ 		+

+ ASIO_DISABLE_SECURE_RTL +

+
+

+ ASIO_HAS_SERIAL_PORT +

+ 		+

+ Serial ports. +

+ 		+

+ ASIO_DISABLE_SERIAL_PORT +

+
+

+ ASIO_HAS_SFINAE_VARIABLE_TEMPLATES +

+ 		+

+ Support SFINAEd template variables on compilers known to allow it. +

+ 		+

+ ASIO_DISABLE_SFINAE_VARIABLE_TEMPLATES +

+
+

+ ASIO_HAS_SIGACTION +

+ 		+

+ Can use sigaction() instead of signal(). +

+ 		+

+ ASIO_DISABLE_SIGACTION +

+
+

+ ASIO_HAS_SIGNAL +

+ 		+

+ Can use signal(). +

+ 		+

+ ASIO_DISABLE_SIGNAL +

+
+

+ ASIO_HAS_SNPRINTF +

+ 		+

+ Standard library support for snprintf. +

+ 		+

+ ASIO_DISABLE_SNPRINTF +

+
+

+ ASIO_HAS_SOURCE_LOCATION +

+ 		+

+ Standard library has a source_location that we can use. +

+ 		+

+ ASIO_DISABLE_SOURCE_LOCATION +

+
+

+ ASIO_HAS_SSIZE_T +

+ 		+

+ Support for POSIX ssize_t typedef. +

+ 		+

+ ASIO_DISABLE_SSIZE_T +

+
+

+ ASIO_HAS_STD_ADDRESSOF +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_ALIGN +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_ALIGNED_ALLOC +

+ 		+

+ Standard library support for aligned allocation. +

+ 		+

+ ASIO_DISABLE_STD_ALIGNED_ALLOC +

+
+

+ ASIO_HAS_STD_ALLOCATOR_ARG +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_ANY +

+ 		+

+ Standard library support for std::any. +

+ 		+

+ ASIO_DISABLE_STD_ANY +

+
+

+ ASIO_HAS_STD_ARRAY +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_ATOMIC +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_CALL_ONCE +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_CHRONO +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_CONCEPTS +

+ 		+

+ Support concepts on compilers known to allow them. +

+ 		+

+ ASIO_DISABLE_STD_CONCEPTS +

+
+

+ ASIO_HAS_STD_COROUTINE +

+ 		+

+ Standard library support for coroutines. +

+ 		+

+ ASIO_DISABLE_STD_COROUTINE +

+
+

+ ASIO_HAS_STD_EXCEPTION_PTR +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_EXPERIMENTAL_SOURCE_LOCATION +

+ 		+

+ Standard library support for std::experimental::source_location. +

+ 		+

+ ASIO_DISABLE_STD_EXPERIMENTAL_SOURCE_LOCATION +

+
+

+ ASIO_HAS_STD_EXPERIMENTAL_STRING_VIEW +

+ 		+

+ Standard library support for std::experimental::string_view. +

+ 		+

+ ASIO_DISABLE_STD_EXPERIMENTAL_STRING_VIEW +

+
+

+ ASIO_HAS_STD_FUNCTION +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_FUTURE +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_HASH +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_INDEX_SEQUENCE +

+ 		+

+ Standard library support for std::index_sequence. +

+ 		+

+ ASIO_DISABLE_STD_INDEX_SEQUENCE +

+
+

+ ASIO_HAS_STD_INVOKE_RESULT +

+ 		+

+ Standard library has invoke_result (which supersedes result_of). +

+ 		+

+ ASIO_DISABLE_STD_INVOKE_RESULT +

+
+

+ ASIO_HAS_STD_IOSTREAM_MOVE +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_MUTEX_AND_CONDVAR +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_NESTED_EXCEPTION +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_REFERENCE_WRAPPER +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_SHARED_PTR +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_STRING_VIEW +

+ 		+

+ Standard library support for std::string_view. +

+ 		+

+ ASIO_DISABLE_STD_STRING_VIEW +

+
+

+ ASIO_HAS_STD_SYSTEM_ERROR +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_THREAD +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_TO_ADDRESS +

+ 		+

+ Standard library support for std::to_address. +

+ 		+

+ ASIO_DISABLE_STD_TO_ADDRESS +

+
+

+ ASIO_HAS_STD_TUPLE +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_TYPE_TRAITS +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_STD_VARIANT +

+ 		+

+ Standard library support for std::variant. +

+ 		+

+ ASIO_DISABLE_STD_VARIANT +

+
+

+ ASIO_HAS_STRING_VIEW +

+ 		+

+ Standard library has a string_view that we can use. +

+ 		+

+ ASIO_DISABLE_STRING_VIEW +

+
+

+ ASIO_HAS_THREADS +

+ 		+

+ Threads. +

+ 		+

+ ASIO_DISABLE_THREADS +

+
+

+ ASIO_HAS_THREAD_KEYWORD_EXTENSION +

+ 		+

+ Support for the __thread keyword extension, or equivalent. +

+ 		+

+ ASIO_DISABLE_THREAD_KEYWORD_EXTENSION +

+
+

+ ASIO_HAS_TIMERFD +

+ 		+

+ Linux: epoll, eventfd, timerfd and io_uring. +

+ 		+
+

+ ASIO_HAS_UNISTD_H +

+ 		+

+ On POSIX (and POSIX-like) platforms we need to include unistd.h in + order to get access to the various platform feature macros, e.g. + to be able to test for threads support. +

+ 		+
+

+ ASIO_HAS_USER_DEFINED_LITERALS +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_VARIABLE_TEMPLATES +

+ 		+

+ Support template variables on compilers known to allow it. +

+ 		+

+ ASIO_DISABLE_VARIABLE_TEMPLATES +

+
+

+ ASIO_HAS_VARIADIC_LAMBDA_CAPTURES +

+ 		+

+ Support for capturing parameter packs in lambdas. +

+ 		+

+ ASIO_DISABLE_VARIADIC_LAMBDA_CAPTURES +

+
+

+ ASIO_HAS_VARIADIC_TEMPLATES +

+ 		+

+ Always enabled. Retained for backwards compatibility in user code. +

+ 		+
+

+ ASIO_HAS_WINDOWS_OBJECT_HANDLE +

+ 		+

+ Windows: object handles. +

+ 		+

+ ASIO_DISABLE_WINDOWS_OBJECT_HANDLE +

+
+

+ ASIO_HAS_WINDOWS_OVERLAPPED_PTR +

+ 		+

+ Windows: OVERLAPPED wrapper. +

+ 		+

+ ASIO_DISABLE_WINDOWS_OVERLAPPED_PTR +

+
+

+ ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE +

+ 		+

+ Windows: random access handles. +

+ 		+

+ ASIO_DISABLE_WINDOWS_RANDOM_ACCESS_HANDLE +

+
+

+ ASIO_HAS_WINDOWS_STREAM_HANDLE +

+ 		+

+ Windows: stream handles. +

+ 		+

+ ASIO_DISABLE_WINDOWS_STREAM_HANDLE +

+
+

+ ASIO_HAS_WORKING_EXPRESSION_SFINAE +

+ 		+

+ Enable workarounds for lack of working expression SFINAE. +

+ 		+

+ ASIO_DISABLE_WORKING_EXPRESSION_SFINAE +

+
+

+ + Mailing + List +

+

+ A mailing list specifically for Asio may be found on SourceForge.net. + Newsgroup access is provided via Gmane. +

+
+
Copyright © 2003-2025 Christopher M. + Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/Packages/asio-1.36.0/doc/async_agent_chain.png b/Packages/asio-1.36.0/doc/async_agent_chain.png new file mode 100644 index 0000000..639d227 Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_agent_chain.png differ diff --git a/Packages/asio-1.36.0/doc/async_agent_model.png b/Packages/asio-1.36.0/doc/async_agent_model.png new file mode 100644 index 0000000..befb8e4 Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_agent_model.png differ diff --git a/Packages/asio-1.36.0/doc/async_child_agent_chain.png b/Packages/asio-1.36.0/doc/async_child_agent_chain.png new file mode 100644 index 0000000..4ffebf4 Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_child_agent_chain.png differ diff --git a/Packages/asio-1.36.0/doc/async_op1.png b/Packages/asio-1.36.0/doc/async_op1.png new file mode 100644 index 0000000..1151be6 Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_op1.png differ diff --git a/Packages/asio-1.36.0/doc/async_op2.png b/Packages/asio-1.36.0/doc/async_op2.png new file mode 100644 index 0000000..cf7cb43 Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_op2.png differ diff --git a/Packages/asio-1.36.0/doc/async_op_init_complete.png b/Packages/asio-1.36.0/doc/async_op_init_complete.png new file mode 100644 index 0000000..516009a Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_op_init_complete.png differ diff --git a/Packages/asio-1.36.0/doc/async_op_model.png b/Packages/asio-1.36.0/doc/async_op_model.png new file mode 100644 index 0000000..408bd84 Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_op_model.png differ diff --git a/Packages/asio-1.36.0/doc/async_op_phases.png b/Packages/asio-1.36.0/doc/async_op_phases.png new file mode 100644 index 0000000..6680bdc Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_op_phases.png differ diff --git a/Packages/asio-1.36.0/doc/async_op_trivial_chain.png b/Packages/asio-1.36.0/doc/async_op_trivial_chain.png new file mode 100644 index 0000000..a69cc86 Binary files /dev/null and b/Packages/asio-1.36.0/doc/async_op_trivial_chain.png differ diff --git a/Packages/asio-1.36.0/doc/blank.png b/Packages/asio-1.36.0/doc/blank.png new file mode 100644 index 0000000..764bf4f Binary files /dev/null and b/Packages/asio-1.36.0/doc/blank.png differ diff --git a/Packages/asio-1.36.0/doc/boostbook.css b/Packages/asio-1.36.0/doc/boostbook.css new file mode 100644 index 0000000..2831765 --- /dev/null +++ b/Packages/asio-1.36.0/doc/boostbook.css @@ -0,0 +1,789 @@ + +/*============================================================================= +Copyright (c) 2004 Joel de Guzman +http://spirit.sourceforge.net/ + +Copyright 2013 Niall Douglas additions for colors and alignment. +Copyright 2013 Paul A. Bristow additions for more colors and alignments. +Copyright 2017 Tom Westerhout font fixes to support Sphinx + +Distributed under the Boost Software License, Version 1.0. (See accompany- +ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +=============================================================================*/ + +/*============================================================================= +Body defaults +=============================================================================*/ + + body + { + margin: 1em; + font-size: 16px; + font-family: sans-serif; + } + +/*============================================================================= +Paragraphs +=============================================================================*/ + + p, div.document, div.footer + { + text-align: left; + font-size: 10pt; + line-height: 1.15; + } + +/*============================================================================= +Program listings +=============================================================================*/ + + /* Code on paragraphs */ + p tt.computeroutput + { + font-size: 9pt; + } + + pre.synopsis + { + font-size: 9pt; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + div.highlight, + .programlisting, + .screen + { + font-size: 9pt; + display: block; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + /* Program listings in tables don't get borders */ + td .programlisting, + td .screen + { + margin: 0pc 0pc 0pc 0pc; + padding: 0pc 0pc 0pc 0pc; + } + +/*============================================================================= +Headings +=============================================================================*/ + + h1, h2, h3, h4, h5, h6 + { + text-align: left; + margin: 1em 0em 0.5em 0em; + font-weight: bold; + } + + h1 { font-size: 140%; } + h2 { font-weight: bold; font-size: 140%; } + h3 { font-weight: bold; font-size: 130%; } + h4 { font-weight: bold; font-size: 120%; } + h5 { font-weight: normal; font-style: italic; font-size: 110%; } + h6 { font-weight: normal; font-style: italic; font-size: 100%; } + + /* Top page titles */ + title, + h1.title, + h2.title + h3.title, + h4.title, + h5.title, + h6.title, + .refentrytitle + { + font-weight: bold; + margin-bottom: 1pc; + } + + h1.title { font-size: 140% } + h2.title { font-size: 140% } + h3.title { font-size: 130% } + h4.title { font-size: 120% } + h5.title { font-size: 110% } + h6.title { font-size: 100% } + + .section h1 + { + margin: 0em 0em 0.5em 0em; + font-size: 140%; + } + + .section h2 { font-size: 140% } + .section h3 { font-size: 130% } + .section h4 { font-size: 120% } + .section h5 { font-size: 110% } + .section h6 { font-size: 100% } + + /* Code on titles */ + h1 tt.computeroutput { font-size: 140% } + h2 tt.computeroutput { font-size: 140% } + h3 tt.computeroutput { font-size: 130% } + h4 tt.computeroutput { font-size: 130% } + h5 tt.computeroutput { font-size: 130% } + h6 tt.computeroutput { font-size: 130% } + + +/*============================================================================= +Author +=============================================================================*/ + + h3.author + { + font-size: 100% + } + +/*============================================================================= +Lists +=============================================================================*/ + + li + { + font-size: 10pt; + line-height: 1.3; + } + + /* Unordered lists */ + ul + { + text-align: left; + } + + /* Ordered lists */ + ol + { + text-align: left; + } + +/*============================================================================= +Links +=============================================================================*/ + + a + { + text-decoration: none; /* no underline */ + } + + a:hover + { + text-decoration: underline; + } + +/*============================================================================= +Spirit style navigation +=============================================================================*/ + + .spirit-nav + { + text-align: right; + } + + .spirit-nav a + { + color: white; + padding-left: 0.5em; + } + + .spirit-nav img + { + border-width: 0px; + } + +/*============================================================================= +Copyright footer +=============================================================================*/ + .copyright-footer + { + text-align: right; + font-size: 70%; + } + + .copyright-footer p + { + text-align: right; + font-size: 80%; + } + +/*============================================================================= +Table of contents +=============================================================================*/ + + div.toc + { + margin: 1pc 4% 0pc 4%; + padding: 0.1pc 1pc 0.1pc 1pc; + font-size: 80%; + line-height: 1.15; + } + + .boost-toc + { + float: right; + padding: 0.5pc; + } + + /* Code on toc */ + .toc .computeroutput { font-size: 120% } + + /* No margin on nested menus */ + + .toc dl dl { margin: 0; } + +/*============================================================================= +Tables +=============================================================================*/ + + .table-title, + div.table p.title + { + margin-left: 4%; + padding-right: 0.5em; + padding-left: 0.5em; + } + + .informaltable table, + .table table + { + width: 92%; + margin-left: 4%; + margin-right: 4%; + } + + div.informaltable table, + div.table table + { + padding: 4px; + } + + /* Table Cells */ + div.informaltable table tr td, + div.table table tr td + { + padding: 0.5em; + text-align: left; + font-size: 9pt; + } + + div.informaltable table tr th, + div.table table tr th + { + padding: 0.5em 0.5em 0.5em 0.5em; + border: 1pt solid white; + font-size: 80%; + } + + table.simplelist + { + width: auto !important; + margin: 0em !important; + padding: 0em !important; + border: none !important; + } + table.simplelist td + { + margin: 0em !important; + padding: 0em !important; + text-align: left !important; + font-size: 9pt !important; + border: none !important; + } + +/*============================================================================= +Suppress margins in tables +=============================================================================*/ + + table th > *:first-child, + table td > *:first-child + { + margin-top: 0; + } + + table th > *:last-child, + table td > *:last-child + { + margin-bottom: 0; + } + +/*============================================================================= +Blurbs +=============================================================================*/ + + div.note, + div.tip, + div.important, + div.caution, + div.warning, + div.blurb, + p.blurb + { + font-size: 9pt; /* A little bit smaller than the main text */ + line-height: 1.2; + display: block; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + div.blurb img, + p.blurb img + { + padding: 1pt; + } + +/*============================================================================= +Variable Lists +=============================================================================*/ + + div.variablelist + { + margin: 1em 0; + } + + /* Make the terms in definition lists bold */ + div.variablelist dl dt, + span.term + { + font-weight: bold; + font-size: 10pt; + } + + div.variablelist table tbody tr td + { + text-align: left; + vertical-align: top; + padding: 0em 2em 0em 0em; + font-size: 10pt; + margin: 0em 0em 0.5em 0em; + line-height: 1; + } + + div.variablelist dl dt + { + margin-bottom: 0.2em; + } + + div.variablelist dl dd + { + margin: 0em 0em 0.5em 2em; + font-size: 10pt; + } + + div.variablelist table tbody tr td p, + div.variablelist dl dd p + { + margin: 0em 0em 0.5em 0em; + line-height: 1; + } + +/*============================================================================= +Misc +=============================================================================*/ + + /* Title of books and articles in bibliographies */ + span.title + { + font-style: italic; + } + + span.underline + { + text-decoration: underline; + } + + span.strikethrough + { + text-decoration: line-through; + } + + /* Copyright, Legal Notice */ + div div.legalnotice p + { + text-align: left + } + +/*============================================================================= +Colors +=============================================================================*/ + + @media screen + { + body { + background-color: #FFFFFF; + color: #000000; + } + + /* Syntax Highlighting */ + .property, + .highlight .k, + .highlight .kc, + .highlight .kd, + .highlight .kn, + .highlight .kp, + .highlight .kr, + .highlight .kt, + .keyword { color: #0000AA; } + + .highlight .n, + .highlight .na, + .highlight .nb, + .highlight .bp, + .highlight .nc, + .highlight .no, + .highlight .nd, + .highlight .ni, + .highlight .ne, + .highlight .nf, + .highlight .py, + .highlight .nl, + .highlight .nn, + .highlight .nx, + .highlight .nt, + .highlight .nv, + .highlight .vc, + .highlight .vg, + .highlight .vi, + .identifier { color: #000000; } + + .special { color: #707070; } + + .highlight .cp, + .preprocessor { color: #402080; } + + .highlight .sc + .char { color: teal; } + + .highlight .c, + .highlight .ch, + .highlight .cm, + .highlight .cp, + .highlight .cpf, + .highlight .c1, + .highlight .cs, + .highlight .sd, + .highlight .sh, + .comment { color: #800000; } + + .highlight .s, + .highlight .sa, + .highlight .sb, + .highlight .dl, + .highlight .s2, + .highlight .se, + .highlight .si, + .highlight .sx, + .highlight .sr, + .highlight .s1, + .highlight .ss, + .string { color: teal; } + + .highlight .m, + .highlight .mf, + .highlight .mh, + .highlight .mi, + .highlight .mo, + .number { color: teal; } + + .highlight, + .white_bkd { background-color: #FFFFFF; } + + .highlight .hll, + .dk_grey_bkd { background-color: #999999; } + + /* Links */ + a, a .keyword, a .identifier, a .special, a .preprocessor + a .char, a .comment, a .string, a .number + { + color: #005a9c; + } + + a:visited, a:visited .keyword, a:visited .identifier, + a:visited .special, a:visited .preprocessor a:visited .char, + a:visited .comment, a:visited .string, a:visited .number + { + color: #9c5a9c; + } + + h1 a, h2 a, h3 a, h4 a, h5 a, h6 a, + h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover, + h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited + { + text-decoration: none; /* no underline */ + color: #000000; + } + + /* Copyright, Legal Notice */ + .copyright + { + color: #666666; + font-size: small; + } + + div div.legalnotice p + { + color: #666666; + } + + /* Program listing */ + pre.synopsis + { + border: 1px solid #DCDCDC; + } + + div.highlight, + .programlisting, + .screen + { + border: 1px solid #DCDCDC; + } + + td .programlisting, + td .screen + { + border: 0px solid #DCDCDC; + } + + /* Blurbs */ + div.note, + div.tip, + div.important, + div.caution, + div.warning, + div.blurb, + p.blurb + { + border: 1px solid #DCDCDC; + } + + /* Table of contents */ + div.toc + { + border: 1px solid #DCDCDC; + } + + /* Tables */ + div.informaltable table tr td, + div.table table tr td + { + border: 1px solid #DCDCDC; + } + + div.informaltable table tr th, + div.table table tr th + { + background-color: #F0F0F0; + border: 1px solid #DCDCDC; + } + + .copyright-footer + { + color: #8F8F8F; + } + + /* Misc */ + span.highlight + { + color: #00A000; + } + } + + @media print + { + /* Links */ + a + { + color: black; + } + + a:visited + { + color: black; + } + + .spirit-nav + { + display: none; + } + + /* Program listing */ + pre.synopsis + { + border: 1px solid gray; + } + + div.highlight, + .programlisting, + .screen + { + border: 1px solid gray; + } + + td .programlisting, + td .screen + { + border: 0px solid #DCDCDC; + } + + /* Table of contents */ + div.toc + { + border: 1px solid gray; + } + + .informaltable table, + .table table + { + border: 1px solid gray; + border-collapse: collapse; + } + + /* Tables */ + div.informaltable table tr td, + div.table table tr td + { + border: 1px solid gray; + } + + div.informaltable table tr th, + div.table table tr th + { + border: 1px solid gray; + } + + table.simplelist tr td + { + border: none !important; + } + + /* Misc */ + span.highlight + { + font-weight: bold; + } + } + +/*============================================================================= +Images +=============================================================================*/ + + span.inlinemediaobject img + { + vertical-align: middle; + } + +/*============================================================================== +Super and Subscript: style so that line spacing isn't effected, see +http://www.adobe.com/cfusion/communityengine/index.cfm?event=showdetails&productId=1&postId=5341 +==============================================================================*/ + +sup, +sub { +height: 0; +line-height: 1; +vertical-align: baseline; +position: relative; + +} + +/* For internet explorer: */ + +* html sup, +* html sub { +vertical-align: bottom; +} + +sup { +bottom: 1ex; +} + +sub { +top: .5ex; +} + +/*============================================================================== +Indexes: pretty much the same as the TOC. +==============================================================================*/ + + .index + { + font-size: 80%; + padding-top: 0px; + padding-bottom: 0px; + margin-top: 0px; + margin-bottom: 0px; + margin-left: 0px; + } + + .index ul + { + padding-left: 3em; + } + + .index p + { + padding: 2px; + margin: 2px; + } + + .index-entry-level-0 + { + font-weight: bold; + } + + .index em + { + font-weight: bold; + } + + +/*============================================================================== +Alignment and coloring use 'role' feature, available from Quickbook 1.6 up. +Added from Niall Douglas for role color and alignment. +http://article.gmane.org/gmane.comp.lib.boost.devel/243318 +*/ + +/* Add text alignment (see http://www.w3schools.com/cssref/pr_text_text-align.asp) */ +span.aligncenter +{ + display: inline-block; width: 100%; text-align: center; +} +span.alignright +{ + display: inline-block; width: 100%; text-align: right; +} +/* alignleft is the default. */ +span.alignleft +{ + display: inline-block; width: 100%; text-align: left; +} + +/* alignjustify stretches the word spacing so that each line has equal width +within a chosen fraction of page width (here arbitrarily 20%). +*Not* useful inside table items as the column width remains the total string width. +Nor very useful, except to temporarily restrict the width. +*/ +span.alignjustify +{ + display: inline-block; width: 20%; text-align: justify; +} + +/* Text colors. +Names at http://www.w3.org/TR/2002/WD-css3-color-20020219/ 4.3. X11 color keywords. +Quickbook Usage: [role red Some red text] + +*/ +span.red { inline-block; color: red; } +span.green { color: green; } +span.lime { color: #00FF00; } +span.blue { color: blue; } +span.navy { color: navy; } +span.yellow { color: yellow; } +span.magenta { color: magenta; } +span.indigo { color: #4B0082; } +span.cyan { color: cyan; } +span.purple { color: purple; } +span.gold { color: gold; } +span.silver { color: silver; } /* lighter gray */ +span.gray { color: #808080; } /* light gray */ diff --git a/Packages/asio-1.36.0/doc/caution.png b/Packages/asio-1.36.0/doc/caution.png new file mode 100644 index 0000000..5b7809c Binary files /dev/null and b/Packages/asio-1.36.0/doc/caution.png differ diff --git a/Packages/asio-1.36.0/doc/completion_token_model.png b/Packages/asio-1.36.0/doc/completion_token_model.png new file mode 100644 index 0000000..a7728d1 Binary files /dev/null and b/Packages/asio-1.36.0/doc/completion_token_model.png differ diff --git a/Packages/asio-1.36.0/doc/completion_token_transform.png b/Packages/asio-1.36.0/doc/completion_token_transform.png new file mode 100644 index 0000000..b90b2a5 Binary files /dev/null and b/Packages/asio-1.36.0/doc/completion_token_transform.png differ diff --git a/Packages/asio-1.36.0/doc/draft.png b/Packages/asio-1.36.0/doc/draft.png new file mode 100644 index 0000000..0084708 Binary files /dev/null and b/Packages/asio-1.36.0/doc/draft.png differ diff --git a/Packages/asio-1.36.0/doc/higher_level_model.png b/Packages/asio-1.36.0/doc/higher_level_model.png new file mode 100644 index 0000000..e74d16b Binary files /dev/null and b/Packages/asio-1.36.0/doc/higher_level_model.png differ diff --git a/Packages/asio-1.36.0/doc/home.png b/Packages/asio-1.36.0/doc/home.png new file mode 100644 index 0000000..5584aac Binary files /dev/null and b/Packages/asio-1.36.0/doc/home.png differ diff --git a/Packages/asio-1.36.0/doc/important.png b/Packages/asio-1.36.0/doc/important.png new file mode 100644 index 0000000..12c90f6 Binary files /dev/null and b/Packages/asio-1.36.0/doc/important.png differ diff --git a/Packages/asio-1.36.0/doc/index.html b/Packages/asio-1.36.0/doc/index.html new file mode 100644 index 0000000..f935123 --- /dev/null +++ b/Packages/asio-1.36.0/doc/index.html @@ -0,0 +1,85 @@ + + + +Asio + + + + + + + +
asio C++ library
+
+
Next
+
+
+

+Asio

+

Copyright © 2003-2025 Christopher M. + Kohlhoff

+
+

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+

+ Asio is a cross-platform C++ library for network and low-level I/O programming + that provides developers with a consistent asynchronous model using a modern + C++ approach. +

+
+

+
+
Overview
+

+ An overview of the features included in Asio, plus rationale and design + information. +

+
Using, Building, and Configuring Asio +
+

+ How to use Asio in your applications. Includes information on library dependencies + and supported platforms. +

+
Tutorial
+

+ A tutorial that introduces the fundamental concepts required to use Asio, + and shows how to use Asio to develop simple client and server programs. +

+
Examples
+

+ Examples that illustrate the use of Asio in more complex applications. +

+
Reference
+

+ Detailed class and function reference. +

+
Networking TS Compatibility
+

+ Description of changes to provide compatibility with the "C++ Extensions + for Networking" Technical Specification. +

+
Proposed Standard Executors +
+

+ Description of Asio's support for the proposed standard executors library. +

+
Revision History
+

+ Log of Asio changes made in each release. +

+
Index
+

+ Book-style text index of Asio documentation. +

+
+
+
+
+
+
Next
+ + diff --git a/Packages/asio-1.36.0/doc/next.png b/Packages/asio-1.36.0/doc/next.png new file mode 100644 index 0000000..59800b4 Binary files /dev/null and b/Packages/asio-1.36.0/doc/next.png differ diff --git a/Packages/asio-1.36.0/doc/next_disabled.png b/Packages/asio-1.36.0/doc/next_disabled.png new file mode 100644 index 0000000..10a8c59 Binary files /dev/null and b/Packages/asio-1.36.0/doc/next_disabled.png differ diff --git a/Packages/asio-1.36.0/doc/note.png b/Packages/asio-1.36.0/doc/note.png new file mode 100644 index 0000000..d0c3c64 Binary files /dev/null and b/Packages/asio-1.36.0/doc/note.png differ diff --git a/Packages/asio-1.36.0/doc/prev.png b/Packages/asio-1.36.0/doc/prev.png new file mode 100644 index 0000000..d88a40f Binary files /dev/null and b/Packages/asio-1.36.0/doc/prev.png differ diff --git a/Packages/asio-1.36.0/doc/prev_disabled.png b/Packages/asio-1.36.0/doc/prev_disabled.png new file mode 100644 index 0000000..ab3c17e Binary files /dev/null and b/Packages/asio-1.36.0/doc/prev_disabled.png differ diff --git a/Packages/asio-1.36.0/doc/proactor.png b/Packages/asio-1.36.0/doc/proactor.png new file mode 100644 index 0000000..a0653b0 Binary files /dev/null and b/Packages/asio-1.36.0/doc/proactor.png differ diff --git a/Packages/asio-1.36.0/doc/sync_op.png b/Packages/asio-1.36.0/doc/sync_op.png new file mode 100644 index 0000000..baa5a56 Binary files /dev/null and b/Packages/asio-1.36.0/doc/sync_op.png differ diff --git a/Packages/asio-1.36.0/doc/tip.png b/Packages/asio-1.36.0/doc/tip.png new file mode 100644 index 0000000..5c4aab3 Binary files /dev/null and b/Packages/asio-1.36.0/doc/tip.png differ diff --git a/Packages/asio-1.36.0/doc/up.png b/Packages/asio-1.36.0/doc/up.png new file mode 100644 index 0000000..17d9c3e Binary files /dev/null and b/Packages/asio-1.36.0/doc/up.png differ diff --git a/Packages/asio-1.36.0/doc/up_disabled.png b/Packages/asio-1.36.0/doc/up_disabled.png new file mode 100644 index 0000000..e22bc87 Binary files /dev/null and b/Packages/asio-1.36.0/doc/up_disabled.png differ diff --git a/Packages/asio-1.36.0/doc/warning.png b/Packages/asio-1.36.0/doc/warning.png new file mode 100644 index 0000000..1c33db8 Binary files /dev/null and b/Packages/asio-1.36.0/doc/warning.png differ diff --git a/Packages/asio-1.36.0/include/Makefile.am b/Packages/asio-1.36.0/include/Makefile.am new file mode 100644 index 0000000..d841e8a --- /dev/null +++ b/Packages/asio-1.36.0/include/Makefile.am @@ -0,0 +1,632 @@ +# find . -name "*.*pp" | sed -e 's/^\.\///' | sed -e 's/^.*$/ & \\/' | sort +nobase_include_HEADERS = \ + asio/any_completion_executor.hpp \ + asio/any_completion_handler.hpp \ + asio/any_io_executor.hpp \ + asio/append.hpp \ + asio/as_tuple.hpp \ + asio/associated_allocator.hpp \ + asio/associated_cancellation_slot.hpp \ + asio/associated_executor.hpp \ + asio/associated_immediate_executor.hpp \ + asio/associator.hpp \ + asio/async_result.hpp \ + asio/awaitable.hpp \ + asio/basic_datagram_socket.hpp \ + asio/basic_deadline_timer.hpp \ + asio/basic_file.hpp \ + asio/basic_io_object.hpp \ + asio/basic_random_access_file.hpp \ + asio/basic_raw_socket.hpp \ + asio/basic_readable_pipe.hpp \ + asio/basic_seq_packet_socket.hpp \ + asio/basic_serial_port.hpp \ + asio/basic_signal_set.hpp \ + asio/basic_socket_acceptor.hpp \ + asio/basic_socket.hpp \ + asio/basic_socket_iostream.hpp \ + asio/basic_socket_streambuf.hpp \ + asio/basic_streambuf_fwd.hpp \ + asio/basic_streambuf.hpp \ + asio/basic_stream_file.hpp \ + asio/basic_stream_socket.hpp \ + asio/basic_waitable_timer.hpp \ + asio/basic_writable_pipe.hpp \ + asio/bind_allocator.hpp \ + asio/bind_cancellation_slot.hpp \ + asio/bind_executor.hpp \ + asio/bind_immediate_executor.hpp \ + asio/buffered_read_stream_fwd.hpp \ + asio/buffered_read_stream.hpp \ + asio/buffered_stream_fwd.hpp \ + asio/buffered_stream.hpp \ + asio/buffered_write_stream_fwd.hpp \ + asio/buffered_write_stream.hpp \ + asio/buffer.hpp \ + asio/buffer_registration.hpp \ + asio/buffers_iterator.hpp \ + asio/cancel_after.hpp \ + asio/cancel_at.hpp \ + asio/cancellation_signal.hpp \ + asio/cancellation_state.hpp \ + asio/cancellation_type.hpp \ + asio/co_composed.hpp \ + asio/co_spawn.hpp \ + asio/completion_condition.hpp \ + asio/compose.hpp \ + asio/composed.hpp \ + asio/config.hpp \ + asio/connect.hpp \ + asio/connect_pipe.hpp \ + asio/consign.hpp \ + asio/coroutine.hpp \ + asio/deadline_timer.hpp \ + asio/defer.hpp \ + asio/deferred.hpp \ + asio/default_completion_token.hpp \ + asio/detached.hpp \ + asio/detail/array_fwd.hpp \ + asio/detail/array.hpp \ + asio/detail/assert.hpp \ + asio/detail/atomic_count.hpp \ + asio/detail/base_from_cancellation_state.hpp \ + asio/detail/base_from_completion_cond.hpp \ + asio/detail/bind_handler.hpp \ + asio/detail/blocking_executor_op.hpp \ + asio/detail/buffered_stream_storage.hpp \ + asio/detail/buffer_resize_guard.hpp \ + asio/detail/buffer_sequence_adapter.hpp \ + asio/detail/call_stack.hpp \ + asio/detail/chrono.hpp \ + asio/detail/chrono_time_traits.hpp \ + asio/detail/completion_handler.hpp \ + asio/detail/completion_message.hpp \ + asio/detail/completion_payload.hpp \ + asio/detail/completion_payload_handler.hpp \ + asio/detail/composed_work.hpp \ + asio/detail/concurrency_hint.hpp \ + asio/detail/conditionally_enabled_event.hpp \ + asio/detail/conditionally_enabled_mutex.hpp \ + asio/detail/config.hpp \ + asio/detail/consuming_buffers.hpp \ + asio/detail/cstddef.hpp \ + asio/detail/cstdint.hpp \ + asio/detail/date_time_fwd.hpp \ + asio/detail/deadline_timer_service.hpp \ + asio/detail/dependent_type.hpp \ + asio/detail/descriptor_ops.hpp \ + asio/detail/descriptor_read_op.hpp \ + asio/detail/descriptor_write_op.hpp \ + asio/detail/dev_poll_reactor.hpp \ + asio/detail/epoll_reactor.hpp \ + asio/detail/eventfd_select_interrupter.hpp \ + asio/detail/event.hpp \ + asio/detail/exception.hpp \ + asio/detail/executor_function.hpp \ + asio/detail/executor_op.hpp \ + asio/detail/fd_set_adapter.hpp \ + asio/detail/fenced_block.hpp \ + asio/detail/functional.hpp \ + asio/detail/future.hpp \ + asio/detail/global.hpp \ + asio/detail/handler_alloc_helpers.hpp \ + asio/detail/handler_cont_helpers.hpp \ + asio/detail/handler_tracking.hpp \ + asio/detail/handler_type_requirements.hpp \ + asio/detail/handler_work.hpp \ + asio/detail/hash_map.hpp \ + asio/detail/impl/buffer_sequence_adapter.ipp \ + asio/detail/impl/descriptor_ops.ipp \ + asio/detail/impl/dev_poll_reactor.hpp \ + asio/detail/impl/dev_poll_reactor.ipp \ + asio/detail/impl/epoll_reactor.hpp \ + asio/detail/impl/epoll_reactor.ipp \ + asio/detail/impl/eventfd_select_interrupter.ipp \ + asio/detail/impl/handler_tracking.ipp \ + asio/detail/impl/io_uring_descriptor_service.ipp \ + asio/detail/impl/io_uring_file_service.ipp \ + asio/detail/impl/io_uring_service.hpp \ + asio/detail/impl/io_uring_service.ipp \ + asio/detail/impl/io_uring_socket_service_base.ipp \ + asio/detail/impl/kqueue_reactor.hpp \ + asio/detail/impl/kqueue_reactor.ipp \ + asio/detail/impl/null_event.ipp \ + asio/detail/impl/pipe_select_interrupter.ipp \ + asio/detail/impl/posix_event.ipp \ + asio/detail/impl/posix_mutex.ipp \ + asio/detail/impl/posix_serial_port_service.ipp \ + asio/detail/impl/posix_thread.ipp \ + asio/detail/impl/posix_tss_ptr.ipp \ + asio/detail/impl/reactive_descriptor_service.ipp \ + asio/detail/impl/reactive_socket_service_base.ipp \ + asio/detail/impl/resolver_service_base.ipp \ + asio/detail/impl/resolver_thread_pool.ipp \ + asio/detail/impl/scheduler.ipp \ + asio/detail/impl/select_reactor.hpp \ + asio/detail/impl/select_reactor.ipp \ + asio/detail/impl/service_registry.hpp \ + asio/detail/impl/service_registry.ipp \ + asio/detail/impl/signal_set_service.ipp \ + asio/detail/impl/socket_ops.ipp \ + asio/detail/impl/socket_select_interrupter.ipp \ + asio/detail/impl/strand_executor_service.hpp \ + asio/detail/impl/strand_executor_service.ipp \ + asio/detail/impl/strand_service.hpp \ + asio/detail/impl/strand_service.ipp \ + asio/detail/impl/thread_context.ipp \ + asio/detail/impl/throw_error.ipp \ + asio/detail/impl/timer_queue_set.ipp \ + asio/detail/impl/win_event.ipp \ + asio/detail/impl/win_iocp_file_service.ipp \ + asio/detail/impl/win_iocp_handle_service.ipp \ + asio/detail/impl/win_iocp_io_context.hpp \ + asio/detail/impl/win_iocp_io_context.ipp \ + asio/detail/impl/win_iocp_serial_port_service.ipp \ + asio/detail/impl/win_iocp_socket_service_base.ipp \ + asio/detail/impl/win_mutex.ipp \ + asio/detail/impl/win_object_handle_service.ipp \ + asio/detail/impl/winrt_ssocket_service_base.ipp \ + asio/detail/impl/winrt_timer_scheduler.hpp \ + asio/detail/impl/winrt_timer_scheduler.ipp \ + asio/detail/impl/winsock_init.ipp \ + asio/detail/impl/win_static_mutex.ipp \ + asio/detail/impl/win_thread.ipp \ + asio/detail/impl/win_tss_ptr.ipp \ + asio/detail/initiate_defer.hpp \ + asio/detail/initiate_dispatch.hpp \ + asio/detail/initiate_post.hpp \ + asio/detail/initiation_base.hpp \ + asio/detail/io_control.hpp \ + asio/detail/io_object_impl.hpp \ + asio/detail/io_uring_descriptor_read_at_op.hpp \ + asio/detail/io_uring_descriptor_read_op.hpp \ + asio/detail/io_uring_descriptor_service.hpp \ + asio/detail/io_uring_descriptor_write_at_op.hpp \ + asio/detail/io_uring_descriptor_write_op.hpp \ + asio/detail/io_uring_file_service.hpp \ + asio/detail/io_uring_null_buffers_op.hpp \ + asio/detail/io_uring_operation.hpp \ + asio/detail/io_uring_service.hpp \ + asio/detail/io_uring_socket_accept_op.hpp \ + asio/detail/io_uring_socket_connect_op.hpp \ + asio/detail/io_uring_socket_recvfrom_op.hpp \ + asio/detail/io_uring_socket_recvmsg_op.hpp \ + asio/detail/io_uring_socket_recv_op.hpp \ + asio/detail/io_uring_socket_send_op.hpp \ + asio/detail/io_uring_socket_sendto_op.hpp \ + asio/detail/io_uring_socket_service_base.hpp \ + asio/detail/io_uring_socket_service.hpp \ + asio/detail/io_uring_wait_op.hpp \ + asio/detail/is_buffer_sequence.hpp \ + asio/detail/is_executor.hpp \ + asio/detail/keyword_tss_ptr.hpp \ + asio/detail/kqueue_reactor.hpp \ + asio/detail/limits.hpp \ + asio/detail/local_free_on_block_exit.hpp \ + asio/detail/memory.hpp \ + asio/detail/mutex.hpp \ + asio/detail/non_const_lvalue.hpp \ + asio/detail/noncopyable.hpp \ + asio/detail/null_event.hpp \ + asio/detail/null_fenced_block.hpp \ + asio/detail/null_global.hpp \ + asio/detail/null_mutex.hpp \ + asio/detail/null_reactor.hpp \ + asio/detail/null_signal_blocker.hpp \ + asio/detail/null_socket_service.hpp \ + asio/detail/null_static_mutex.hpp \ + asio/detail/null_thread.hpp \ + asio/detail/null_tss_ptr.hpp \ + asio/detail/object_pool.hpp \ + asio/detail/old_win_sdk_compat.hpp \ + asio/detail/operation.hpp \ + asio/detail/op_queue.hpp \ + asio/detail/pipe_select_interrupter.hpp \ + asio/detail/pop_options.hpp \ + asio/detail/posix_event.hpp \ + asio/detail/posix_fd_set_adapter.hpp \ + asio/detail/posix_global.hpp \ + asio/detail/posix_mutex.hpp \ + asio/detail/posix_serial_port_service.hpp \ + asio/detail/posix_signal_blocker.hpp \ + asio/detail/posix_static_mutex.hpp \ + asio/detail/posix_thread.hpp \ + asio/detail/posix_tss_ptr.hpp \ + asio/detail/push_options.hpp \ + asio/detail/reactive_descriptor_service.hpp \ + asio/detail/reactive_null_buffers_op.hpp \ + asio/detail/reactive_socket_accept_op.hpp \ + asio/detail/reactive_socket_connect_op.hpp \ + asio/detail/reactive_socket_recvfrom_op.hpp \ + asio/detail/reactive_socket_recvmsg_op.hpp \ + asio/detail/reactive_socket_recv_op.hpp \ + asio/detail/reactive_socket_send_op.hpp \ + asio/detail/reactive_socket_sendto_op.hpp \ + asio/detail/reactive_socket_service_base.hpp \ + asio/detail/reactive_socket_service.hpp \ + asio/detail/reactive_wait_op.hpp \ + asio/detail/reactor.hpp \ + asio/detail/reactor_op.hpp \ + asio/detail/reactor_op_queue.hpp \ + asio/detail/recycling_allocator.hpp \ + asio/detail/regex_fwd.hpp \ + asio/detail/resolve_endpoint_op.hpp \ + asio/detail/resolve_op.hpp \ + asio/detail/resolve_query_op.hpp \ + asio/detail/resolver_service_base.hpp \ + asio/detail/resolver_thread_pool.hpp \ + asio/detail/resolver_service.hpp \ + asio/detail/scheduler.hpp \ + asio/detail/scheduler_operation.hpp \ + asio/detail/scheduler_task.hpp \ + asio/detail/scheduler_thread_info.hpp \ + asio/detail/scoped_lock.hpp \ + asio/detail/scoped_ptr.hpp \ + asio/detail/select_interrupter.hpp \ + asio/detail/select_reactor.hpp \ + asio/detail/service_registry.hpp \ + asio/detail/signal_blocker.hpp \ + asio/detail/signal_handler.hpp \ + asio/detail/signal_init.hpp \ + asio/detail/signal_op.hpp \ + asio/detail/signal_set_service.hpp \ + asio/detail/socket_holder.hpp \ + asio/detail/socket_ops.hpp \ + asio/detail/socket_option.hpp \ + asio/detail/socket_select_interrupter.hpp \ + asio/detail/socket_types.hpp \ + asio/detail/source_location.hpp \ + asio/detail/static_mutex.hpp \ + asio/detail/std_event.hpp \ + asio/detail/std_fenced_block.hpp \ + asio/detail/std_global.hpp \ + asio/detail/std_mutex.hpp \ + asio/detail/std_static_mutex.hpp \ + asio/detail/std_thread.hpp \ + asio/detail/strand_executor_service.hpp \ + asio/detail/strand_service.hpp \ + asio/detail/string_view.hpp \ + asio/detail/thread_context.hpp \ + asio/detail/thread_group.hpp \ + asio/detail/thread.hpp \ + asio/detail/thread_info_base.hpp \ + asio/detail/throw_error.hpp \ + asio/detail/throw_exception.hpp \ + asio/detail/timed_cancel_op.hpp \ + asio/detail/timer_queue_base.hpp \ + asio/detail/timer_queue.hpp \ + asio/detail/timer_queue_set.hpp \ + asio/detail/timer_scheduler_fwd.hpp \ + asio/detail/timer_scheduler.hpp \ + asio/detail/tss_ptr.hpp \ + asio/detail/type_traits.hpp \ + asio/detail/utility.hpp \ + asio/detail/wait_handler.hpp \ + asio/detail/wait_op.hpp \ + asio/detail/winapp_thread.hpp \ + asio/detail/wince_thread.hpp \ + asio/detail/win_event.hpp \ + asio/detail/win_fd_set_adapter.hpp \ + asio/detail/win_global.hpp \ + asio/detail/win_iocp_file_service.hpp \ + asio/detail/win_iocp_handle_read_op.hpp \ + asio/detail/win_iocp_handle_service.hpp \ + asio/detail/win_iocp_handle_write_op.hpp \ + asio/detail/win_iocp_io_context.hpp \ + asio/detail/win_iocp_null_buffers_op.hpp \ + asio/detail/win_iocp_operation.hpp \ + asio/detail/win_iocp_overlapped_op.hpp \ + asio/detail/win_iocp_overlapped_ptr.hpp \ + asio/detail/win_iocp_serial_port_service.hpp \ + asio/detail/win_iocp_socket_accept_op.hpp \ + asio/detail/win_iocp_socket_connect_op.hpp \ + asio/detail/win_iocp_socket_recvfrom_op.hpp \ + asio/detail/win_iocp_socket_recvmsg_op.hpp \ + asio/detail/win_iocp_socket_recv_op.hpp \ + asio/detail/win_iocp_socket_send_op.hpp \ + asio/detail/win_iocp_socket_service_base.hpp \ + asio/detail/win_iocp_socket_service.hpp \ + asio/detail/win_iocp_thread_info.hpp \ + asio/detail/win_iocp_wait_op.hpp \ + asio/detail/win_mutex.hpp \ + asio/detail/win_object_handle_service.hpp \ + asio/detail/winrt_async_manager.hpp \ + asio/detail/winrt_async_op.hpp \ + asio/detail/winrt_resolve_op.hpp \ + asio/detail/winrt_resolver_service.hpp \ + asio/detail/winrt_socket_connect_op.hpp \ + asio/detail/winrt_socket_recv_op.hpp \ + asio/detail/winrt_socket_send_op.hpp \ + asio/detail/winrt_ssocket_service_base.hpp \ + asio/detail/winrt_ssocket_service.hpp \ + asio/detail/winrt_timer_scheduler.hpp \ + asio/detail/winrt_utils.hpp \ + asio/detail/winsock_init.hpp \ + asio/detail/win_static_mutex.hpp \ + asio/detail/win_thread.hpp \ + asio/detail/win_tss_ptr.hpp \ + asio/detail/work_dispatcher.hpp \ + asio/detail/wrapped_handler.hpp \ + asio/dispatch.hpp \ + asio/disposition.hpp \ + asio/error_code.hpp \ + asio/error.hpp \ + asio/execution.hpp \ + asio/execution_context.hpp \ + asio/execution/allocator.hpp \ + asio/execution/any_executor.hpp \ + asio/execution/bad_executor.hpp \ + asio/execution/blocking.hpp \ + asio/execution/blocking_adaptation.hpp \ + asio/execution/context.hpp \ + asio/execution/context_as.hpp \ + asio/execution/executor.hpp \ + asio/execution/impl/bad_executor.ipp \ + asio/execution/invocable_archetype.hpp \ + asio/execution/mapping.hpp \ + asio/execution/occupancy.hpp \ + asio/execution/outstanding_work.hpp \ + asio/execution/prefer_only.hpp \ + asio/execution/relationship.hpp \ + asio/executor.hpp \ + asio/executor_work_guard.hpp \ + asio/experimental/as_single.hpp \ + asio/experimental/awaitable_operators.hpp \ + asio/experimental/basic_channel.hpp \ + asio/experimental/basic_concurrent_channel.hpp \ + asio/experimental/cancellation_condition.hpp \ + asio/experimental/channel.hpp \ + asio/experimental/channel_error.hpp \ + asio/experimental/channel_traits.hpp \ + asio/experimental/co_composed.hpp \ + asio/experimental/co_spawn.hpp \ + asio/experimental/concurrent_channel.hpp \ + asio/experimental/coro.hpp \ + asio/experimental/coro_traits.hpp \ + asio/experimental/detail/channel_operation.hpp \ + asio/experimental/detail/channel_receive_op.hpp \ + asio/experimental/detail/channel_send_functions.hpp \ + asio/experimental/detail/channel_send_op.hpp \ + asio/experimental/detail/channel_service.hpp \ + asio/experimental/detail/coro_completion_handler.hpp \ + asio/experimental/detail/coro_promise_allocator.hpp \ + asio/experimental/detail/has_signature.hpp \ + asio/experimental/detail/impl/channel_service.hpp \ + asio/experimental/detail/partial_promise.hpp \ + asio/experimental/impl/as_single.hpp \ + asio/experimental/impl/channel_error.ipp \ + asio/experimental/impl/coro.hpp \ + asio/experimental/impl/parallel_group.hpp \ + asio/experimental/impl/promise.hpp \ + asio/experimental/impl/use_coro.hpp \ + asio/experimental/impl/use_promise.hpp \ + asio/experimental/parallel_group.hpp \ + asio/experimental/promise.hpp \ + asio/experimental/use_coro.hpp \ + asio/experimental/use_promise.hpp \ + asio/file_base.hpp \ + asio/generic/basic_endpoint.hpp \ + asio/generic/datagram_protocol.hpp \ + asio/generic/detail/endpoint.hpp \ + asio/generic/detail/impl/endpoint.ipp \ + asio/generic/raw_protocol.hpp \ + asio/generic/seq_packet_protocol.hpp \ + asio/generic/stream_protocol.hpp \ + asio/handler_continuation_hook.hpp \ + asio/high_resolution_timer.hpp \ + asio.hpp \ + asio/immediate.hpp \ + asio/impl/any_completion_executor.ipp \ + asio/impl/any_io_executor.ipp \ + asio/impl/append.hpp \ + asio/impl/as_tuple.hpp \ + asio/impl/awaitable.hpp \ + asio/impl/awaitable.ipp \ + asio/impl/buffered_read_stream.hpp \ + asio/impl/buffered_write_stream.hpp \ + asio/impl/cancel_after.hpp \ + asio/impl/cancel_at.hpp \ + asio/impl/cancellation_signal.ipp \ + asio/impl/co_spawn.hpp \ + asio/impl/config.hpp \ + asio/impl/config.ipp \ + asio/impl/connect.hpp \ + asio/impl/connect_pipe.hpp \ + asio/impl/connect_pipe.ipp \ + asio/impl/consign.hpp \ + asio/impl/deferred.hpp \ + asio/impl/detached.hpp \ + asio/impl/error_code.ipp \ + asio/impl/error.ipp \ + asio/impl/execution_context.hpp \ + asio/impl/execution_context.ipp \ + asio/impl/executor.hpp \ + asio/impl/executor.ipp \ + asio/impl/io_context.hpp \ + asio/impl/io_context.ipp \ + asio/impl/multiple_exceptions.ipp \ + asio/impl/prepend.hpp \ + asio/impl/read_at.hpp \ + asio/impl/read.hpp \ + asio/impl/read_until.hpp \ + asio/impl/redirect_error.hpp \ + asio/impl/serial_port_base.hpp \ + asio/impl/serial_port_base.ipp \ + asio/impl/spawn.hpp \ + asio/impl/src.hpp \ + asio/impl/system_context.hpp \ + asio/impl/system_context.ipp \ + asio/impl/system_executor.hpp \ + asio/impl/thread_pool.hpp \ + asio/impl/thread_pool.ipp \ + asio/impl/use_awaitable.hpp \ + asio/impl/use_future.hpp \ + asio/impl/write_at.hpp \ + asio/impl/write.hpp \ + asio/io_context.hpp \ + asio/io_context_strand.hpp \ + asio/ip/address.hpp \ + asio/ip/address_v4.hpp \ + asio/ip/address_v4_iterator.hpp \ + asio/ip/address_v4_range.hpp \ + asio/ip/address_v6.hpp \ + asio/ip/address_v6_iterator.hpp \ + asio/ip/address_v6_range.hpp \ + asio/ip/bad_address_cast.hpp \ + asio/ip/basic_endpoint.hpp \ + asio/ip/basic_resolver_entry.hpp \ + asio/ip/basic_resolver.hpp \ + asio/ip/basic_resolver_iterator.hpp \ + asio/ip/basic_resolver_query.hpp \ + asio/ip/basic_resolver_results.hpp \ + asio/ip/detail/endpoint.hpp \ + asio/ip/detail/impl/endpoint.ipp \ + asio/ip/detail/socket_option.hpp \ + asio/ip/host_name.hpp \ + asio/ip/icmp.hpp \ + asio/ip/impl/address.hpp \ + asio/ip/impl/address.ipp \ + asio/ip/impl/address_v4.hpp \ + asio/ip/impl/address_v4.ipp \ + asio/ip/impl/address_v6.hpp \ + asio/ip/impl/address_v6.ipp \ + asio/ip/impl/basic_endpoint.hpp \ + asio/ip/impl/host_name.ipp \ + asio/ip/impl/network_v4.hpp \ + asio/ip/impl/network_v4.ipp \ + asio/ip/impl/network_v6.hpp \ + asio/ip/impl/network_v6.ipp \ + asio/ip/multicast.hpp \ + asio/ip/network_v4.hpp \ + asio/ip/network_v6.hpp \ + asio/ip/resolver_base.hpp \ + asio/ip/resolver_query_base.hpp \ + asio/ip/tcp.hpp \ + asio/ip/udp.hpp \ + asio/ip/unicast.hpp \ + asio/ip/v6_only.hpp \ + asio/is_applicable_property.hpp \ + asio/is_contiguous_iterator.hpp \ + asio/is_executor.hpp \ + asio/is_read_buffered.hpp \ + asio/is_write_buffered.hpp \ + asio/local/basic_endpoint.hpp \ + asio/local/connect_pair.hpp \ + asio/local/datagram_protocol.hpp \ + asio/local/detail/endpoint.hpp \ + asio/local/detail/impl/endpoint.ipp \ + asio/local/seq_packet_protocol.hpp \ + asio/local/stream_protocol.hpp \ + asio/multiple_exceptions.hpp \ + asio/packaged_task.hpp \ + asio/placeholders.hpp \ + asio/posix/basic_descriptor.hpp \ + asio/posix/basic_stream_descriptor.hpp \ + asio/posix/descriptor_base.hpp \ + asio/posix/descriptor.hpp \ + asio/posix/stream_descriptor.hpp \ + asio/post.hpp \ + asio/prefer.hpp \ + asio/prepend.hpp \ + asio/query.hpp \ + asio/random_access_file.hpp \ + asio/read_at.hpp \ + asio/read.hpp \ + asio/read_until.hpp \ + asio/readable_pipe.hpp \ + asio/recycling_allocator.hpp \ + asio/redirect_error.hpp \ + asio/registered_buffer.hpp \ + asio/require.hpp \ + asio/require_concept.hpp \ + asio/serial_port_base.hpp \ + asio/serial_port.hpp \ + asio/signal_set_base.hpp \ + asio/signal_set.hpp \ + asio/socket_base.hpp \ + asio/spawn.hpp \ + asio/ssl/context_base.hpp \ + asio/ssl/context.hpp \ + asio/ssl/detail/buffered_handshake_op.hpp \ + asio/ssl/detail/engine.hpp \ + asio/ssl/detail/handshake_op.hpp \ + asio/ssl/detail/impl/engine.ipp \ + asio/ssl/detail/impl/openssl_init.ipp \ + asio/ssl/detail/io.hpp \ + asio/ssl/detail/openssl_init.hpp \ + asio/ssl/detail/openssl_types.hpp \ + asio/ssl/detail/password_callback.hpp \ + asio/ssl/detail/read_op.hpp \ + asio/ssl/detail/shutdown_op.hpp \ + asio/ssl/detail/stream_core.hpp \ + asio/ssl/detail/verify_callback.hpp \ + asio/ssl/detail/write_op.hpp \ + asio/ssl/error.hpp \ + asio/ssl.hpp \ + asio/ssl/host_name_verification.hpp \ + asio/ssl/impl/context.hpp \ + asio/ssl/impl/context.ipp \ + asio/ssl/impl/error.ipp \ + asio/ssl/impl/host_name_verification.ipp \ + asio/ssl/impl/src.hpp \ + asio/ssl/stream_base.hpp \ + asio/ssl/stream.hpp \ + asio/ssl/verify_context.hpp \ + asio/ssl/verify_mode.hpp \ + asio/static_thread_pool.hpp \ + asio/steady_timer.hpp \ + asio/strand.hpp \ + asio/streambuf.hpp \ + asio/stream_file.hpp \ + asio/system_context.hpp \ + asio/system_error.hpp \ + asio/system_executor.hpp \ + asio/system_timer.hpp \ + asio/this_coro.hpp \ + asio/thread.hpp \ + asio/thread_pool.hpp \ + asio/time_traits.hpp \ + asio/traits/equality_comparable.hpp \ + asio/traits/execute_member.hpp \ + asio/traits/prefer_free.hpp \ + asio/traits/prefer_member.hpp \ + asio/traits/query_free.hpp \ + asio/traits/query_member.hpp \ + asio/traits/query_static_constexpr_member.hpp \ + asio/traits/require_concept_free.hpp \ + asio/traits/require_concept_member.hpp \ + asio/traits/require_free.hpp \ + asio/traits/require_member.hpp \ + asio/traits/static_query.hpp \ + asio/traits/static_require.hpp \ + asio/traits/static_require_concept.hpp \ + asio/ts/buffer.hpp \ + asio/ts/executor.hpp \ + asio/ts/internet.hpp \ + asio/ts/io_context.hpp \ + asio/ts/netfwd.hpp \ + asio/ts/net.hpp \ + asio/ts/socket.hpp \ + asio/ts/timer.hpp \ + asio/unyield.hpp \ + asio/use_awaitable.hpp \ + asio/use_future.hpp \ + asio/uses_executor.hpp \ + asio/version.hpp \ + asio/wait_traits.hpp \ + asio/windows/basic_object_handle.hpp \ + asio/windows/basic_overlapped_handle.hpp \ + asio/windows/basic_random_access_handle.hpp \ + asio/windows/basic_stream_handle.hpp \ + asio/windows/object_handle.hpp \ + asio/windows/overlapped_handle.hpp \ + asio/windows/overlapped_ptr.hpp \ + asio/windows/random_access_handle.hpp \ + asio/windows/stream_handle.hpp \ + asio/writable_pipe.hpp \ + asio/write_at.hpp \ + asio/write.hpp \ + asio/yield.hpp + +MAINTAINERCLEANFILES = \ + $(srcdir)/Makefile.in diff --git a/Packages/asio-1.36.0/include/Makefile.in b/Packages/asio-1.36.0/include/Makefile.in new file mode 100644 index 0000000..5f2f362 --- /dev/null +++ b/Packages/asio-1.36.0/include/Makefile.in @@ -0,0 +1,1179 @@ +# Makefile.in generated by automake 1.17 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2024 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +am__is_gnu_make = { \ + if test -z '$(MAKELEVEL)'; then \ + false; \ + elif test -n '$(MAKE_HOST)'; then \ + true; \ + elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \ + true; \ + else \ + false; \ + fi; \ +} +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) +am__rm_f = rm -f $(am__rm_f_notfound) +am__rm_rf = rm -rf $(am__rm_f_notfound) +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = include +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +DIST_COMMON = $(srcdir)/Makefile.am $(nobase_include_HEADERS) \ + $(am__DIST_COMMON) +mkinstalldirs = $(install_sh) -d +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && echo $$files | $(am__xargs_n) 40 $(am__rm_f); }; \ + } +am__installdirs = "$(DESTDIR)$(includedir)" +HEADERS = $(nobase_include_HEADERS) +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +# Read a list of newline-separated strings from the standard input, +# and print each of them once, without duplicates. Input order is +# *not* preserved. +am__uniquify_input = $(AWK) '\ + BEGIN { nonempty = 0; } \ + { items[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in items) print i; }; } \ +' +# Make sure the list of sources is unique. This is necessary because, +# e.g., the same source file might be shared among _SOURCES variables +# for different programs/libraries. +am__define_uniq_tagged_files = \ + list='$(am__tagged_files)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | $(am__uniquify_input)` +am__DIST_COMMON = $(srcdir)/Makefile.in +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPPFLAGS = @CPPFLAGS@ +CSCOPE = @CSCOPE@ +CTAGS = @CTAGS@ +CXX = @CXX@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +ETAGS = @ETAGS@ +EXEEXT = @EXEEXT@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +RANLIB = @RANLIB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__rm_f_notfound = @am__rm_f_notfound@ +am__tar = @am__tar@ +am__untar = @am__untar@ +am__xargs_n = @am__xargs_n@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +runstatedir = @runstatedir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# find . -name "*.*pp" | sed -e 's/^\.\///' | sed -e 's/^.*$/ & \\/' | sort +nobase_include_HEADERS = \ + asio/any_completion_executor.hpp \ + asio/any_completion_handler.hpp \ + asio/any_io_executor.hpp \ + asio/append.hpp \ + asio/as_tuple.hpp \ + asio/associated_allocator.hpp \ + asio/associated_cancellation_slot.hpp \ + asio/associated_executor.hpp \ + asio/associated_immediate_executor.hpp \ + asio/associator.hpp \ + asio/async_result.hpp \ + asio/awaitable.hpp \ + asio/basic_datagram_socket.hpp \ + asio/basic_deadline_timer.hpp \ + asio/basic_file.hpp \ + asio/basic_io_object.hpp \ + asio/basic_random_access_file.hpp \ + asio/basic_raw_socket.hpp \ + asio/basic_readable_pipe.hpp \ + asio/basic_seq_packet_socket.hpp \ + asio/basic_serial_port.hpp \ + asio/basic_signal_set.hpp \ + asio/basic_socket_acceptor.hpp \ + asio/basic_socket.hpp \ + asio/basic_socket_iostream.hpp \ + asio/basic_socket_streambuf.hpp \ + asio/basic_streambuf_fwd.hpp \ + asio/basic_streambuf.hpp \ + asio/basic_stream_file.hpp \ + asio/basic_stream_socket.hpp \ + asio/basic_waitable_timer.hpp \ + asio/basic_writable_pipe.hpp \ + asio/bind_allocator.hpp \ + asio/bind_cancellation_slot.hpp \ + asio/bind_executor.hpp \ + asio/bind_immediate_executor.hpp \ + asio/buffered_read_stream_fwd.hpp \ + asio/buffered_read_stream.hpp \ + asio/buffered_stream_fwd.hpp \ + asio/buffered_stream.hpp \ + asio/buffered_write_stream_fwd.hpp \ + asio/buffered_write_stream.hpp \ + asio/buffer.hpp \ + asio/buffer_registration.hpp \ + asio/buffers_iterator.hpp \ + asio/cancel_after.hpp \ + asio/cancel_at.hpp \ + asio/cancellation_signal.hpp \ + asio/cancellation_state.hpp \ + asio/cancellation_type.hpp \ + asio/co_composed.hpp \ + asio/co_spawn.hpp \ + asio/completion_condition.hpp \ + asio/compose.hpp \ + asio/composed.hpp \ + asio/config.hpp \ + asio/connect.hpp \ + asio/connect_pipe.hpp \ + asio/consign.hpp \ + asio/coroutine.hpp \ + asio/deadline_timer.hpp \ + asio/defer.hpp \ + asio/deferred.hpp \ + asio/default_completion_token.hpp \ + asio/detached.hpp \ + asio/detail/array_fwd.hpp \ + asio/detail/array.hpp \ + asio/detail/assert.hpp \ + asio/detail/atomic_count.hpp \ + asio/detail/base_from_cancellation_state.hpp \ + asio/detail/base_from_completion_cond.hpp \ + asio/detail/bind_handler.hpp \ + asio/detail/blocking_executor_op.hpp \ + asio/detail/buffered_stream_storage.hpp \ + asio/detail/buffer_resize_guard.hpp \ + asio/detail/buffer_sequence_adapter.hpp \ + asio/detail/call_stack.hpp \ + asio/detail/chrono.hpp \ + asio/detail/chrono_time_traits.hpp \ + asio/detail/completion_handler.hpp \ + asio/detail/completion_message.hpp \ + asio/detail/completion_payload.hpp \ + asio/detail/completion_payload_handler.hpp \ + asio/detail/composed_work.hpp \ + asio/detail/concurrency_hint.hpp \ + asio/detail/conditionally_enabled_event.hpp \ + asio/detail/conditionally_enabled_mutex.hpp \ + asio/detail/config.hpp \ + asio/detail/consuming_buffers.hpp \ + asio/detail/cstddef.hpp \ + asio/detail/cstdint.hpp \ + asio/detail/date_time_fwd.hpp \ + asio/detail/deadline_timer_service.hpp \ + asio/detail/dependent_type.hpp \ + asio/detail/descriptor_ops.hpp \ + asio/detail/descriptor_read_op.hpp \ + asio/detail/descriptor_write_op.hpp \ + asio/detail/dev_poll_reactor.hpp \ + asio/detail/epoll_reactor.hpp \ + asio/detail/eventfd_select_interrupter.hpp \ + asio/detail/event.hpp \ + asio/detail/exception.hpp \ + asio/detail/executor_function.hpp \ + asio/detail/executor_op.hpp \ + asio/detail/fd_set_adapter.hpp \ + asio/detail/fenced_block.hpp \ + asio/detail/functional.hpp \ + asio/detail/future.hpp \ + asio/detail/global.hpp \ + asio/detail/handler_alloc_helpers.hpp \ + asio/detail/handler_cont_helpers.hpp \ + asio/detail/handler_tracking.hpp \ + asio/detail/handler_type_requirements.hpp \ + asio/detail/handler_work.hpp \ + asio/detail/hash_map.hpp \ + asio/detail/impl/buffer_sequence_adapter.ipp \ + asio/detail/impl/descriptor_ops.ipp \ + asio/detail/impl/dev_poll_reactor.hpp \ + asio/detail/impl/dev_poll_reactor.ipp \ + asio/detail/impl/epoll_reactor.hpp \ + asio/detail/impl/epoll_reactor.ipp \ + asio/detail/impl/eventfd_select_interrupter.ipp \ + asio/detail/impl/handler_tracking.ipp \ + asio/detail/impl/io_uring_descriptor_service.ipp \ + asio/detail/impl/io_uring_file_service.ipp \ + asio/detail/impl/io_uring_service.hpp \ + asio/detail/impl/io_uring_service.ipp \ + asio/detail/impl/io_uring_socket_service_base.ipp \ + asio/detail/impl/kqueue_reactor.hpp \ + asio/detail/impl/kqueue_reactor.ipp \ + asio/detail/impl/null_event.ipp \ + asio/detail/impl/pipe_select_interrupter.ipp \ + asio/detail/impl/posix_event.ipp \ + asio/detail/impl/posix_mutex.ipp \ + asio/detail/impl/posix_serial_port_service.ipp \ + asio/detail/impl/posix_thread.ipp \ + asio/detail/impl/posix_tss_ptr.ipp \ + asio/detail/impl/reactive_descriptor_service.ipp \ + asio/detail/impl/reactive_socket_service_base.ipp \ + asio/detail/impl/resolver_service_base.ipp \ + asio/detail/impl/resolver_thread_pool.ipp \ + asio/detail/impl/scheduler.ipp \ + asio/detail/impl/select_reactor.hpp \ + asio/detail/impl/select_reactor.ipp \ + asio/detail/impl/service_registry.hpp \ + asio/detail/impl/service_registry.ipp \ + asio/detail/impl/signal_set_service.ipp \ + asio/detail/impl/socket_ops.ipp \ + asio/detail/impl/socket_select_interrupter.ipp \ + asio/detail/impl/strand_executor_service.hpp \ + asio/detail/impl/strand_executor_service.ipp \ + asio/detail/impl/strand_service.hpp \ + asio/detail/impl/strand_service.ipp \ + asio/detail/impl/thread_context.ipp \ + asio/detail/impl/throw_error.ipp \ + asio/detail/impl/timer_queue_set.ipp \ + asio/detail/impl/win_event.ipp \ + asio/detail/impl/win_iocp_file_service.ipp \ + asio/detail/impl/win_iocp_handle_service.ipp \ + asio/detail/impl/win_iocp_io_context.hpp \ + asio/detail/impl/win_iocp_io_context.ipp \ + asio/detail/impl/win_iocp_serial_port_service.ipp \ + asio/detail/impl/win_iocp_socket_service_base.ipp \ + asio/detail/impl/win_mutex.ipp \ + asio/detail/impl/win_object_handle_service.ipp \ + asio/detail/impl/winrt_ssocket_service_base.ipp \ + asio/detail/impl/winrt_timer_scheduler.hpp \ + asio/detail/impl/winrt_timer_scheduler.ipp \ + asio/detail/impl/winsock_init.ipp \ + asio/detail/impl/win_static_mutex.ipp \ + asio/detail/impl/win_thread.ipp \ + asio/detail/impl/win_tss_ptr.ipp \ + asio/detail/initiate_defer.hpp \ + asio/detail/initiate_dispatch.hpp \ + asio/detail/initiate_post.hpp \ + asio/detail/initiation_base.hpp \ + asio/detail/io_control.hpp \ + asio/detail/io_object_impl.hpp \ + asio/detail/io_uring_descriptor_read_at_op.hpp \ + asio/detail/io_uring_descriptor_read_op.hpp \ + asio/detail/io_uring_descriptor_service.hpp \ + asio/detail/io_uring_descriptor_write_at_op.hpp \ + asio/detail/io_uring_descriptor_write_op.hpp \ + asio/detail/io_uring_file_service.hpp \ + asio/detail/io_uring_null_buffers_op.hpp \ + asio/detail/io_uring_operation.hpp \ + asio/detail/io_uring_service.hpp \ + asio/detail/io_uring_socket_accept_op.hpp \ + asio/detail/io_uring_socket_connect_op.hpp \ + asio/detail/io_uring_socket_recvfrom_op.hpp \ + asio/detail/io_uring_socket_recvmsg_op.hpp \ + asio/detail/io_uring_socket_recv_op.hpp \ + asio/detail/io_uring_socket_send_op.hpp \ + asio/detail/io_uring_socket_sendto_op.hpp \ + asio/detail/io_uring_socket_service_base.hpp \ + asio/detail/io_uring_socket_service.hpp \ + asio/detail/io_uring_wait_op.hpp \ + asio/detail/is_buffer_sequence.hpp \ + asio/detail/is_executor.hpp \ + asio/detail/keyword_tss_ptr.hpp \ + asio/detail/kqueue_reactor.hpp \ + asio/detail/limits.hpp \ + asio/detail/local_free_on_block_exit.hpp \ + asio/detail/memory.hpp \ + asio/detail/mutex.hpp \ + asio/detail/non_const_lvalue.hpp \ + asio/detail/noncopyable.hpp \ + asio/detail/null_event.hpp \ + asio/detail/null_fenced_block.hpp \ + asio/detail/null_global.hpp \ + asio/detail/null_mutex.hpp \ + asio/detail/null_reactor.hpp \ + asio/detail/null_signal_blocker.hpp \ + asio/detail/null_socket_service.hpp \ + asio/detail/null_static_mutex.hpp \ + asio/detail/null_thread.hpp \ + asio/detail/null_tss_ptr.hpp \ + asio/detail/object_pool.hpp \ + asio/detail/old_win_sdk_compat.hpp \ + asio/detail/operation.hpp \ + asio/detail/op_queue.hpp \ + asio/detail/pipe_select_interrupter.hpp \ + asio/detail/pop_options.hpp \ + asio/detail/posix_event.hpp \ + asio/detail/posix_fd_set_adapter.hpp \ + asio/detail/posix_global.hpp \ + asio/detail/posix_mutex.hpp \ + asio/detail/posix_serial_port_service.hpp \ + asio/detail/posix_signal_blocker.hpp \ + asio/detail/posix_static_mutex.hpp \ + asio/detail/posix_thread.hpp \ + asio/detail/posix_tss_ptr.hpp \ + asio/detail/push_options.hpp \ + asio/detail/reactive_descriptor_service.hpp \ + asio/detail/reactive_null_buffers_op.hpp \ + asio/detail/reactive_socket_accept_op.hpp \ + asio/detail/reactive_socket_connect_op.hpp \ + asio/detail/reactive_socket_recvfrom_op.hpp \ + asio/detail/reactive_socket_recvmsg_op.hpp \ + asio/detail/reactive_socket_recv_op.hpp \ + asio/detail/reactive_socket_send_op.hpp \ + asio/detail/reactive_socket_sendto_op.hpp \ + asio/detail/reactive_socket_service_base.hpp \ + asio/detail/reactive_socket_service.hpp \ + asio/detail/reactive_wait_op.hpp \ + asio/detail/reactor.hpp \ + asio/detail/reactor_op.hpp \ + asio/detail/reactor_op_queue.hpp \ + asio/detail/recycling_allocator.hpp \ + asio/detail/regex_fwd.hpp \ + asio/detail/resolve_endpoint_op.hpp \ + asio/detail/resolve_op.hpp \ + asio/detail/resolve_query_op.hpp \ + asio/detail/resolver_service_base.hpp \ + asio/detail/resolver_thread_pool.hpp \ + asio/detail/resolver_service.hpp \ + asio/detail/scheduler.hpp \ + asio/detail/scheduler_operation.hpp \ + asio/detail/scheduler_task.hpp \ + asio/detail/scheduler_thread_info.hpp \ + asio/detail/scoped_lock.hpp \ + asio/detail/scoped_ptr.hpp \ + asio/detail/select_interrupter.hpp \ + asio/detail/select_reactor.hpp \ + asio/detail/service_registry.hpp \ + asio/detail/signal_blocker.hpp \ + asio/detail/signal_handler.hpp \ + asio/detail/signal_init.hpp \ + asio/detail/signal_op.hpp \ + asio/detail/signal_set_service.hpp \ + asio/detail/socket_holder.hpp \ + asio/detail/socket_ops.hpp \ + asio/detail/socket_option.hpp \ + asio/detail/socket_select_interrupter.hpp \ + asio/detail/socket_types.hpp \ + asio/detail/source_location.hpp \ + asio/detail/static_mutex.hpp \ + asio/detail/std_event.hpp \ + asio/detail/std_fenced_block.hpp \ + asio/detail/std_global.hpp \ + asio/detail/std_mutex.hpp \ + asio/detail/std_static_mutex.hpp \ + asio/detail/std_thread.hpp \ + asio/detail/strand_executor_service.hpp \ + asio/detail/strand_service.hpp \ + asio/detail/string_view.hpp \ + asio/detail/thread_context.hpp \ + asio/detail/thread_group.hpp \ + asio/detail/thread.hpp \ + asio/detail/thread_info_base.hpp \ + asio/detail/throw_error.hpp \ + asio/detail/throw_exception.hpp \ + asio/detail/timed_cancel_op.hpp \ + asio/detail/timer_queue_base.hpp \ + asio/detail/timer_queue.hpp \ + asio/detail/timer_queue_set.hpp \ + asio/detail/timer_scheduler_fwd.hpp \ + asio/detail/timer_scheduler.hpp \ + asio/detail/tss_ptr.hpp \ + asio/detail/type_traits.hpp \ + asio/detail/utility.hpp \ + asio/detail/wait_handler.hpp \ + asio/detail/wait_op.hpp \ + asio/detail/winapp_thread.hpp \ + asio/detail/wince_thread.hpp \ + asio/detail/win_event.hpp \ + asio/detail/win_fd_set_adapter.hpp \ + asio/detail/win_global.hpp \ + asio/detail/win_iocp_file_service.hpp \ + asio/detail/win_iocp_handle_read_op.hpp \ + asio/detail/win_iocp_handle_service.hpp \ + asio/detail/win_iocp_handle_write_op.hpp \ + asio/detail/win_iocp_io_context.hpp \ + asio/detail/win_iocp_null_buffers_op.hpp \ + asio/detail/win_iocp_operation.hpp \ + asio/detail/win_iocp_overlapped_op.hpp \ + asio/detail/win_iocp_overlapped_ptr.hpp \ + asio/detail/win_iocp_serial_port_service.hpp \ + asio/detail/win_iocp_socket_accept_op.hpp \ + asio/detail/win_iocp_socket_connect_op.hpp \ + asio/detail/win_iocp_socket_recvfrom_op.hpp \ + asio/detail/win_iocp_socket_recvmsg_op.hpp \ + asio/detail/win_iocp_socket_recv_op.hpp \ + asio/detail/win_iocp_socket_send_op.hpp \ + asio/detail/win_iocp_socket_service_base.hpp \ + asio/detail/win_iocp_socket_service.hpp \ + asio/detail/win_iocp_thread_info.hpp \ + asio/detail/win_iocp_wait_op.hpp \ + asio/detail/win_mutex.hpp \ + asio/detail/win_object_handle_service.hpp \ + asio/detail/winrt_async_manager.hpp \ + asio/detail/winrt_async_op.hpp \ + asio/detail/winrt_resolve_op.hpp \ + asio/detail/winrt_resolver_service.hpp \ + asio/detail/winrt_socket_connect_op.hpp \ + asio/detail/winrt_socket_recv_op.hpp \ + asio/detail/winrt_socket_send_op.hpp \ + asio/detail/winrt_ssocket_service_base.hpp \ + asio/detail/winrt_ssocket_service.hpp \ + asio/detail/winrt_timer_scheduler.hpp \ + asio/detail/winrt_utils.hpp \ + asio/detail/winsock_init.hpp \ + asio/detail/win_static_mutex.hpp \ + asio/detail/win_thread.hpp \ + asio/detail/win_tss_ptr.hpp \ + asio/detail/work_dispatcher.hpp \ + asio/detail/wrapped_handler.hpp \ + asio/dispatch.hpp \ + asio/disposition.hpp \ + asio/error_code.hpp \ + asio/error.hpp \ + asio/execution.hpp \ + asio/execution_context.hpp \ + asio/execution/allocator.hpp \ + asio/execution/any_executor.hpp \ + asio/execution/bad_executor.hpp \ + asio/execution/blocking.hpp \ + asio/execution/blocking_adaptation.hpp \ + asio/execution/context.hpp \ + asio/execution/context_as.hpp \ + asio/execution/executor.hpp \ + asio/execution/impl/bad_executor.ipp \ + asio/execution/invocable_archetype.hpp \ + asio/execution/mapping.hpp \ + asio/execution/occupancy.hpp \ + asio/execution/outstanding_work.hpp \ + asio/execution/prefer_only.hpp \ + asio/execution/relationship.hpp \ + asio/executor.hpp \ + asio/executor_work_guard.hpp \ + asio/experimental/as_single.hpp \ + asio/experimental/awaitable_operators.hpp \ + asio/experimental/basic_channel.hpp \ + asio/experimental/basic_concurrent_channel.hpp \ + asio/experimental/cancellation_condition.hpp \ + asio/experimental/channel.hpp \ + asio/experimental/channel_error.hpp \ + asio/experimental/channel_traits.hpp \ + asio/experimental/co_composed.hpp \ + asio/experimental/co_spawn.hpp \ + asio/experimental/concurrent_channel.hpp \ + asio/experimental/coro.hpp \ + asio/experimental/coro_traits.hpp \ + asio/experimental/detail/channel_operation.hpp \ + asio/experimental/detail/channel_receive_op.hpp \ + asio/experimental/detail/channel_send_functions.hpp \ + asio/experimental/detail/channel_send_op.hpp \ + asio/experimental/detail/channel_service.hpp \ + asio/experimental/detail/coro_completion_handler.hpp \ + asio/experimental/detail/coro_promise_allocator.hpp \ + asio/experimental/detail/has_signature.hpp \ + asio/experimental/detail/impl/channel_service.hpp \ + asio/experimental/detail/partial_promise.hpp \ + asio/experimental/impl/as_single.hpp \ + asio/experimental/impl/channel_error.ipp \ + asio/experimental/impl/coro.hpp \ + asio/experimental/impl/parallel_group.hpp \ + asio/experimental/impl/promise.hpp \ + asio/experimental/impl/use_coro.hpp \ + asio/experimental/impl/use_promise.hpp \ + asio/experimental/parallel_group.hpp \ + asio/experimental/promise.hpp \ + asio/experimental/use_coro.hpp \ + asio/experimental/use_promise.hpp \ + asio/file_base.hpp \ + asio/generic/basic_endpoint.hpp \ + asio/generic/datagram_protocol.hpp \ + asio/generic/detail/endpoint.hpp \ + asio/generic/detail/impl/endpoint.ipp \ + asio/generic/raw_protocol.hpp \ + asio/generic/seq_packet_protocol.hpp \ + asio/generic/stream_protocol.hpp \ + asio/handler_continuation_hook.hpp \ + asio/high_resolution_timer.hpp \ + asio.hpp \ + asio/immediate.hpp \ + asio/impl/any_completion_executor.ipp \ + asio/impl/any_io_executor.ipp \ + asio/impl/append.hpp \ + asio/impl/as_tuple.hpp \ + asio/impl/awaitable.hpp \ + asio/impl/awaitable.ipp \ + asio/impl/buffered_read_stream.hpp \ + asio/impl/buffered_write_stream.hpp \ + asio/impl/cancel_after.hpp \ + asio/impl/cancel_at.hpp \ + asio/impl/cancellation_signal.ipp \ + asio/impl/co_spawn.hpp \ + asio/impl/config.hpp \ + asio/impl/config.ipp \ + asio/impl/connect.hpp \ + asio/impl/connect_pipe.hpp \ + asio/impl/connect_pipe.ipp \ + asio/impl/consign.hpp \ + asio/impl/deferred.hpp \ + asio/impl/detached.hpp \ + asio/impl/error_code.ipp \ + asio/impl/error.ipp \ + asio/impl/execution_context.hpp \ + asio/impl/execution_context.ipp \ + asio/impl/executor.hpp \ + asio/impl/executor.ipp \ + asio/impl/io_context.hpp \ + asio/impl/io_context.ipp \ + asio/impl/multiple_exceptions.ipp \ + asio/impl/prepend.hpp \ + asio/impl/read_at.hpp \ + asio/impl/read.hpp \ + asio/impl/read_until.hpp \ + asio/impl/redirect_error.hpp \ + asio/impl/serial_port_base.hpp \ + asio/impl/serial_port_base.ipp \ + asio/impl/spawn.hpp \ + asio/impl/src.hpp \ + asio/impl/system_context.hpp \ + asio/impl/system_context.ipp \ + asio/impl/system_executor.hpp \ + asio/impl/thread_pool.hpp \ + asio/impl/thread_pool.ipp \ + asio/impl/use_awaitable.hpp \ + asio/impl/use_future.hpp \ + asio/impl/write_at.hpp \ + asio/impl/write.hpp \ + asio/io_context.hpp \ + asio/io_context_strand.hpp \ + asio/ip/address.hpp \ + asio/ip/address_v4.hpp \ + asio/ip/address_v4_iterator.hpp \ + asio/ip/address_v4_range.hpp \ + asio/ip/address_v6.hpp \ + asio/ip/address_v6_iterator.hpp \ + asio/ip/address_v6_range.hpp \ + asio/ip/bad_address_cast.hpp \ + asio/ip/basic_endpoint.hpp \ + asio/ip/basic_resolver_entry.hpp \ + asio/ip/basic_resolver.hpp \ + asio/ip/basic_resolver_iterator.hpp \ + asio/ip/basic_resolver_query.hpp \ + asio/ip/basic_resolver_results.hpp \ + asio/ip/detail/endpoint.hpp \ + asio/ip/detail/impl/endpoint.ipp \ + asio/ip/detail/socket_option.hpp \ + asio/ip/host_name.hpp \ + asio/ip/icmp.hpp \ + asio/ip/impl/address.hpp \ + asio/ip/impl/address.ipp \ + asio/ip/impl/address_v4.hpp \ + asio/ip/impl/address_v4.ipp \ + asio/ip/impl/address_v6.hpp \ + asio/ip/impl/address_v6.ipp \ + asio/ip/impl/basic_endpoint.hpp \ + asio/ip/impl/host_name.ipp \ + asio/ip/impl/network_v4.hpp \ + asio/ip/impl/network_v4.ipp \ + asio/ip/impl/network_v6.hpp \ + asio/ip/impl/network_v6.ipp \ + asio/ip/multicast.hpp \ + asio/ip/network_v4.hpp \ + asio/ip/network_v6.hpp \ + asio/ip/resolver_base.hpp \ + asio/ip/resolver_query_base.hpp \ + asio/ip/tcp.hpp \ + asio/ip/udp.hpp \ + asio/ip/unicast.hpp \ + asio/ip/v6_only.hpp \ + asio/is_applicable_property.hpp \ + asio/is_contiguous_iterator.hpp \ + asio/is_executor.hpp \ + asio/is_read_buffered.hpp \ + asio/is_write_buffered.hpp \ + asio/local/basic_endpoint.hpp \ + asio/local/connect_pair.hpp \ + asio/local/datagram_protocol.hpp \ + asio/local/detail/endpoint.hpp \ + asio/local/detail/impl/endpoint.ipp \ + asio/local/seq_packet_protocol.hpp \ + asio/local/stream_protocol.hpp \ + asio/multiple_exceptions.hpp \ + asio/packaged_task.hpp \ + asio/placeholders.hpp \ + asio/posix/basic_descriptor.hpp \ + asio/posix/basic_stream_descriptor.hpp \ + asio/posix/descriptor_base.hpp \ + asio/posix/descriptor.hpp \ + asio/posix/stream_descriptor.hpp \ + asio/post.hpp \ + asio/prefer.hpp \ + asio/prepend.hpp \ + asio/query.hpp \ + asio/random_access_file.hpp \ + asio/read_at.hpp \ + asio/read.hpp \ + asio/read_until.hpp \ + asio/readable_pipe.hpp \ + asio/recycling_allocator.hpp \ + asio/redirect_error.hpp \ + asio/registered_buffer.hpp \ + asio/require.hpp \ + asio/require_concept.hpp \ + asio/serial_port_base.hpp \ + asio/serial_port.hpp \ + asio/signal_set_base.hpp \ + asio/signal_set.hpp \ + asio/socket_base.hpp \ + asio/spawn.hpp \ + asio/ssl/context_base.hpp \ + asio/ssl/context.hpp \ + asio/ssl/detail/buffered_handshake_op.hpp \ + asio/ssl/detail/engine.hpp \ + asio/ssl/detail/handshake_op.hpp \ + asio/ssl/detail/impl/engine.ipp \ + asio/ssl/detail/impl/openssl_init.ipp \ + asio/ssl/detail/io.hpp \ + asio/ssl/detail/openssl_init.hpp \ + asio/ssl/detail/openssl_types.hpp \ + asio/ssl/detail/password_callback.hpp \ + asio/ssl/detail/read_op.hpp \ + asio/ssl/detail/shutdown_op.hpp \ + asio/ssl/detail/stream_core.hpp \ + asio/ssl/detail/verify_callback.hpp \ + asio/ssl/detail/write_op.hpp \ + asio/ssl/error.hpp \ + asio/ssl.hpp \ + asio/ssl/host_name_verification.hpp \ + asio/ssl/impl/context.hpp \ + asio/ssl/impl/context.ipp \ + asio/ssl/impl/error.ipp \ + asio/ssl/impl/host_name_verification.ipp \ + asio/ssl/impl/src.hpp \ + asio/ssl/stream_base.hpp \ + asio/ssl/stream.hpp \ + asio/ssl/verify_context.hpp \ + asio/ssl/verify_mode.hpp \ + asio/static_thread_pool.hpp \ + asio/steady_timer.hpp \ + asio/strand.hpp \ + asio/streambuf.hpp \ + asio/stream_file.hpp \ + asio/system_context.hpp \ + asio/system_error.hpp \ + asio/system_executor.hpp \ + asio/system_timer.hpp \ + asio/this_coro.hpp \ + asio/thread.hpp \ + asio/thread_pool.hpp \ + asio/time_traits.hpp \ + asio/traits/equality_comparable.hpp \ + asio/traits/execute_member.hpp \ + asio/traits/prefer_free.hpp \ + asio/traits/prefer_member.hpp \ + asio/traits/query_free.hpp \ + asio/traits/query_member.hpp \ + asio/traits/query_static_constexpr_member.hpp \ + asio/traits/require_concept_free.hpp \ + asio/traits/require_concept_member.hpp \ + asio/traits/require_free.hpp \ + asio/traits/require_member.hpp \ + asio/traits/static_query.hpp \ + asio/traits/static_require.hpp \ + asio/traits/static_require_concept.hpp \ + asio/ts/buffer.hpp \ + asio/ts/executor.hpp \ + asio/ts/internet.hpp \ + asio/ts/io_context.hpp \ + asio/ts/netfwd.hpp \ + asio/ts/net.hpp \ + asio/ts/socket.hpp \ + asio/ts/timer.hpp \ + asio/unyield.hpp \ + asio/use_awaitable.hpp \ + asio/use_future.hpp \ + asio/uses_executor.hpp \ + asio/version.hpp \ + asio/wait_traits.hpp \ + asio/windows/basic_object_handle.hpp \ + asio/windows/basic_overlapped_handle.hpp \ + asio/windows/basic_random_access_handle.hpp \ + asio/windows/basic_stream_handle.hpp \ + asio/windows/object_handle.hpp \ + asio/windows/overlapped_handle.hpp \ + asio/windows/overlapped_ptr.hpp \ + asio/windows/random_access_handle.hpp \ + asio/windows/stream_handle.hpp \ + asio/writable_pipe.hpp \ + asio/write_at.hpp \ + asio/write.hpp \ + asio/yield.hpp + +MAINTAINERCLEANFILES = \ + $(srcdir)/Makefile.in + +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign include/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign include/Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +install-nobase_includeHEADERS: $(nobase_include_HEADERS) + @$(NORMAL_INSTALL) + @list='$(nobase_include_HEADERS)'; test -n "$(includedir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(includedir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(includedir)" || exit 1; \ + fi; \ + $(am__nobase_list) | while read dir files; do \ + xfiles=; for file in $$files; do \ + if test -f "$$file"; then xfiles="$$xfiles $$file"; \ + else xfiles="$$xfiles $(srcdir)/$$file"; fi; done; \ + test -z "$$xfiles" || { \ + test "x$$dir" = x. || { \ + echo " $(MKDIR_P) '$(DESTDIR)$(includedir)/$$dir'"; \ + $(MKDIR_P) "$(DESTDIR)$(includedir)/$$dir"; }; \ + echo " $(INSTALL_HEADER) $$xfiles '$(DESTDIR)$(includedir)/$$dir'"; \ + $(INSTALL_HEADER) $$xfiles "$(DESTDIR)$(includedir)/$$dir" || exit $$?; }; \ + done + +uninstall-nobase_includeHEADERS: + @$(NORMAL_UNINSTALL) + @list='$(nobase_include_HEADERS)'; test -n "$(includedir)" || list=; \ + $(am__nobase_strip_setup); files=`$(am__nobase_strip)`; \ + dir='$(DESTDIR)$(includedir)'; $(am__uninstall_files_from_dir) + +ID: $(am__tagged_files) + $(am__define_uniq_tagged_files); mkid -fID $$unique +tags: tags-am +TAGS: tags + +tags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + set x; \ + here=`pwd`; \ + $(am__define_uniq_tagged_files); \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$unique; \ + fi; \ + fi +ctags: ctags-am + +CTAGS: ctags +ctags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + $(am__define_uniq_tagged_files); \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" +cscopelist: cscopelist-am + +cscopelist-am: $(am__tagged_files) + list='$(am__tagged_files)'; \ + case "$(srcdir)" in \ + [\\/]* | ?:[\\/]*) sdir="$(srcdir)" ;; \ + *) sdir=$(subdir)/$(srcdir) ;; \ + esac; \ + for i in $$list; do \ + if test -f "$$i"; then \ + echo "$(subdir)/$$i"; \ + else \ + echo "$$sdir/$$i"; \ + fi; \ + done >> $(top_builddir)/cscope.files + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags +distdir: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) distdir-am + +distdir-am: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(HEADERS) +installdirs: + for dir in "$(DESTDIR)$(includedir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -$(am__rm_f) $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || $(am__rm_f) $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -$(am__rm_f) $(MAINTAINERCLEANFILES) +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-nobase_includeHEADERS + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-nobase_includeHEADERS + +.MAKE: install-am install-strip + +.PHONY: CTAGS GTAGS TAGS all all-am check check-am clean clean-generic \ + cscopelist-am ctags ctags-am distclean distclean-generic \ + distclean-tags distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-nobase_includeHEADERS install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ + pdf-am ps ps-am tags tags-am uninstall uninstall-am \ + uninstall-nobase_includeHEADERS + +.PRECIOUS: Makefile + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: + +# Tell GNU make to disable its built-in pattern rules. +%:: %,v +%:: RCS/%,v +%:: RCS/% +%:: s.% +%:: SCCS/s.% diff --git a/Packages/asio-1.36.0/include/asio.hpp b/Packages/asio-1.36.0/include/asio.hpp new file mode 100644 index 0000000..2398b71 --- /dev/null +++ b/Packages/asio-1.36.0/include/asio.hpp @@ -0,0 +1,202 @@ +// +// asio.hpp +// ~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_HPP +#define ASIO_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/any_completion_executor.hpp" +#include "asio/any_completion_handler.hpp" +#include "asio/any_io_executor.hpp" +#include "asio/append.hpp" +#include "asio/as_tuple.hpp" +#include "asio/associated_allocator.hpp" +#include "asio/associated_cancellation_slot.hpp" +#include "asio/associated_executor.hpp" +#include "asio/associated_immediate_executor.hpp" +#include "asio/associator.hpp" +#include "asio/async_result.hpp" +#include "asio/awaitable.hpp" +#include "asio/basic_datagram_socket.hpp" +#include "asio/basic_file.hpp" +#include "asio/basic_io_object.hpp" +#include "asio/basic_random_access_file.hpp" +#include "asio/basic_raw_socket.hpp" +#include "asio/basic_readable_pipe.hpp" +#include "asio/basic_seq_packet_socket.hpp" +#include "asio/basic_serial_port.hpp" +#include "asio/basic_signal_set.hpp" +#include "asio/basic_socket.hpp" +#include "asio/basic_socket_acceptor.hpp" +#include "asio/basic_socket_iostream.hpp" +#include "asio/basic_socket_streambuf.hpp" +#include "asio/basic_stream_file.hpp" +#include "asio/basic_stream_socket.hpp" +#include "asio/basic_streambuf.hpp" +#include "asio/basic_waitable_timer.hpp" +#include "asio/basic_writable_pipe.hpp" +#include "asio/bind_allocator.hpp" +#include "asio/bind_cancellation_slot.hpp" +#include "asio/bind_executor.hpp" +#include "asio/bind_immediate_executor.hpp" +#include "asio/buffer.hpp" +#include "asio/buffer_registration.hpp" +#include "asio/buffered_read_stream_fwd.hpp" +#include "asio/buffered_read_stream.hpp" +#include "asio/buffered_stream_fwd.hpp" +#include "asio/buffered_stream.hpp" +#include "asio/buffered_write_stream_fwd.hpp" +#include "asio/buffered_write_stream.hpp" +#include "asio/buffers_iterator.hpp" +#include "asio/cancel_after.hpp" +#include "asio/cancel_at.hpp" +#include "asio/cancellation_signal.hpp" +#include "asio/cancellation_state.hpp" +#include "asio/cancellation_type.hpp" +#include "asio/co_composed.hpp" +#include "asio/co_spawn.hpp" +#include "asio/completion_condition.hpp" +#include "asio/compose.hpp" +#include "asio/composed.hpp" +#include "asio/config.hpp" +#include "asio/connect.hpp" +#include "asio/connect_pipe.hpp" +#include "asio/consign.hpp" +#include "asio/coroutine.hpp" +#include "asio/defer.hpp" +#include "asio/deferred.hpp" +#include "asio/default_completion_token.hpp" +#include "asio/detached.hpp" +#include "asio/dispatch.hpp" +#include "asio/disposition.hpp" +#include "asio/error.hpp" +#include "asio/error_code.hpp" +#include "asio/execution.hpp" +#include "asio/execution/allocator.hpp" +#include "asio/execution/any_executor.hpp" +#include "asio/execution/blocking.hpp" +#include "asio/execution/blocking_adaptation.hpp" +#include "asio/execution/context.hpp" +#include "asio/execution/context_as.hpp" +#include "asio/execution/executor.hpp" +#include "asio/execution/invocable_archetype.hpp" +#include "asio/execution/mapping.hpp" +#include "asio/execution/occupancy.hpp" +#include "asio/execution/outstanding_work.hpp" +#include "asio/execution/prefer_only.hpp" +#include "asio/execution/relationship.hpp" +#include "asio/executor.hpp" +#include "asio/executor_work_guard.hpp" +#include "asio/file_base.hpp" +#include "asio/generic/basic_endpoint.hpp" +#include "asio/generic/datagram_protocol.hpp" +#include "asio/generic/raw_protocol.hpp" +#include "asio/generic/seq_packet_protocol.hpp" +#include "asio/generic/stream_protocol.hpp" +#include "asio/handler_continuation_hook.hpp" +#include "asio/high_resolution_timer.hpp" +#include "asio/immediate.hpp" +#include "asio/io_context.hpp" +#include "asio/io_context_strand.hpp" +#include "asio/ip/address.hpp" +#include "asio/ip/address_v4.hpp" +#include "asio/ip/address_v4_iterator.hpp" +#include "asio/ip/address_v4_range.hpp" +#include "asio/ip/address_v6.hpp" +#include "asio/ip/address_v6_iterator.hpp" +#include "asio/ip/address_v6_range.hpp" +#include "asio/ip/network_v4.hpp" +#include "asio/ip/network_v6.hpp" +#include "asio/ip/bad_address_cast.hpp" +#include "asio/ip/basic_endpoint.hpp" +#include "asio/ip/basic_resolver.hpp" +#include "asio/ip/basic_resolver_entry.hpp" +#include "asio/ip/basic_resolver_iterator.hpp" +#include "asio/ip/basic_resolver_query.hpp" +#include "asio/ip/host_name.hpp" +#include "asio/ip/icmp.hpp" +#include "asio/ip/multicast.hpp" +#include "asio/ip/resolver_base.hpp" +#include "asio/ip/resolver_query_base.hpp" +#include "asio/ip/tcp.hpp" +#include "asio/ip/udp.hpp" +#include "asio/ip/unicast.hpp" +#include "asio/ip/v6_only.hpp" +#include "asio/is_applicable_property.hpp" +#include "asio/is_contiguous_iterator.hpp" +#include "asio/is_executor.hpp" +#include "asio/is_read_buffered.hpp" +#include "asio/is_write_buffered.hpp" +#include "asio/local/basic_endpoint.hpp" +#include "asio/local/connect_pair.hpp" +#include "asio/local/datagram_protocol.hpp" +#include "asio/local/seq_packet_protocol.hpp" +#include "asio/local/stream_protocol.hpp" +#include "asio/multiple_exceptions.hpp" +#include "asio/packaged_task.hpp" +#include "asio/placeholders.hpp" +#include "asio/posix/basic_descriptor.hpp" +#include "asio/posix/basic_stream_descriptor.hpp" +#include "asio/posix/descriptor.hpp" +#include "asio/posix/descriptor_base.hpp" +#include "asio/posix/stream_descriptor.hpp" +#include "asio/post.hpp" +#include "asio/prefer.hpp" +#include "asio/prepend.hpp" +#include "asio/query.hpp" +#include "asio/random_access_file.hpp" +#include "asio/read.hpp" +#include "asio/read_at.hpp" +#include "asio/read_until.hpp" +#include "asio/readable_pipe.hpp" +#include "asio/recycling_allocator.hpp" +#include "asio/redirect_error.hpp" +#include "asio/registered_buffer.hpp" +#include "asio/require.hpp" +#include "asio/require_concept.hpp" +#include "asio/serial_port.hpp" +#include "asio/serial_port_base.hpp" +#include "asio/signal_set.hpp" +#include "asio/signal_set_base.hpp" +#include "asio/socket_base.hpp" +#include "asio/static_thread_pool.hpp" +#include "asio/steady_timer.hpp" +#include "asio/strand.hpp" +#include "asio/stream_file.hpp" +#include "asio/streambuf.hpp" +#include "asio/system_context.hpp" +#include "asio/system_error.hpp" +#include "asio/system_executor.hpp" +#include "asio/system_timer.hpp" +#include "asio/this_coro.hpp" +#include "asio/thread.hpp" +#include "asio/thread_pool.hpp" +#include "asio/use_awaitable.hpp" +#include "asio/use_future.hpp" +#include "asio/uses_executor.hpp" +#include "asio/version.hpp" +#include "asio/wait_traits.hpp" +#include "asio/windows/basic_object_handle.hpp" +#include "asio/windows/basic_overlapped_handle.hpp" +#include "asio/windows/basic_random_access_handle.hpp" +#include "asio/windows/basic_stream_handle.hpp" +#include "asio/windows/object_handle.hpp" +#include "asio/windows/overlapped_handle.hpp" +#include "asio/windows/overlapped_ptr.hpp" +#include "asio/windows/random_access_handle.hpp" +#include "asio/windows/stream_handle.hpp" +#include "asio/writable_pipe.hpp" +#include "asio/write.hpp" +#include "asio/write_at.hpp" + +#endif // ASIO_HPP diff --git a/Packages/asio-1.36.0/include/asio/any_completion_executor.hpp b/Packages/asio-1.36.0/include/asio/any_completion_executor.hpp new file mode 100644 index 0000000..c270b8d --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/any_completion_executor.hpp @@ -0,0 +1,336 @@ +// +// any_completion_executor.hpp +// ~~~~~~~~~~~~~~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ANY_COMPLETION_EXECUTOR_HPP +#define ASIO_ANY_COMPLETION_EXECUTOR_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#if defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) +# include "asio/executor.hpp" +#else // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) +# include "asio/execution.hpp" +#endif // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +#include "asio/detail/push_options.hpp" + +namespace asio { + +#if defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +typedef executor any_completion_executor; + +#else // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +/// Polymorphic executor type for use with I/O objects. +/** + * The @c any_completion_executor type is a polymorphic executor that supports + * the set of properties required for the execution of completion handlers. It + * is defined as the execution::any_executor class template parameterised as + * follows: + * @code execution::any_executor< + * execution::prefer_only, + * execution::prefer_only + * execution::prefer_only, + * execution::prefer_only + * > @endcode + */ +class any_completion_executor : +#if defined(GENERATING_DOCUMENTATION) + public execution::any_executor<...> +#else // defined(GENERATING_DOCUMENTATION) + public execution::any_executor< + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only + > +#endif // defined(GENERATING_DOCUMENTATION) +{ +public: +#if !defined(GENERATING_DOCUMENTATION) + typedef execution::any_executor< + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only + > base_type; + + typedef void supportable_properties_type( + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only + ); +#endif // !defined(GENERATING_DOCUMENTATION) + + /// Default constructor. + ASIO_DECL any_completion_executor() noexcept; + + /// Construct in an empty state. Equivalent effects to default constructor. + ASIO_DECL any_completion_executor(nullptr_t) noexcept; + + /// Copy constructor. + ASIO_DECL any_completion_executor( + const any_completion_executor& e) noexcept; + + /// Move constructor. + ASIO_DECL any_completion_executor( + any_completion_executor&& e) noexcept; + + /// Construct to point to the same target as another any_executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_completion_executor( + execution::any_executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_completion_executor(OtherAnyExecutor e, + constraint_t< + conditional< + !is_same::value + && is_base_of::value, + typename execution::detail::supportable_properties< + 0, supportable_properties_type>::template + is_valid_target, + false_type + >::type::value + > = 0) + : base_type(static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Construct to point to the same target as another any_executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_completion_executor(std::nothrow_t, + execution::any_executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_completion_executor(std::nothrow_t, OtherAnyExecutor e, + constraint_t< + conditional< + !is_same::value + && is_base_of::value, + typename execution::detail::supportable_properties< + 0, supportable_properties_type>::template + is_valid_target, + false_type + >::type::value + > = 0) noexcept + : base_type(std::nothrow, static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Construct to point to the same target as another any_executor. + ASIO_DECL any_completion_executor(std::nothrow_t, + const any_completion_executor& e) noexcept; + + /// Construct to point to the same target as another any_executor. + ASIO_DECL any_completion_executor(std::nothrow_t, + any_completion_executor&& e) noexcept; + + /// Construct a polymorphic wrapper for the specified executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_completion_executor(Executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_completion_executor(Executor e, + constraint_t< + conditional< + !is_same::value + && !is_base_of::value, + execution::detail::is_valid_target_executor< + Executor, supportable_properties_type>, + false_type + >::type::value + > = 0) + : base_type(static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Construct a polymorphic wrapper for the specified executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_completion_executor(std::nothrow_t, Executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_completion_executor(std::nothrow_t, Executor e, + constraint_t< + conditional< + !is_same::value + && !is_base_of::value, + execution::detail::is_valid_target_executor< + Executor, supportable_properties_type>, + false_type + >::type::value + > = 0) noexcept + : base_type(std::nothrow, static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Assignment operator. + ASIO_DECL any_completion_executor& operator=( + const any_completion_executor& e) noexcept; + + /// Move assignment operator. + ASIO_DECL any_completion_executor& operator=( + any_completion_executor&& e) noexcept; + + /// Assignment operator that sets the polymorphic wrapper to the empty state. + ASIO_DECL any_completion_executor& operator=(nullptr_t); + + /// Destructor. + ASIO_DECL ~any_completion_executor(); + + /// Swap targets with another polymorphic wrapper. + ASIO_DECL void swap(any_completion_executor& other) noexcept; + + /// Obtain a polymorphic wrapper with the specified property. + /** + * Do not call this function directly. It is intended for use with the + * asio::require and asio::prefer customisation points. + * + * For example: + * @code any_completion_executor ex = ...; + * auto ex2 = asio::require(ex, execution::relationship.fork); @endcode + */ + template + any_completion_executor require(const Property& p, + constraint_t< + traits::require_member::is_valid + > = 0) const + { + return static_cast(*this).require(p); + } + + /// Obtain a polymorphic wrapper with the specified property. + /** + * Do not call this function directly. It is intended for use with the + * asio::prefer customisation point. + * + * For example: + * @code any_completion_executor ex = ...; + * auto ex2 = asio::prefer(ex, execution::relationship.fork); @endcode + */ + template + any_completion_executor prefer(const Property& p, + constraint_t< + traits::prefer_member::is_valid + > = 0) const + { + return static_cast(*this).prefer(p); + } +}; + +#if !defined(GENERATING_DOCUMENTATION) + +template <> +ASIO_DECL any_completion_executor any_completion_executor::prefer( + const execution::outstanding_work_t::tracked_t&, int) const; + +template <> +ASIO_DECL any_completion_executor any_completion_executor::prefer( + const execution::outstanding_work_t::untracked_t&, int) const; + +template <> +ASIO_DECL any_completion_executor any_completion_executor::prefer( + const execution::relationship_t::fork_t&, int) const; + +template <> +ASIO_DECL any_completion_executor any_completion_executor::prefer( + const execution::relationship_t::continuation_t&, int) const; + +namespace traits { + +#if !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT) + +template <> +struct equality_comparable +{ + static const bool is_valid = true; + static const bool is_noexcept = true; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT) + +template +struct execute_member +{ + static const bool is_valid = true; + static const bool is_noexcept = false; + typedef void result_type; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT) + +template +struct query_member : + query_member +{ +}; + +#endif // !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT) + +template +struct require_member : + require_member +{ + typedef any_completion_executor result_type; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_PREFER_MEMBER_TRAIT) + +template +struct prefer_member : + prefer_member +{ + typedef any_completion_executor result_type; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_PREFER_MEMBER_TRAIT) + +} // namespace traits + +#endif // !defined(GENERATING_DOCUMENTATION) + +#endif // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#if defined(ASIO_HEADER_ONLY) \ + && !defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) +# include "asio/impl/any_completion_executor.ipp" +#endif // defined(ASIO_HEADER_ONLY) + // && !defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +#endif // ASIO_ANY_COMPLETION_EXECUTOR_HPP diff --git a/Packages/asio-1.36.0/include/asio/any_completion_handler.hpp b/Packages/asio-1.36.0/include/asio/any_completion_handler.hpp new file mode 100644 index 0000000..1114a09 --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/any_completion_handler.hpp @@ -0,0 +1,822 @@ +// +// any_completion_handler.hpp +// ~~~~~~~~~~~~~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ANY_COMPLETION_HANDLER_HPP +#define ASIO_ANY_COMPLETION_HANDLER_HPP + +#include "asio/detail/config.hpp" +#include +#include +#include +#include +#include "asio/any_completion_executor.hpp" +#include "asio/any_io_executor.hpp" +#include "asio/associated_allocator.hpp" +#include "asio/associated_cancellation_slot.hpp" +#include "asio/associated_executor.hpp" +#include "asio/associated_immediate_executor.hpp" +#include "asio/cancellation_state.hpp" +#include "asio/recycling_allocator.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { +namespace detail { + +class any_completion_handler_impl_base +{ +public: + template + explicit any_completion_handler_impl_base(S&& slot) + : cancel_state_(static_cast(slot), enable_total_cancellation()) + { + } + + cancellation_slot get_cancellation_slot() const noexcept + { + return cancel_state_.slot(); + } + +private: + cancellation_state cancel_state_; +}; + +template +class any_completion_handler_impl : + public any_completion_handler_impl_base +{ +public: + template + any_completion_handler_impl(S&& slot, H&& h) + : any_completion_handler_impl_base(static_cast(slot)), + handler_(static_cast(h)) + { + } + + struct uninit_deleter + { + typename std::allocator_traits< + associated_allocator_t>>::template + rebind_alloc alloc; + + void operator()(any_completion_handler_impl* ptr) + { + std::allocator_traits::deallocate(alloc, ptr, 1); + } + }; + + struct deleter + { + typename std::allocator_traits< + associated_allocator_t>>::template + rebind_alloc alloc; + + void operator()(any_completion_handler_impl* ptr) + { + std::allocator_traits::destroy(alloc, ptr); + std::allocator_traits::deallocate(alloc, ptr, 1); + } + }; + + template + static any_completion_handler_impl* create(S&& slot, H&& h) + { + uninit_deleter d{ + (get_associated_allocator)(h, + asio::recycling_allocator())}; + + std::unique_ptr uninit_ptr( + std::allocator_traits::allocate(d.alloc, 1), d); + + any_completion_handler_impl* ptr = + new (uninit_ptr.get()) any_completion_handler_impl( + static_cast(slot), static_cast(h)); + + uninit_ptr.release(); + return ptr; + } + + void destroy() + { + deleter d{ + (get_associated_allocator)(handler_, + asio::recycling_allocator())}; + + d(this); + } + + any_completion_executor executor( + const any_completion_executor& candidate) const noexcept + { + return any_completion_executor(std::nothrow, + (get_associated_executor)(handler_, candidate)); + } + + any_completion_executor immediate_executor( + const any_io_executor& candidate) const noexcept + { + return any_completion_executor(std::nothrow, + (get_associated_immediate_executor)(handler_, candidate)); + } + + void* allocate(std::size_t size, std::size_t align_size) const + { + typename std::allocator_traits< + associated_allocator_t>>::template + rebind_alloc alloc( + (get_associated_allocator)(handler_, + asio::recycling_allocator())); + + std::size_t space = size + align_size - 1; + unsigned char* base = + std::allocator_traits::allocate( + alloc, space + sizeof(std::ptrdiff_t)); + + void* p = base; + if (detail::align(align_size, size, p, space)) + { + std::ptrdiff_t off = static_cast(p) - base; + std::memcpy(static_cast(p) + size, &off, sizeof(off)); + return p; + } + + std::bad_alloc ex; + asio::detail::throw_exception(ex); + return nullptr; + } + + void deallocate(void* p, std::size_t size, std::size_t align) const + { + if (p) + { + typename std::allocator_traits< + associated_allocator_t>>::template + rebind_alloc alloc( + (get_associated_allocator)(handler_, + asio::recycling_allocator())); + + std::ptrdiff_t off; + std::memcpy(&off, static_cast(p) + size, sizeof(off)); + unsigned char* base = static_cast(p) - off; + + std::allocator_traits::deallocate( + alloc, base, size + align -1 + sizeof(std::ptrdiff_t)); + } + } + + template + void call(Args&&... args) + { + deleter d{ + (get_associated_allocator)(handler_, + asio::recycling_allocator())}; + + std::unique_ptr ptr(this, d); + Handler handler(static_cast(handler_)); + ptr.reset(); + + static_cast(handler)( + static_cast(args)...); + } + +private: + Handler handler_; +}; + +template +class any_completion_handler_call_fn; + +template +class any_completion_handler_call_fn +{ +public: + using type = void(*)(any_completion_handler_impl_base*, Args...); + + constexpr any_completion_handler_call_fn(type fn) + : call_fn_(fn) + { + } + + void call(any_completion_handler_impl_base* impl, Args... args) const + { + call_fn_(impl, static_cast(args)...); + } + + template + static void impl(any_completion_handler_impl_base* impl, Args... args) + { + static_cast*>(impl)->call( + static_cast(args)...); + } + +private: + type call_fn_; +}; + +template +class any_completion_handler_call_fns; + +template +class any_completion_handler_call_fns : + public any_completion_handler_call_fn +{ +public: + using any_completion_handler_call_fn< + Signature>::any_completion_handler_call_fn; + using any_completion_handler_call_fn::call; +}; + +template +class any_completion_handler_call_fns : + public any_completion_handler_call_fn, + public any_completion_handler_call_fns +{ +public: + template + constexpr any_completion_handler_call_fns(CallFn fn, CallFns... fns) + : any_completion_handler_call_fn(fn), + any_completion_handler_call_fns(fns...) + { + } + + using any_completion_handler_call_fn::call; + using any_completion_handler_call_fns::call; +}; + +class any_completion_handler_destroy_fn +{ +public: + using type = void(*)(any_completion_handler_impl_base*); + + constexpr any_completion_handler_destroy_fn(type fn) + : destroy_fn_(fn) + { + } + + void destroy(any_completion_handler_impl_base* impl) const + { + destroy_fn_(impl); + } + + template + static void impl(any_completion_handler_impl_base* impl) + { + static_cast*>(impl)->destroy(); + } + +private: + type destroy_fn_; +}; + +class any_completion_handler_executor_fn +{ +public: + using type = any_completion_executor(*)( + any_completion_handler_impl_base*, const any_completion_executor&); + + constexpr any_completion_handler_executor_fn(type fn) + : executor_fn_(fn) + { + } + + any_completion_executor executor(any_completion_handler_impl_base* impl, + const any_completion_executor& candidate) const + { + return executor_fn_(impl, candidate); + } + + template + static any_completion_executor impl(any_completion_handler_impl_base* impl, + const any_completion_executor& candidate) + { + return static_cast*>(impl)->executor( + candidate); + } + +private: + type executor_fn_; +}; + +class any_completion_handler_immediate_executor_fn +{ +public: + using type = any_completion_executor(*)( + any_completion_handler_impl_base*, const any_io_executor&); + + constexpr any_completion_handler_immediate_executor_fn(type fn) + : immediate_executor_fn_(fn) + { + } + + any_completion_executor immediate_executor( + any_completion_handler_impl_base* impl, + const any_io_executor& candidate) const + { + return immediate_executor_fn_(impl, candidate); + } + + template + static any_completion_executor impl(any_completion_handler_impl_base* impl, + const any_io_executor& candidate) + { + return static_cast*>( + impl)->immediate_executor(candidate); + } + +private: + type immediate_executor_fn_; +}; + +class any_completion_handler_allocate_fn +{ +public: + using type = void*(*)(any_completion_handler_impl_base*, + std::size_t, std::size_t); + + constexpr any_completion_handler_allocate_fn(type fn) + : allocate_fn_(fn) + { + } + + void* allocate(any_completion_handler_impl_base* impl, + std::size_t size, std::size_t align) const + { + return allocate_fn_(impl, size, align); + } + + template + static void* impl(any_completion_handler_impl_base* impl, + std::size_t size, std::size_t align) + { + return static_cast*>(impl)->allocate( + size, align); + } + +private: + type allocate_fn_; +}; + +class any_completion_handler_deallocate_fn +{ +public: + using type = void(*)(any_completion_handler_impl_base*, + void*, std::size_t, std::size_t); + + constexpr any_completion_handler_deallocate_fn(type fn) + : deallocate_fn_(fn) + { + } + + void deallocate(any_completion_handler_impl_base* impl, + void* p, std::size_t size, std::size_t align) const + { + deallocate_fn_(impl, p, size, align); + } + + template + static void impl(any_completion_handler_impl_base* impl, + void* p, std::size_t size, std::size_t align) + { + static_cast*>(impl)->deallocate( + p, size, align); + } + +private: + type deallocate_fn_; +}; + +template +class any_completion_handler_fn_table + : private any_completion_handler_destroy_fn, + private any_completion_handler_executor_fn, + private any_completion_handler_immediate_executor_fn, + private any_completion_handler_allocate_fn, + private any_completion_handler_deallocate_fn, + private any_completion_handler_call_fns +{ +public: + template + constexpr any_completion_handler_fn_table( + any_completion_handler_destroy_fn::type destroy_fn, + any_completion_handler_executor_fn::type executor_fn, + any_completion_handler_immediate_executor_fn::type immediate_executor_fn, + any_completion_handler_allocate_fn::type allocate_fn, + any_completion_handler_deallocate_fn::type deallocate_fn, + CallFns... call_fns) + : any_completion_handler_destroy_fn(destroy_fn), + any_completion_handler_executor_fn(executor_fn), + any_completion_handler_immediate_executor_fn(immediate_executor_fn), + any_completion_handler_allocate_fn(allocate_fn), + any_completion_handler_deallocate_fn(deallocate_fn), + any_completion_handler_call_fns(call_fns...) + { + } + + using any_completion_handler_destroy_fn::destroy; + using any_completion_handler_executor_fn::executor; + using any_completion_handler_immediate_executor_fn::immediate_executor; + using any_completion_handler_allocate_fn::allocate; + using any_completion_handler_deallocate_fn::deallocate; + using any_completion_handler_call_fns::call; +}; + +template +struct any_completion_handler_fn_table_instance +{ + static constexpr any_completion_handler_fn_table + value = any_completion_handler_fn_table( + &any_completion_handler_destroy_fn::impl, + &any_completion_handler_executor_fn::impl, + &any_completion_handler_immediate_executor_fn::impl, + &any_completion_handler_allocate_fn::impl, + &any_completion_handler_deallocate_fn::impl, + &any_completion_handler_call_fn::template impl...); +}; + +template +constexpr any_completion_handler_fn_table +any_completion_handler_fn_table_instance::value; + +} // namespace detail + +template +class any_completion_handler; + +/// An allocator type that forwards memory allocation operations through an +/// instance of @c any_completion_handler. +template +class any_completion_handler_allocator +{ +private: + template + friend class any_completion_handler; + + template + friend class any_completion_handler_allocator; + + const detail::any_completion_handler_fn_table* fn_table_; + detail::any_completion_handler_impl_base* impl_; + + constexpr any_completion_handler_allocator(int, + const any_completion_handler& h) noexcept + : fn_table_(h.fn_table_), + impl_(h.impl_) + { + } + +public: + /// The type of objects that may be allocated by the allocator. + typedef T value_type; + + /// Rebinds an allocator to another value type. + template + struct rebind + { + /// Specifies the type of the rebound allocator. + typedef any_completion_handler_allocator other; + }; + + /// Construct from another @c any_completion_handler_allocator. + template + constexpr any_completion_handler_allocator( + const any_completion_handler_allocator& a) + noexcept + : fn_table_(a.fn_table_), + impl_(a.impl_) + { + } + + /// Equality operator. + constexpr bool operator==( + const any_completion_handler_allocator& other) const noexcept + { + return fn_table_ == other.fn_table_ && impl_ == other.impl_; + } + + /// Inequality operator. + constexpr bool operator!=( + const any_completion_handler_allocator& other) const noexcept + { + return fn_table_ != other.fn_table_ || impl_ != other.impl_; + } + + /// Allocate space for @c n objects of the allocator's value type. + T* allocate(std::size_t n) const + { + if (fn_table_) + { + return static_cast( + fn_table_->allocate( + impl_, sizeof(T) * n, alignof(T))); + } + std::bad_alloc ex; + asio::detail::throw_exception(ex); + return nullptr; + } + + /// Deallocate space for @c n objects of the allocator's value type. + void deallocate(T* p, std::size_t n) const + { + fn_table_->deallocate(impl_, p, sizeof(T) * n, alignof(T)); + } +}; + +/// A protoco-allocator type that may be rebound to obtain an allocator that +/// forwards memory allocation operations through an instance of +/// @c any_completion_handler. +template +class any_completion_handler_allocator +{ +private: + template + friend class any_completion_handler; + + template + friend class any_completion_handler_allocator; + + const detail::any_completion_handler_fn_table* fn_table_; + detail::any_completion_handler_impl_base* impl_; + + constexpr any_completion_handler_allocator(int, + const any_completion_handler& h) noexcept + : fn_table_(h.fn_table_), + impl_(h.impl_) + { + } + +public: + /// @c void as no objects can be allocated through a proto-allocator. + typedef void value_type; + + /// Rebinds an allocator to another value type. + template + struct rebind + { + /// Specifies the type of the rebound allocator. + typedef any_completion_handler_allocator other; + }; + + /// Construct from another @c any_completion_handler_allocator. + template + constexpr any_completion_handler_allocator( + const any_completion_handler_allocator& a) + noexcept + : fn_table_(a.fn_table_), + impl_(a.impl_) + { + } + + /// Equality operator. + constexpr bool operator==( + const any_completion_handler_allocator& other) const noexcept + { + return fn_table_ == other.fn_table_ && impl_ == other.impl_; + } + + /// Inequality operator. + constexpr bool operator!=( + const any_completion_handler_allocator& other) const noexcept + { + return fn_table_ != other.fn_table_ || impl_ != other.impl_; + } +}; + +/// Polymorphic wrapper for completion handlers. +/** + * The @c any_completion_handler class template is a polymorphic wrapper for + * completion handlers that propagates the associated executor, associated + * allocator, and associated cancellation slot through a type-erasing interface. + * + * When using @c any_completion_handler, specify one or more completion + * signatures as template parameters. These will dictate the arguments that may + * be passed to the handler through the polymorphic interface. + * + * Typical uses for @c any_completion_handler include: + * + * @li Separate compilation of asynchronous operation implementations. + * + * @li Enabling interoperability between asynchronous operations and virtual + * functions. + */ +template +class any_completion_handler +{ +#if !defined(GENERATING_DOCUMENTATION) +private: + template + friend class any_completion_handler_allocator; + + template + friend struct associated_executor; + + template + friend struct associated_immediate_executor; + + const detail::any_completion_handler_fn_table* fn_table_; + detail::any_completion_handler_impl_base* impl_; +#endif // !defined(GENERATING_DOCUMENTATION) + +public: + /// The associated allocator type. + using allocator_type = any_completion_handler_allocator; + + /// The associated cancellation slot type. + using cancellation_slot_type = cancellation_slot; + + /// Construct an @c any_completion_handler in an empty state, without a target + /// object. + constexpr any_completion_handler() + : fn_table_(nullptr), + impl_(nullptr) + { + } + + /// Construct an @c any_completion_handler in an empty state, without a target + /// object. + constexpr any_completion_handler(nullptr_t) + : fn_table_(nullptr), + impl_(nullptr) + { + } + + /// Construct an @c any_completion_handler to contain the specified target. + template > + any_completion_handler(H&& h, + constraint_t< + !is_same, any_completion_handler>::value + > = 0) + : fn_table_( + &detail::any_completion_handler_fn_table_instance< + Handler, Signatures...>::value), + impl_(detail::any_completion_handler_impl::create( + (get_associated_cancellation_slot)(h), static_cast(h))) + { + } + + /// Move-construct an @c any_completion_handler from another. + /** + * After the operation, the moved-from object @c other has no target. + */ + any_completion_handler(any_completion_handler&& other) noexcept + : fn_table_(other.fn_table_), + impl_(other.impl_) + { + other.fn_table_ = nullptr; + other.impl_ = nullptr; + } + + /// Move-assign an @c any_completion_handler from another. + /** + * After the operation, the moved-from object @c other has no target. + */ + any_completion_handler& operator=( + any_completion_handler&& other) noexcept + { + any_completion_handler( + static_cast(other)).swap(*this); + return *this; + } + + /// Assignment operator that sets the polymorphic wrapper to the empty state. + any_completion_handler& operator=(nullptr_t) noexcept + { + any_completion_handler().swap(*this); + return *this; + } + + /// Destructor. + ~any_completion_handler() + { + if (impl_) + fn_table_->destroy(impl_); + } + + /// Test if the polymorphic wrapper is empty. + constexpr explicit operator bool() const noexcept + { + return impl_ != nullptr; + } + + /// Test if the polymorphic wrapper is non-empty. + constexpr bool operator!() const noexcept + { + return impl_ == nullptr; + } + + /// Swap the content of an @c any_completion_handler with another. + void swap(any_completion_handler& other) noexcept + { + std::swap(fn_table_, other.fn_table_); + std::swap(impl_, other.impl_); + } + + /// Get the associated allocator. + allocator_type get_allocator() const noexcept + { + return allocator_type(0, *this); + } + + /// Get the associated cancellation slot. + cancellation_slot_type get_cancellation_slot() const noexcept + { + return impl_ ? impl_->get_cancellation_slot() : cancellation_slot_type(); + } + + /// Function call operator. + /** + * Invokes target completion handler with the supplied arguments. + * + * This function may only be called once, as the target handler is moved from. + * The polymorphic wrapper is left in an empty state. + * + * Throws @c std::bad_function_call if the polymorphic wrapper is empty. + */ + template + auto operator()(Args&&... args) + -> decltype(fn_table_->call(impl_, static_cast(args)...)) + { + if (detail::any_completion_handler_impl_base* impl = impl_) + { + impl_ = nullptr; + return fn_table_->call(impl, static_cast(args)...); + } + std::bad_function_call ex; + asio::detail::throw_exception(ex); + } + + /// Equality operator. + friend constexpr bool operator==( + const any_completion_handler& a, nullptr_t) noexcept + { + return a.impl_ == nullptr; + } + + /// Equality operator. + friend constexpr bool operator==( + nullptr_t, const any_completion_handler& b) noexcept + { + return nullptr == b.impl_; + } + + /// Inequality operator. + friend constexpr bool operator!=( + const any_completion_handler& a, nullptr_t) noexcept + { + return a.impl_ != nullptr; + } + + /// Inequality operator. + friend constexpr bool operator!=( + nullptr_t, const any_completion_handler& b) noexcept + { + return nullptr != b.impl_; + } +}; + +template +struct associated_executor, Candidate> +{ + using type = any_completion_executor; + + static type get(const any_completion_handler& handler, + const Candidate& candidate = Candidate()) noexcept + { + any_completion_executor any_candidate(std::nothrow, candidate); + return handler.fn_table_ + ? handler.fn_table_->executor(handler.impl_, any_candidate) + : any_candidate; + } +}; + +template +struct associated_immediate_executor< + any_completion_handler, Candidate> +{ + using type = any_completion_executor; + + static type get(const any_completion_handler& handler, + const Candidate& candidate = Candidate()) noexcept + { + any_io_executor any_candidate(std::nothrow, candidate); + return handler.fn_table_ + ? handler.fn_table_->immediate_executor(handler.impl_, any_candidate) + : any_candidate; + } +}; + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#endif // ASIO_ANY_COMPLETION_HANDLER_HPP diff --git a/Packages/asio-1.36.0/include/asio/any_io_executor.hpp b/Packages/asio-1.36.0/include/asio/any_io_executor.hpp new file mode 100644 index 0000000..a6c9c8d --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/any_io_executor.hpp @@ -0,0 +1,351 @@ +// +// any_io_executor.hpp +// ~~~~~~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ANY_IO_EXECUTOR_HPP +#define ASIO_ANY_IO_EXECUTOR_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#if defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) +# include "asio/executor.hpp" +#else // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) +# include "asio/execution.hpp" +# include "asio/execution_context.hpp" +#endif // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +#include "asio/detail/push_options.hpp" + +namespace asio { + +#if defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +typedef executor any_io_executor; + +#else // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +/// Polymorphic executor type for use with I/O objects. +/** + * The @c any_io_executor type is a polymorphic executor that supports the set + * of properties required by I/O objects. It is defined as the + * execution::any_executor class template parameterised as follows: + * @code execution::any_executor< + * execution::context_as_t, + * execution::blocking_t::never_t, + * execution::prefer_only, + * execution::prefer_only, + * execution::prefer_only, + * execution::prefer_only, + * execution::prefer_only + * > @endcode + */ +class any_io_executor : +#if defined(GENERATING_DOCUMENTATION) + public execution::any_executor<...> +#else // defined(GENERATING_DOCUMENTATION) + public execution::any_executor< + execution::context_as_t, + execution::blocking_t::never_t, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only + > +#endif // defined(GENERATING_DOCUMENTATION) +{ +public: +#if !defined(GENERATING_DOCUMENTATION) + typedef execution::any_executor< + execution::context_as_t, + execution::blocking_t::never_t, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only + > base_type; + + typedef void supportable_properties_type( + execution::context_as_t, + execution::blocking_t::never_t, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only, + execution::prefer_only + ); +#endif // !defined(GENERATING_DOCUMENTATION) + + /// Default constructor. + ASIO_DECL any_io_executor() noexcept; + + /// Construct in an empty state. Equivalent effects to default constructor. + ASIO_DECL any_io_executor(nullptr_t) noexcept; + + /// Copy constructor. + ASIO_DECL any_io_executor(const any_io_executor& e) noexcept; + + /// Move constructor. + ASIO_DECL any_io_executor(any_io_executor&& e) noexcept; + + /// Construct to point to the same target as another any_executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_io_executor(execution::any_executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_io_executor(OtherAnyExecutor e, + constraint_t< + conditional_t< + !is_same::value + && is_base_of::value, + typename execution::detail::supportable_properties< + 0, supportable_properties_type>::template + is_valid_target, + false_type + >::value + > = 0) + : base_type(static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Construct to point to the same target as another any_executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_io_executor(std::nothrow_t, + execution::any_executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_io_executor(std::nothrow_t, OtherAnyExecutor e, + constraint_t< + conditional_t< + !is_same::value + && is_base_of::value, + typename execution::detail::supportable_properties< + 0, supportable_properties_type>::template + is_valid_target, + false_type + >::value + > = 0) noexcept + : base_type(std::nothrow, static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Construct to point to the same target as another any_executor. + ASIO_DECL any_io_executor(std::nothrow_t, + const any_io_executor& e) noexcept; + + /// Construct to point to the same target as another any_executor. + ASIO_DECL any_io_executor(std::nothrow_t, any_io_executor&& e) noexcept; + + /// Construct a polymorphic wrapper for the specified executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_io_executor(Executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_io_executor(Executor e, + constraint_t< + conditional_t< + !is_same::value + && !is_base_of::value, + execution::detail::is_valid_target_executor< + Executor, supportable_properties_type>, + false_type + >::value + > = 0) + : base_type(static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Construct a polymorphic wrapper for the specified executor. +#if defined(GENERATING_DOCUMENTATION) + template + any_io_executor(std::nothrow_t, Executor e); +#else // defined(GENERATING_DOCUMENTATION) + template + any_io_executor(std::nothrow_t, Executor e, + constraint_t< + conditional_t< + !is_same::value + && !is_base_of::value, + execution::detail::is_valid_target_executor< + Executor, supportable_properties_type>, + false_type + >::value + > = 0) noexcept + : base_type(std::nothrow, static_cast(e)) + { + } +#endif // defined(GENERATING_DOCUMENTATION) + + /// Assignment operator. + ASIO_DECL any_io_executor& operator=( + const any_io_executor& e) noexcept; + + /// Move assignment operator. + ASIO_DECL any_io_executor& operator=(any_io_executor&& e) noexcept; + + /// Assignment operator that sets the polymorphic wrapper to the empty state. + ASIO_DECL any_io_executor& operator=(nullptr_t); + + /// Destructor. + ASIO_DECL ~any_io_executor(); + + /// Swap targets with another polymorphic wrapper. + ASIO_DECL void swap(any_io_executor& other) noexcept; + + /// Obtain a polymorphic wrapper with the specified property. + /** + * Do not call this function directly. It is intended for use with the + * asio::require and asio::prefer customisation points. + * + * For example: + * @code any_io_executor ex = ...; + * auto ex2 = asio::require(ex, execution::blocking.possibly); @endcode + */ + template + any_io_executor require(const Property& p, + constraint_t< + traits::require_member::is_valid + > = 0) const + { + return static_cast(*this).require(p); + } + + /// Obtain a polymorphic wrapper with the specified property. + /** + * Do not call this function directly. It is intended for use with the + * asio::prefer customisation point. + * + * For example: + * @code any_io_executor ex = ...; + * auto ex2 = asio::prefer(ex, execution::blocking.possibly); @endcode + */ + template + any_io_executor prefer(const Property& p, + constraint_t< + traits::prefer_member::is_valid + > = 0) const + { + return static_cast(*this).prefer(p); + } +}; + +#if !defined(GENERATING_DOCUMENTATION) + +template <> +ASIO_DECL any_io_executor any_io_executor::require( + const execution::blocking_t::never_t&, int) const; + +template <> +ASIO_DECL any_io_executor any_io_executor::prefer( + const execution::blocking_t::possibly_t&, int) const; + +template <> +ASIO_DECL any_io_executor any_io_executor::prefer( + const execution::outstanding_work_t::tracked_t&, int) const; + +template <> +ASIO_DECL any_io_executor any_io_executor::prefer( + const execution::outstanding_work_t::untracked_t&, int) const; + +template <> +ASIO_DECL any_io_executor any_io_executor::prefer( + const execution::relationship_t::fork_t&, int) const; + +template <> +ASIO_DECL any_io_executor any_io_executor::prefer( + const execution::relationship_t::continuation_t&, int) const; + +namespace traits { + +#if !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT) + +template <> +struct equality_comparable +{ + static const bool is_valid = true; + static const bool is_noexcept = true; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT) + +template +struct execute_member +{ + static const bool is_valid = true; + static const bool is_noexcept = false; + typedef void result_type; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT) + +template +struct query_member : + query_member +{ +}; + +#endif // !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT) + +template +struct require_member : + require_member +{ + typedef any_io_executor result_type; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT) + +#if !defined(ASIO_HAS_DEDUCED_PREFER_MEMBER_TRAIT) + +template +struct prefer_member : + prefer_member +{ + typedef any_io_executor result_type; +}; + +#endif // !defined(ASIO_HAS_DEDUCED_PREFER_MEMBER_TRAIT) + +} // namespace traits + +#endif // !defined(GENERATING_DOCUMENTATION) + +#endif // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#if defined(ASIO_HEADER_ONLY) \ + && !defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) +# include "asio/impl/any_io_executor.ipp" +#endif // defined(ASIO_HEADER_ONLY) + // && !defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT) + +#endif // ASIO_ANY_IO_EXECUTOR_HPP diff --git a/Packages/asio-1.36.0/include/asio/append.hpp b/Packages/asio-1.36.0/include/asio/append.hpp new file mode 100644 index 0000000..e0167e1 --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/append.hpp @@ -0,0 +1,65 @@ +// +// append.hpp +// ~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_APPEND_HPP +#define ASIO_APPEND_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#include +#include "asio/detail/type_traits.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { + +/// Completion token type used to specify that the completion handler +/// arguments should be passed additional values after the results of the +/// operation. +template +class append_t +{ +public: + /// Constructor. + template + constexpr explicit append_t(T&& completion_token, V&&... values) + : token_(static_cast(completion_token)), + values_(static_cast(values)...) + { + } + +//private: + CompletionToken token_; + std::tuple values_; +}; + +/// Completion token type used to specify that the completion handler +/// arguments should be passed additional values after the results of the +/// operation. +template +ASIO_NODISCARD inline constexpr +append_t, decay_t...> +append(CompletionToken&& completion_token, Values&&... values) +{ + return append_t, decay_t...>( + static_cast(completion_token), + static_cast(values)...); +} + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#include "asio/impl/append.hpp" + +#endif // ASIO_APPEND_HPP diff --git a/Packages/asio-1.36.0/include/asio/as_tuple.hpp b/Packages/asio-1.36.0/include/asio/as_tuple.hpp new file mode 100644 index 0000000..d3250b7 --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/as_tuple.hpp @@ -0,0 +1,152 @@ +// +// as_tuple.hpp +// ~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_AS_TUPLE_HPP +#define ASIO_AS_TUPLE_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#include "asio/detail/type_traits.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { + +/// A @ref completion_token adapter used to specify that the completion handler +/// arguments should be combined into a single tuple argument. +/** + * The as_tuple_t class is used to indicate that any arguments to the + * completion handler should be combined and passed as a single tuple argument. + * The arguments are first moved into a @c std::tuple and that tuple is then + * passed to the completion handler. + */ +template +class as_tuple_t +{ +public: + /// Tag type used to prevent the "default" constructor from being used for + /// conversions. + struct default_constructor_tag {}; + + /// Default constructor. + /** + * This constructor is only valid if the underlying completion token is + * default constructible and move constructible. The underlying completion + * token is itself defaulted as an argument to allow it to capture a source + * location. + */ + constexpr as_tuple_t( + default_constructor_tag = default_constructor_tag(), + CompletionToken token = CompletionToken()) + : token_(static_cast(token)) + { + } + + /// Constructor. + template + constexpr explicit as_tuple_t( + T&& completion_token) + : token_(static_cast(completion_token)) + { + } + + /// Adapts an executor to add the @c as_tuple_t completion token as the + /// default. + template + struct executor_with_default : InnerExecutor + { + /// Specify @c as_tuple_t as the default completion token type. + typedef as_tuple_t default_completion_token_type; + + /// Construct the adapted executor from the inner executor type. + template + executor_with_default(const InnerExecutor1& ex, + constraint_t< + conditional_t< + !is_same::value, + is_convertible, + false_type + >::value + > = 0) noexcept + : InnerExecutor(ex) + { + } + }; + + /// Type alias to adapt an I/O object to use @c as_tuple_t as its + /// default completion token type. + template + using as_default_on_t = typename T::template rebind_executor< + executor_with_default>::other; + + /// Function helper to adapt an I/O object to use @c as_tuple_t as its + /// default completion token type. + template + static typename decay_t::template rebind_executor< + executor_with_default::executor_type> + >::other + as_default_on(T&& object) + { + return typename decay_t::template rebind_executor< + executor_with_default::executor_type> + >::other(static_cast(object)); + } + +//private: + CompletionToken token_; +}; + +/// A function object type that adapts a @ref completion_token to specify that +/// the completion handler arguments should be combined into a single tuple +/// argument. +/** + * May also be used directly as a completion token, in which case it adapts the + * asynchronous operation's default completion token (or asio::deferred + * if no default is available). + */ +struct partial_as_tuple +{ + /// Default constructor. + constexpr partial_as_tuple() + { + } + + /// Adapt a @ref completion_token to specify that the completion handler + /// arguments should be combined into a single tuple argument. + template + ASIO_NODISCARD inline + constexpr as_tuple_t> + operator()(CompletionToken&& completion_token) const + { + return as_tuple_t>( + static_cast(completion_token)); + } +}; + +/// A function object that adapts a @ref completion_token to specify that the +/// completion handler arguments should be combined into a single tuple +/// argument. +/** + * May also be used directly as a completion token, in which case it adapts the + * asynchronous operation's default completion token (or asio::deferred + * if no default is available). + */ +ASIO_INLINE_VARIABLE constexpr partial_as_tuple as_tuple; + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#include "asio/impl/as_tuple.hpp" + +#endif // ASIO_AS_TUPLE_HPP diff --git a/Packages/asio-1.36.0/include/asio/associated_allocator.hpp b/Packages/asio-1.36.0/include/asio/associated_allocator.hpp new file mode 100644 index 0000000..c15ff6d --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/associated_allocator.hpp @@ -0,0 +1,214 @@ +// +// associated_allocator.hpp +// ~~~~~~~~~~~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ASSOCIATED_ALLOCATOR_HPP +#define ASIO_ASSOCIATED_ALLOCATOR_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#include +#include "asio/associator.hpp" +#include "asio/detail/functional.hpp" +#include "asio/detail/type_traits.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { + +template +struct associated_allocator; + +namespace detail { + +template +struct has_allocator_type : false_type +{ +}; + +template +struct has_allocator_type> : true_type +{ +}; + +template +struct associated_allocator_impl +{ + typedef void asio_associated_allocator_is_unspecialised; + + typedef A type; + + static type get(const T&) noexcept + { + return type(); + } + + static const type& get(const T&, const A& a) noexcept + { + return a; + } +}; + +template +struct associated_allocator_impl> +{ + typedef typename T::allocator_type type; + + static auto get(const T& t) noexcept + -> decltype(t.get_allocator()) + { + return t.get_allocator(); + } + + static auto get(const T& t, const A&) noexcept + -> decltype(t.get_allocator()) + { + return t.get_allocator(); + } +}; + +template +struct associated_allocator_impl::value + >, + void_t< + typename associator::type + >> : associator +{ +}; + +} // namespace detail + +/// Traits type used to obtain the allocator associated with an object. +/** + * A program may specialise this traits type if the @c T template parameter in + * the specialisation is a user-defined type. The template parameter @c + * Allocator shall be a type meeting the Allocator requirements. + * + * Specialisations shall meet the following requirements, where @c t is a const + * reference to an object of type @c T, and @c a is an object of type @c + * Allocator. + * + * @li Provide a nested typedef @c type that identifies a type meeting the + * Allocator requirements. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t) and with return type @c type or a (possibly const) reference to @c + * type. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t,a) and with return type @c type or a (possibly const) reference to @c + * type. + */ +template > +struct associated_allocator +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_allocator_impl +#endif // !defined(GENERATING_DOCUMENTATION) +{ +#if defined(GENERATING_DOCUMENTATION) + /// If @c T has a nested type @c allocator_type, T::allocator_type. + /// Otherwise @c Allocator. + typedef see_below type; + + /// If @c T has a nested type @c allocator_type, returns + /// t.get_allocator(). Otherwise returns @c type(). + static decltype(auto) get(const T& t) noexcept; + + /// If @c T has a nested type @c allocator_type, returns + /// t.get_allocator(). Otherwise returns @c a. + static decltype(auto) get(const T& t, const Allocator& a) noexcept; +#endif // defined(GENERATING_DOCUMENTATION) +}; + +/// Helper function to obtain an object's associated allocator. +/** + * @returns associated_allocator::get(t) + */ +template +ASIO_NODISCARD inline typename associated_allocator::type +get_associated_allocator(const T& t) noexcept +{ + return associated_allocator::get(t); +} + +/// Helper function to obtain an object's associated allocator. +/** + * @returns associated_allocator::get(t, a) + */ +template +ASIO_NODISCARD inline auto get_associated_allocator( + const T& t, const Allocator& a) noexcept + -> decltype(associated_allocator::get(t, a)) +{ + return associated_allocator::get(t, a); +} + +template > +using associated_allocator_t + = typename associated_allocator::type; + +namespace detail { + +template +struct associated_allocator_forwarding_base +{ +}; + +template +struct associated_allocator_forwarding_base::asio_associated_allocator_is_unspecialised, + void + >::value + >> +{ + typedef void asio_associated_allocator_is_unspecialised; +}; + +} // namespace detail + +/// Specialisation of associated_allocator for @c std::reference_wrapper. +template +struct associated_allocator, Allocator> +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_allocator_forwarding_base +#endif // !defined(GENERATING_DOCUMENTATION) +{ + /// Forwards @c type to the associator specialisation for the unwrapped type + /// @c T. + typedef typename associated_allocator::type type; + + /// Forwards the request to get the allocator to the associator specialisation + /// for the unwrapped type @c T. + static type get(reference_wrapper t) noexcept + { + return associated_allocator::get(t.get()); + } + + /// Forwards the request to get the allocator to the associator specialisation + /// for the unwrapped type @c T. + static auto get(reference_wrapper t, const Allocator& a) noexcept + -> decltype(associated_allocator::get(t.get(), a)) + { + return associated_allocator::get(t.get(), a); + } +}; + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#endif // ASIO_ASSOCIATED_ALLOCATOR_HPP diff --git a/Packages/asio-1.36.0/include/asio/associated_cancellation_slot.hpp b/Packages/asio-1.36.0/include/asio/associated_cancellation_slot.hpp new file mode 100644 index 0000000..79dccec --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/associated_cancellation_slot.hpp @@ -0,0 +1,221 @@ +// +// associated_cancellation_slot.hpp +// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ASSOCIATED_CANCELLATION_SLOT_HPP +#define ASIO_ASSOCIATED_CANCELLATION_SLOT_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#include "asio/associator.hpp" +#include "asio/cancellation_signal.hpp" +#include "asio/detail/functional.hpp" +#include "asio/detail/type_traits.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { + +template +struct associated_cancellation_slot; + +namespace detail { + +template +struct has_cancellation_slot_type : false_type +{ +}; + +template +struct has_cancellation_slot_type> + : true_type +{ +}; + +template +struct associated_cancellation_slot_impl +{ + typedef void asio_associated_cancellation_slot_is_unspecialised; + + typedef S type; + + static type get(const T&) noexcept + { + return type(); + } + + static const type& get(const T&, const S& s) noexcept + { + return s; + } +}; + +template +struct associated_cancellation_slot_impl> +{ + typedef typename T::cancellation_slot_type type; + + static auto get(const T& t) noexcept + -> decltype(t.get_cancellation_slot()) + { + return t.get_cancellation_slot(); + } + + static auto get(const T& t, const S&) noexcept + -> decltype(t.get_cancellation_slot()) + { + return t.get_cancellation_slot(); + } +}; + +template +struct associated_cancellation_slot_impl::value + >, + void_t< + typename associator::type + >> : associator +{ +}; + +} // namespace detail + +/// Traits type used to obtain the cancellation_slot associated with an object. +/** + * A program may specialise this traits type if the @c T template parameter in + * the specialisation is a user-defined type. The template parameter @c + * CancellationSlot shall be a type meeting the CancellationSlot requirements. + * + * Specialisations shall meet the following requirements, where @c t is a const + * reference to an object of type @c T, and @c s is an object of type @c + * CancellationSlot. + * + * @li Provide a nested typedef @c type that identifies a type meeting the + * CancellationSlot requirements. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t) and with return type @c type or a (possibly const) reference to @c + * type. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t,s) and with return type @c type or a (possibly const) reference to @c + * type. + */ +template +struct associated_cancellation_slot +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_cancellation_slot_impl +#endif // !defined(GENERATING_DOCUMENTATION) +{ +#if defined(GENERATING_DOCUMENTATION) + /// If @c T has a nested type @c cancellation_slot_type, + /// T::cancellation_slot_type. Otherwise + /// @c CancellationSlot. + typedef see_below type; + + /// If @c T has a nested type @c cancellation_slot_type, returns + /// t.get_cancellation_slot(). Otherwise returns @c type(). + static decltype(auto) get(const T& t) noexcept; + + /// If @c T has a nested type @c cancellation_slot_type, returns + /// t.get_cancellation_slot(). Otherwise returns @c s. + static decltype(auto) get(const T& t, + const CancellationSlot& s) noexcept; +#endif // defined(GENERATING_DOCUMENTATION) +}; + +/// Helper function to obtain an object's associated cancellation_slot. +/** + * @returns associated_cancellation_slot::get(t) + */ +template +ASIO_NODISCARD inline typename associated_cancellation_slot::type +get_associated_cancellation_slot(const T& t) noexcept +{ + return associated_cancellation_slot::get(t); +} + +/// Helper function to obtain an object's associated cancellation_slot. +/** + * @returns associated_cancellation_slot::get(t, st) + */ +template +ASIO_NODISCARD inline auto get_associated_cancellation_slot( + const T& t, const CancellationSlot& st) noexcept + -> decltype(associated_cancellation_slot::get(t, st)) +{ + return associated_cancellation_slot::get(t, st); +} + +template +using associated_cancellation_slot_t = + typename associated_cancellation_slot::type; + +namespace detail { + +template +struct associated_cancellation_slot_forwarding_base +{ +}; + +template +struct associated_cancellation_slot_forwarding_base::asio_associated_cancellation_slot_is_unspecialised, + void + >::value + >> +{ + typedef void asio_associated_cancellation_slot_is_unspecialised; +}; + +} // namespace detail + +/// Specialisation of associated_cancellation_slot for @c +/// std::reference_wrapper. +template +struct associated_cancellation_slot, CancellationSlot> +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_cancellation_slot_forwarding_base +#endif // !defined(GENERATING_DOCUMENTATION) +{ + /// Forwards @c type to the associator specialisation for the unwrapped type + /// @c T. + typedef typename associated_cancellation_slot::type type; + + /// Forwards the request to get the cancellation slot to the associator + /// specialisation for the unwrapped type @c T. + static type get(reference_wrapper t) noexcept + { + return associated_cancellation_slot::get(t.get()); + } + + /// Forwards the request to get the cancellation slot to the associator + /// specialisation for the unwrapped type @c T. + static auto get(reference_wrapper t, const CancellationSlot& s) noexcept + -> decltype( + associated_cancellation_slot::get(t.get(), s)) + { + return associated_cancellation_slot::get(t.get(), s); + } +}; + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#endif // ASIO_ASSOCIATED_CANCELLATION_SLOT_HPP diff --git a/Packages/asio-1.36.0/include/asio/associated_executor.hpp b/Packages/asio-1.36.0/include/asio/associated_executor.hpp new file mode 100644 index 0000000..5e0746f --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/associated_executor.hpp @@ -0,0 +1,235 @@ +// +// associated_executor.hpp +// ~~~~~~~~~~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ASSOCIATED_EXECUTOR_HPP +#define ASIO_ASSOCIATED_EXECUTOR_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#include "asio/associator.hpp" +#include "asio/detail/functional.hpp" +#include "asio/detail/type_traits.hpp" +#include "asio/execution/executor.hpp" +#include "asio/is_executor.hpp" +#include "asio/system_executor.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { + +template +struct associated_executor; + +namespace detail { + +template +struct has_executor_type : false_type +{ +}; + +template +struct has_executor_type> + : true_type +{ +}; + +template +struct associated_executor_impl +{ + typedef void asio_associated_executor_is_unspecialised; + + typedef E type; + + static type get(const T&) noexcept + { + return type(); + } + + static const type& get(const T&, const E& e) noexcept + { + return e; + } +}; + +template +struct associated_executor_impl> +{ + typedef typename T::executor_type type; + + static auto get(const T& t) noexcept + -> decltype(t.get_executor()) + { + return t.get_executor(); + } + + static auto get(const T& t, const E&) noexcept + -> decltype(t.get_executor()) + { + return t.get_executor(); + } +}; + +template +struct associated_executor_impl::value + >, + void_t< + typename associator::type + >> : associator +{ +}; + +} // namespace detail + +/// Traits type used to obtain the executor associated with an object. +/** + * A program may specialise this traits type if the @c T template parameter in + * the specialisation is a user-defined type. The template parameter @c + * Executor shall be a type meeting the Executor requirements. + * + * Specialisations shall meet the following requirements, where @c t is a const + * reference to an object of type @c T, and @c e is an object of type @c + * Executor. + * + * @li Provide a nested typedef @c type that identifies a type meeting the + * Executor requirements. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t) and with return type @c type or a (possibly const) reference to @c + * type. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t,e) and with return type @c type or a (possibly const) reference to @c + * type. + */ +template +struct associated_executor +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_executor_impl +#endif // !defined(GENERATING_DOCUMENTATION) +{ +#if defined(GENERATING_DOCUMENTATION) + /// If @c T has a nested type @c executor_type, T::executor_type. + /// Otherwise @c Executor. + typedef see_below type; + + /// If @c T has a nested type @c executor_type, returns + /// t.get_executor(). Otherwise returns @c type(). + static decltype(auto) get(const T& t) noexcept; + + /// If @c T has a nested type @c executor_type, returns + /// t.get_executor(). Otherwise returns @c ex. + static decltype(auto) get(const T& t, const Executor& ex) noexcept; +#endif // defined(GENERATING_DOCUMENTATION) +}; + +/// Helper function to obtain an object's associated executor. +/** + * @returns associated_executor::get(t) + */ +template +ASIO_NODISCARD inline typename associated_executor::type +get_associated_executor(const T& t) noexcept +{ + return associated_executor::get(t); +} + +/// Helper function to obtain an object's associated executor. +/** + * @returns associated_executor::get(t, ex) + */ +template +ASIO_NODISCARD inline auto get_associated_executor( + const T& t, const Executor& ex, + constraint_t< + is_executor::value || execution::is_executor::value + > = 0) noexcept + -> decltype(associated_executor::get(t, ex)) +{ + return associated_executor::get(t, ex); +} + +/// Helper function to obtain an object's associated executor. +/** + * @returns associated_executor::get(t, ctx.get_executor()) + */ +template +ASIO_NODISCARD inline typename associated_executor::type +get_associated_executor(const T& t, ExecutionContext& ctx, + constraint_t::value> = 0) noexcept +{ + return associated_executor::get(t, ctx.get_executor()); +} + +template +using associated_executor_t = typename associated_executor::type; + +namespace detail { + +template +struct associated_executor_forwarding_base +{ +}; + +template +struct associated_executor_forwarding_base::asio_associated_executor_is_unspecialised, + void + >::value + >> +{ + typedef void asio_associated_executor_is_unspecialised; +}; + +} // namespace detail + +/// Specialisation of associated_executor for @c std::reference_wrapper. +template +struct associated_executor, Executor> +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_executor_forwarding_base +#endif // !defined(GENERATING_DOCUMENTATION) +{ + /// Forwards @c type to the associator specialisation for the unwrapped type + /// @c T. + typedef typename associated_executor::type type; + + /// Forwards the request to get the executor to the associator specialisation + /// for the unwrapped type @c T. + static type get(reference_wrapper t) noexcept + { + return associated_executor::get(t.get()); + } + + /// Forwards the request to get the executor to the associator specialisation + /// for the unwrapped type @c T. + static auto get(reference_wrapper t, const Executor& ex) noexcept + -> decltype(associated_executor::get(t.get(), ex)) + { + return associated_executor::get(t.get(), ex); + } +}; + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#endif // ASIO_ASSOCIATED_EXECUTOR_HPP diff --git a/Packages/asio-1.36.0/include/asio/associated_immediate_executor.hpp b/Packages/asio-1.36.0/include/asio/associated_immediate_executor.hpp new file mode 100644 index 0000000..9b1e0c6 --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/associated_immediate_executor.hpp @@ -0,0 +1,281 @@ +// +// associated_immediate_executor.hpp +// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ASSOCIATED_IMMEDIATE_EXECUTOR_HPP +#define ASIO_ASSOCIATED_IMMEDIATE_EXECUTOR_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" +#include "asio/associator.hpp" +#include "asio/detail/functional.hpp" +#include "asio/detail/type_traits.hpp" +#include "asio/execution/blocking.hpp" +#include "asio/execution/executor.hpp" +#include "asio/execution_context.hpp" +#include "asio/is_executor.hpp" +#include "asio/require.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { + +template +struct associated_immediate_executor; + +namespace detail { + +template +struct has_immediate_executor_type : false_type +{ +}; + +template +struct has_immediate_executor_type> + : true_type +{ +}; + +template +struct default_immediate_executor +{ + typedef decay_t> type; + + static auto get(const E& e) noexcept + -> decltype(asio::require(e, execution::blocking.never)) + { + return asio::require(e, execution::blocking.never); + } +}; + +template +struct default_immediate_executor::value + >, + enable_if_t< + is_executor::value + >> +{ + class type : public E + { + public: + template + explicit type(const Executor1& e, + constraint_t< + conditional_t< + !is_same::value, + is_convertible, + false_type + >::value + > = 0) noexcept + : E(e) + { + } + + type(const type& other) noexcept + : E(static_cast(other)) + { + } + + type(type&& other) noexcept + : E(static_cast(other)) + { + } + + template + void dispatch(Function&& f, const Allocator& a) const + { + this->post(static_cast(f), a); + } + + friend bool operator==(const type& a, const type& b) noexcept + { + return static_cast(a) == static_cast(b); + } + + friend bool operator!=(const type& a, const type& b) noexcept + { + return static_cast(a) != static_cast(b); + } + }; + + static type get(const E& e) noexcept + { + return type(e); + } +}; + +template +struct associated_immediate_executor_impl +{ + typedef void asio_associated_immediate_executor_is_unspecialised; + + typedef typename default_immediate_executor::type type; + + static auto get(const T&, const E& e) noexcept + -> decltype(default_immediate_executor::get(e)) + { + return default_immediate_executor::get(e); + } +}; + +template +struct associated_immediate_executor_impl> +{ + typedef typename T::immediate_executor_type type; + + static auto get(const T& t, const E&) noexcept + -> decltype(t.get_immediate_executor()) + { + return t.get_immediate_executor(); + } +}; + +template +struct associated_immediate_executor_impl::value + >, + void_t< + typename associator::type + >> : associator +{ +}; + +} // namespace detail + +/// Traits type used to obtain the immediate executor associated with an object. +/** + * A program may specialise this traits type if the @c T template parameter in + * the specialisation is a user-defined type. The template parameter @c + * Executor shall be a type meeting the Executor requirements. + * + * Specialisations shall meet the following requirements, where @c t is a const + * reference to an object of type @c T, and @c e is an object of type @c + * Executor. + * + * @li Provide a nested typedef @c type that identifies a type meeting the + * Executor requirements. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t) and with return type @c type or a (possibly const) reference to @c + * type. + * + * @li Provide a noexcept static member function named @c get, callable as @c + * get(t,e) and with return type @c type or a (possibly const) reference to @c + * type. + */ +template +struct associated_immediate_executor +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_immediate_executor_impl +#endif // !defined(GENERATING_DOCUMENTATION) +{ +#if defined(GENERATING_DOCUMENTATION) + /// If @c T has a nested type @c immediate_executor_type, + // T::immediate_executor_type. Otherwise @c Executor. + typedef see_below type; + + /// If @c T has a nested type @c immediate_executor_type, returns + /// t.get_immediate_executor(). Otherwise returns + /// asio::require(ex, asio::execution::blocking.never). + static decltype(auto) get(const T& t, const Executor& ex) noexcept; +#endif // defined(GENERATING_DOCUMENTATION) +}; + +/// Helper function to obtain an object's associated executor. +/** + * @returns associated_immediate_executor::get(t, ex) + */ +template +ASIO_NODISCARD inline auto get_associated_immediate_executor( + const T& t, const Executor& ex, + constraint_t< + is_executor::value || execution::is_executor::value + > = 0) noexcept + -> decltype(associated_immediate_executor::get(t, ex)) +{ + return associated_immediate_executor::get(t, ex); +} + +/// Helper function to obtain an object's associated executor. +/** + * @returns associated_immediate_executor::get(t, ctx.get_executor()) + */ +template +ASIO_NODISCARD inline typename associated_immediate_executor::type +get_associated_immediate_executor(const T& t, ExecutionContext& ctx, + constraint_t< + is_convertible::value + > = 0) noexcept +{ + return associated_immediate_executor::get(t, ctx.get_executor()); +} + +template +using associated_immediate_executor_t = + typename associated_immediate_executor::type; + +namespace detail { + +template +struct associated_immediate_executor_forwarding_base +{ +}; + +template +struct associated_immediate_executor_forwarding_base::asio_associated_immediate_executor_is_unspecialised, + void + >::value + >> +{ + typedef void asio_associated_immediate_executor_is_unspecialised; +}; + +} // namespace detail + +/// Specialisation of associated_immediate_executor for +/// @c std::reference_wrapper. +template +struct associated_immediate_executor, Executor> +#if !defined(GENERATING_DOCUMENTATION) + : detail::associated_immediate_executor_forwarding_base +#endif // !defined(GENERATING_DOCUMENTATION) +{ + /// Forwards @c type to the associator specialisation for the unwrapped type + /// @c T. + typedef typename associated_immediate_executor::type type; + + /// Forwards the request to get the executor to the associator specialisation + /// for the unwrapped type @c T. + static auto get(reference_wrapper t, const Executor& ex) noexcept + -> decltype(associated_immediate_executor::get(t.get(), ex)) + { + return associated_immediate_executor::get(t.get(), ex); + } +}; + +} // namespace asio + +#include "asio/detail/pop_options.hpp" + +#endif // ASIO_ASSOCIATED_IMMEDIATE_EXECUTOR_HPP diff --git a/Packages/asio-1.36.0/include/asio/associator.hpp b/Packages/asio-1.36.0/include/asio/associator.hpp new file mode 100644 index 0000000..5c4f382 --- /dev/null +++ b/Packages/asio-1.36.0/include/asio/associator.hpp @@ -0,0 +1,35 @@ +// +// associator.hpp +// ~~~~~~~~~~~~~~ +// +// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#ifndef ASIO_ASSOCIATOR_HPP +#define ASIO_ASSOCIATOR_HPP + +#if defined(_MSC_VER) && (_MSC_VER >= 1200) +# pragma once +#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) + +#include "asio/detail/config.hpp" + +#include "asio/detail/push_options.hpp" + +namespace asio { + +/// Used to generically specialise associators for a type. +template